Skip to content

Commit

Permalink
chore(docs): add information about new opt-in metric
Browse files Browse the repository at this point in the history
  • Loading branch information
alexanderldavis committed Jun 14, 2024
1 parent 3f6e98a commit 6eeba71
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/Verify-Reloader-Working.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,16 @@ When Reloader is unable to reload, `reloader_reload_executed_total{success="fals
reloader_reload_executed_total{success="false"} 15
reloader_reload_executed_total{success="true"} 12
```

### Opt-in Granular Metrics

Reloader can also export a metric to show the number of reloads by namespace. This feature is disabled by default, as it can lead to high cardinality in clusters with many namespaces.

The metric will have both `success` and `namespace` as attributes:

```text
reloader_reload_executed_total{success="false", namespace="some-namespace"} 2
reloader_reload_executed_total{success="true", namespace="some-namespace"} 1
```

To opt-in, set the environment variable `METRICS_COUNT_BY_NAMESPACE` to `enabled` or set the Helm value `reloader.enableMetricsByNamespace` to `true`.

0 comments on commit 6eeba71

Please sign in to comment.