Skip to content

Commit 24a5ef8

Browse files
Update config docs (#191)
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: dependencytrack-bot <106437498+dependencytrack-bot@users.noreply.github.com>
1 parent b57bdc8 commit 24a5ef8

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

docs/reference/configuration/properties.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -779,14 +779,24 @@ Defines the duration in milliseconds for which leadership leases are acquired.
779779

780780
<span id="dtdex-enginemaintenancerun-deletion-batch-size">**`dt.dex-engine.maintenance.run-deletion-batch-size`** [](#dtdex-enginemaintenancerun-deletion-batch-size){ .headerlink }</span>
781781

782-
Defines the maximum number of completed workflow runs to delete during a single execution of the maintenance worker. Deletion of large volumes of runs in one pass can lead to I/O spikes and increased table bloat. <br/><br/> If retention is not able to keep up with the volumes of runs, consider increasing the interval of the maintenance worker first.
782+
Defines the maximum number of completed workflow runs to delete in a single batch. Deletion of large volumes of runs in one pass can lead to I/O spikes and increased table bloat. <br/><br/> Each maintenance cycle executes up to [`dt.dex-engine.maintenance.run-deletion-max-batches-per-cycle`](#dtdex-enginemaintenancerun-deletion-max-batches-per-cycle) batches. <br/><br/> If retention is not able to keep up with the volumes of runs, consider increasing the interval of the maintenance worker, or the number of batches per cycle first.
783783

784784
<table>
785785
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
786786
<tr><th>Default</th><td><code>1000</code></td></tr>
787787
<tr><th>ENV</th><td><code>DT_DEX_ENGINE_MAINTENANCE_RUN_DELETION_BATCH_SIZE</code></td></tr>
788788
</table>
789789

790+
<span id="dtdex-enginemaintenancerun-deletion-max-batches-per-cycle">**`dt.dex-engine.maintenance.run-deletion-max-batches-per-cycle`** [](#dtdex-enginemaintenancerun-deletion-max-batches-per-cycle){ .headerlink }</span>
791+
792+
Defines the maximum number of deletion batches the maintenance worker executes per cycle. <br/><br/> Bounds the WAL burst when draining a large backlog. A backlog exceeding [`dt.dex-engine.maintenance.run-deletion-batch-size`](#dtdex-enginemaintenancerun-deletion-batch-size) * [`dt.dex-engine.maintenance.run-deletion-max-batches-per-cycle`](#dtdex-enginemaintenancerun-deletion-max-batches-per-cycle) is drained across multiple cycles.
793+
794+
<table>
795+
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
796+
<tr><th>Default</th><td><code>100</code></td></tr>
797+
<tr><th>ENV</th><td><code>DT_DEX_ENGINE_MAINTENANCE_RUN_DELETION_MAX_BATCHES_PER_CYCLE</code></td></tr>
798+
</table>
799+
790800
<span id="dtdex-enginemaintenancerun-retention-ms">**`dt.dex-engine.maintenance.run-retention-ms`** [](#dtdex-enginemaintenancerun-retention-ms){ .headerlink }</span>
791801

792802
Defines the duration in milliseconds after which completed workflow runs become eligible for deletion.

0 commit comments

Comments
 (0)