Document the stats(lifetime) global option

axoflow · Jun 18, 2024 · 8b20348 · 8b20348
1 parent 8047632
commit 8b20348
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/content/chapter-global-options/reference-options/_index.md b/content/chapter-global-options/reference-options/_index.md
@@ -489,6 +489,15 @@ options {
 
 Note that level 2 and 3 increase the memory requirements and CPU load. For details on message statistics, see {{% xref "/chapter-log-statistics/_index.md" %}}.
 
+### lifetime() {#global-option-stats-lifetime}
+
+|                  |         |
+| ---------------- | ------- |
+| Accepted values: | number (seconds)  |
+| Default:         | `N/A` |
+
+*Description:* Dynamic counters in metrics are pruned after `lifetime` expires. Note that orphaned counters are not pruned (you can prune them by running `syslog-ng-ctl stats --remove-orphans`).
+
 ### max-dynamics() {#global-option-stats-max-dynamics}
 
 |                  |         |