Core Plugins and tasks PurgeAuditLogs
CertifiedPurge audit logs older than a certain date.
Core Plugins and tasks PurgeAuditLogs
Purge audit logs older than a certain date.
This task can be used to save space in the database by purging audit logs older than a certain date.
type: io.kestra.plugin.ee.core.log.PurgeAuditLogsExamples
Purge audit logs older than one month.
id: audit_log_cleanup
namespace: system
tasks:
- id: purge_audit_logs
type: io.kestra.plugin.ee.core.log.PurgeAuditLogs
description: Purge audit logs older than 1 month
endDate: "{{ now() | dateAdd(-1, 'MONTHS') }}"
Purge audit logs related to FLOW & EXECUTION permission created more than one month ago.
id: purgeauditlogs
type: io.kestra.plugin.ee.core.log.PurgeAuditLogs
endDate: "{{ now() | dateAdd(-1, 'MONTHS') }}"
resources:
- FLOW
- EXECUTIONProperties
endDate *string
The maximum date to be purged
All audit logs older than this date will be purged. We recommend using this property rather than startDate as your Audit Log retention policy.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150batchSize integerstring
The number of audit logs deleted per batch
When set, deletion runs in bounded batches instead of a single request. On Elasticsearch this avoids one long-running delete that the server can close (ConnectionClosedException) on very large purges. On JDBC it only takes effect on MySQL (batched with DELETE ... LIMIT); other databases always delete in a single request. When not set, all matching audit logs are deleted in a single request.
namespace string
Namespace for which audit logs should be purged
This property declares a namespace prefix (or namespace of a specific flow if flowId is also provided) to be purged.
resources array
FLOWEXECUTIONTRIGGERNAMESPACEKVSTOREREUSABLE_INPUTSDASHBOARDSECRETCREDENTIALBLUEPRINTAPPAUDITLOGSYSTEM_SETTINGSTENANT_SETTINGSTESTSUITEASSETUSERGROUPROLEBINDINGSERVICE_ACCOUNTINVITATIONCOPILOTMCP_SERVERSUPPORTPOLICYCASEPROMOTION_TARGETAPP_EXECUTIONNAMESPACE_FILETESTSUITE_RUNTENANT_ACCESSSECURITY_INTEGRATIONCASE_TEMPLATEBANNERKILL_SWITCHTENANTVERSIONED_PLUGINWORKER_GROUPWORKER_QUEUEINSTANCEUNKNOWNThe resources to be purged
The resources of audit logs to be purged; by default, the task will purge all audit logs including all resources.
startDate string
The minimum date to be purged
All audit logs created after this date will be purged. Use this option only if you want to purge recently generated logs after a certain date.
types array
READCREATEUPDATEDELETELOGINLOGOUTIMPERSONATELOGIN_FAILUREACCOUNT_LOCKEDPROMOTEUNKNOWNThe type of actions to be purged
Use this option if you want to purge only specific actions like CREATE, READ, UPDATE, or DELETE. By default, the task will purge all types of actions.
Outputs
count integer
0The count of deleted audit logs
