Skip to content

Commit a62cd81

Browse files
author
Sunil Thaha
authored
Merge pull request #2212 from vprashar2929/docs-terminate
docs: add disable and unlimited tracking for maxTerminated
2 parents 8d49c9c + e6e1ba4 commit a62cd81

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/configuration/configuration.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ You can configure Kepler by passing flags when starting the service. The followi
2323
| `--host.sysfs` | Path to sysfs filesystem | `/sys` | Any valid directory path |
2424
| `--host.procfs` | Path to procfs filesystem | `/proc` | Any valid directory path |
2525
| `--monitor.interval` | Monitor refresh interval | `5s` | Any valid duration |
26-
| `--monitor.max-terminated` | Maximum number of terminated workloads to keep in memory until exported | `500` | Any non-negative integer (0 for unlimited) |
26+
| `--monitor.max-terminated` | Maximum number of terminated workloads to keep in memory until exported | `500` | Negative number indicates `unlimited` and `0` disables the feature |
2727
| `--web.config-file` | Path to TLS server config file | `""` | Any valid file path |
2828
| `--web.listen-address` | Web server listen addresses (can be specified multiple times) | `:28282` | Any valid host:port or :port format |
2929
| `--debug.pprof` | Enable pprof debugging endpoints | `false` | `true`, `false` |
@@ -64,8 +64,11 @@ kepler --metrics=process
6464
# Set maximum terminated workloads to 1000
6565
kepler --monitor.max-terminated=1000
6666

67-
# Disable terminated workload tracking (unlimited)
67+
# Disable terminated workload tracking
6868
kepler --monitor.max-terminated=0
69+
70+
# Unlimited terminated workload tracking
71+
kepler --monitor.max-terminated=-1
6972
```
7073

7174
## 🗂️ Configuration File
@@ -162,7 +165,7 @@ monitor:
162165

163166
- **staleness**: Duration after which data computed by the monitor is considered stale and recomputed when requested again. Especially useful when multiple Prometheus instances are scraping Kepler, ensuring they receive the same data within the staleness window. Should be shorter than the monitor interval.
164167

165-
- **maxTerminated**: Maximum number of terminated workloads (processes, containers, VMs, pods) to keep in memory until the data is exported. This prevents unbounded memory growth in high-churn environments. Set to 0 for unlimited (no limit). When the limit is reached, the least power consuming terminated workloads are removed first.
168+
- **maxTerminated**: Maximum number of terminated workloads (processes, containers, VMs, pods) to keep in memory until the data is exported. This prevents unbounded memory growth in high-churn environments. Set 0 to disable. When the limit is reached, the least power consuming terminated workloads are removed first.
166169

167170
- **minTerminatedEnergyThreshold**: Minimum energy consumption threshold (in joules) for terminated workloads to be tracked. Only terminated workloads with energy consumption above this threshold will be included in the tracking. This helps filter out short-lived processes that consume minimal energy. Default is 10 joules.
168171

0 commit comments

Comments
 (0)