hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 08:02:15 +03:00
Code Issues Projects Releases Wiki Activity

server/docs: event trigger log cleanup | remove default for clear_older_than

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5998
GitOrigin-RevId: 1376fd2192c7daaf73e8099cdb2f1aab4b8c3cd1
This commit is contained in:
paritosh-08 2022-09-21 22:58:40 +05:30 committed by hasura-bot
parent 8b8d7ab96d
commit 1c7e19c209
4 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/api-reference/metadata-api/event-triggers.mdx
View File

@ -369,7 +369,7 @@ X-Hasura-Role: admin
| event_trigger_name | true | String | Name of the event trigger whose logs needs to be cleaned up |
| source | false | [SourceName](/api-reference/syntax-defs.mdx#sourcename) | Source to which the event trigger belong. Default `default` |
| batch_size | false | Int | Maximum number of event trigger logs to delete. Default 10000 |
| clear_older_than | false | Int | Event logs retention period (in hours). Default 168 hours (or 7 days) |
| clear_older_than | true | Int | Event logs retention period (in hours). |
| timeout | false | Int | Timeout for the cleanup query (in seconds). Default: 60 |
| clean_invocation_logs | false | Boolean | Should corresponding invocation logs be cleaned. Default `false` |

2
docs/docs/api-reference/syntax-defs.mdx
View File

@ -1570,8 +1570,8 @@ Table columns can be referred by prefixing `$` e.g `$id`.
| Key | required | Schema | Description |
|-----------------------|----------|-----------------|-----------------------------------------------------------------------|
| schedule | true | Cron Expression | Cron expression at which the cleanup should be invoked. |
| clear_older_than | true | Integer | Event logs retention period (in hours). 168 hours of retention period means that the logs older than 7 days will be removed. |
| batch_size | false | Integer | Number of event trigger logs to delete. Default 10000 |
| clear_older_than | false | Integer | Event logs retention period (in hours). 168 hours of retention period means that the logs older than 7 days will be removed. Default 168 hours (or 7 days). |
| timeout | false | Integer | Maximum time (in seconds) the cleanup process can take up during execution. If the cleanup process takes up more time, the process will be aborted. Default: 60 |
| clean_invocation_logs | false | Bool | Should corresponding invocation logs be cleaned. Default `false` |
| paused | false | Bool | Is the auto-cleanup process paused. Default `false` |

2
docs/docs/event-triggers/clean-up/auto-cleanup.mdx
View File

@ -28,7 +28,7 @@ Hasura provides a way to automate the cleanup of the event trigger logs based on
| Name of the parameter | Description | Default | Example |
|-----------------------|-----------------------------------------------------------------------------------------------------------|---------|----------------------------------------------------------------------------------------------------------------------|
| clear_older_than | Minimum age (in hours) of the event logs that need to be cleared from when the cleanup action is invoked. | 168 | `clear_older_than: 168` means logs older than 168 hours (7 days) will be deleted. |
| clear_older_than | Minimum age (in hours) of the event logs that need to be cleared from when the cleanup action is invoked. | - | `clear_older_than: 168` means logs older than 168 hours (7 days) will be deleted. |
| schedule | Cron expression at which the cleanup should be invoked. | - | A `0 0 * * *` schedule means that the cleanup will be invoked every day at 00:00 (UTC time). |
| clean_invocation_logs | Option to indicate whether the corresponding invocation logs are also to be cleaned. | false | `clean_invocation_logs: false` means that invocation logs will not be cleaned. |
| batch_size | Maximum number of logs to delete per cleanup action. | 10000 | A `batch_size` of 10000 means that a maximum of 10000 logs will be deleted every time the cleanup action is invoked. |

4
server/src-lib/Hasura/RQL/Types/EventTrigger.hs
View File

@ -245,7 +245,7 @@ instance FromJSON AutoTriggerLogCleanupConfig where
withObject "AutoTriggerLogCleanupConfig" $ \o -> do
_atlccSchedule <- o .: "schedule"
_atlccBatchSize <- o .:? "batch_size" .!= 10000
_atlccClearOlderThan <- o .:? "clear_older_than" .!= 168 -- 7 Days = 168 hours
_atlccClearOlderThan <- o .: "clear_older_than"
_atlccTimeout <- o .:? "timeout" .!= 60
_atlccCleanInvocationLogs <- o .:? "clean_invocation_logs" .!= False
_atlccPaused <- o .:? "paused" .!= ETCSUnpaused
@ -281,7 +281,7 @@ instance FromJSON TriggerLogCleanupConfig where
tlccEventTriggerName <- o .: "event_trigger_name"
tlccSourceName <- o .:? "source" .!= SNDefault
tlccBatchSize <- o .:? "batch_size" .!= 10000
tlccClearOlderThan <- o .:? "clear_older_than" .!= 168 -- 7 Days = 168 hours
tlccClearOlderThan <- o .: "clear_older_than"
tlccTimeout <- o .:? "timeout" .!= 60
tlccCleanInvocationLogs <- o .:? "clean_invocation_logs" .!= False
pure TriggerLogCleanupConfig {..}