Skip to main content

Jobs

Daikoku includes several background jobs designed to ensure data consistency and the smooth operation of the platform. These tasks run automatically at regular intervals and can be partially customized through configuration. Key jobs include:

  • Synchronization with Otoroshi, to keep API data and usage statistics up to date.

  • Audit trail cleanup, to automatically purge old audit logs and limit storage usage.

  • Notification purge, to remove obsolete or unhandled notifications.

  • Anonymous reporting, which periodically sends anonymized usage statistics to help us improve the tool.

These jobs play a critical role in maintaining Daikoku’s stability, performance, and data hygiene over time.

Otoroshi Synchronizer Job​

This job reconciles Daikoku with Otoroshi. For each keyring it recomputes the shared Otoroshi API key from its still-active subscriptions only — a subscription takes part when it is enabled and not blocked (enabled && blockedBy empty). This is how API lifecycle changes take effect on real keys: when a producer blocks an API (or an individual subscription), the corresponding subscriptions are flagged as blocked and the synchronizer disables their contribution to the shared key; unblocking restores it. A keyring whose members are all blocked ends up disabled rather than deleted, so the change can be rolled back.

Notifications Purge Job​

The NotificationsPurgeJob is an automated job responsible for periodically deleting obsolete notifications in the Daikoku system. It helps maintain database cleanliness by removing old notifications based on specific criteria.

Job startup​

The job starts automatically when the application launches if the daikoku.notificationsPurgeJob.enabled configuration is equal to true. It runs periodically according to the interval configured in daikoku.notificationsPurgeJob.interval or the cron expression configured in daikoku.notificationsPurgeJob.cronExpression.

Job lifecycle​

The job runs continuously until the application is shut down. It cannot be stopped individually - it only stops when the entire application terminates. It can be run occasionally by calling /api/jobs/notifications-purge/_sync with the dedicated key in params.

Purge criteria​

The job deletes notifications based on three main criteria:

1. Pending "AcceptOnly" notifications​

  • Type: NotificationType.AcceptOnly
  • Status: Pending
  • Condition: Older than daikoku.notifications.purge.max.base.date

These notifications typically correspond to requests that only require acceptance (like basic information) and have been pending for too long.

2. Accepted notifications​

  • Status: Accepted
  • Condition: Acceptance date older than daikoku.notifications.purge.max.base.date

Once accepted, the notifications can be deleted after a retention period to free up storage space.

3. Pending "AcceptOrReject" notifications​

  • Type: NotificationType.AcceptOrReject
  • Status: Pending
  • Condition: Older than daikoku.notifications.purge.max.to.treat.date

These notifications require an action (accept or reject) and may have a longer retention period.

Configuration​

The job uses several configuration parameters:

ParameterEnvironment variableDescriptionDefault Value
daikoku.notificationsPurgeJob.keyDAIKOKU_NOTIFICATIONS_PURGE_JOB_KEYthe key to run job by API callsecret
daikoku.notificationsPurgeJob.enabledDAIKOKU_NOTIFICATIONS_PURGE_JOB_ENABLEDEnables/disables automatic job executionfalse
daikoku.notificationsPurgeJob.modeDAIKOKU_NOTIFICATIONS_PURGE_JOB_MODEThe job execution mode (interval or cron)interval
daikoku.notificationsPurgeJob.cronExpressionDAIKOKU_NOTIFICATIONS_PURGE_JOB_CRON_EXPRESSIONThe cron expression used for job execution--
daikoku.notificationsPurgeJob.intervalDAIKOKU_NOTIFICATIONS_PURGE_JOB_INTERVALInterval between each job execution1hour
daikoku.notificationsPurgeJob.max.base.dateDAIKOKU_NOTIFICATIONS_PURGE_JOB_MAX_DATERetention period for basic notifications30days
daikoku.notificationsPurgeJob.max.to.treat.dateDAIKOKU_NOTIFICATIONS_PURGE_JOB_MAX_TO_TREAT_DATERetention period for notifications requiring treatment180days

Audit Trail Purge Job​

like notifications, audit trails can feed your database a little bit too much. To avoid a memory issue, you can enable a job to clean old audit events.

Job startup​

The job starts automatically when the application launches if the daikoku.auditTrailPurgeJob.enabled configuration is equal to true. It runs periodically according to the interval configured in daikoku.auditTrailPurgeJob.interval or the cron expression configured in daikoku.auditTrailPurgeJob.cronExpression.

Job lifecycle​

The job runs continuously until the application is shut down. It cannot be stopped individually - it only stops when the entire application terminates. It can be run occasionally by calling /api/jobs/audit-trail-purge/_sync with the dedicated key in params.

Configuration​

The job uses several configuration parameters:

ParameterEnvironment variableDescriptionDefault Value
daikoku.auditTrailPurgeJob.keyDAIKOKU_AUDIT_TRAIL_PURGE_JOB_KEYthe key to run job by API callsecret
daikoku.auditTrailPurgeJob.enabledDAIKOKU_AUDIT_TRAIL_PURGE_JOB_ENABLEDEnables/disables automatic job executionfalse
daikoku.auditTrailPurgeJob.modeDAIKOKU_AUDIT_TRAIL_PURGE_JOB_MODEThe job execution mode (interval or cron)interval
daikoku.auditTrailPurgeJob.cronExpressionDAIKOKU_AUDIT_TRAIL_PURGE_JOB_CRON_EXPRESSIONThe cron expression used for job execution--
daikoku.auditTrailPurgeJob.intervalDAIKOKU_AUDIT_TRAIL_PURGE_JOB_INTERVALInterval between each job execution1hour
daikoku.auditTrailPurgeJob.purge.max.base.dateDAIKOKU_AUDIT_TRAIL_PURGE_JOB_MAX_DATERetention period for events60days