Skip to content

Commit

Permalink
Update monitoring metrics docs
Browse files Browse the repository at this point in the history
- Fix the deprecation link.
- Add new HelmRelease labels.
- Update HelmRelease version in custom metrics code snippet.

Signed-off-by: Sunny <github@darkowlzz.space>
(cherry picked from commit 5c8982c)
  • Loading branch information
darkowlzz authored and github-actions[bot] committed May 13, 2024
1 parent 7865448 commit e1673da
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion content/en/flux/monitoring/custom-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ customResourceState:
resources:
- groupVersionKind:
group: helm.toolkit.fluxcd.io
version: "v2beta2"
version: "v2"
kind: HelmRelease
metricNamePrefix: gotk
metrics:
Expand Down
28 changes: 14 additions & 14 deletions content/en/flux/monitoring/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 2

{{% alert color="info" title="Metrics Deprecation" %}}
Some of the Flux controller metrics prior to v2.1.0 have been deprecated. Please
see the [Deprecated Resource Metrics](#-deprecated-resource-metrics)
see the [Deprecated Resource Metrics](#warning-deprecated-resource-metrics)
section below to learn more about it.
{{< /alert >}}

Expand Down Expand Up @@ -106,19 +106,19 @@ kinds of resources. In addition, there are a few resource kind specific labels.
See the following table for a list of labels associated with specific resource
kind.

| Resource Kind | Labels |
| --- | --- |
| Kustomization | `revision`, `source_name` |
| HelmRelease | `revision`, `chart_name`, `chart_source_name` |
| GitRepository | `revision`, `url` |
| Bucket | `revision`, `endpoint`, `bucket_name` |
| HelmRepository | `revision`, `url` |
| HelmChart | `revision`, `chart_name`, `chart_version` |
| OCIRepository | `revision`, `url` |
| Receiver | `webhook_path` |
| ImageRepository | `image` |
| ImagePolicy | `source_name` |
| ImageUpdateAutomation | `source_name` |
| Resource Kind | Labels |
| --- | --- |
| Kustomization | `revision`, `source_name` |
| HelmRelease | `revision`, `chart_name`, `chart_app_version`, `chart_source_name`, `chart_ref_name` |
| GitRepository | `revision`, `url` |
| Bucket | `revision`, `endpoint`, `bucket_name` |
| HelmRepository | `revision`, `url` |
| HelmChart | `revision`, `chart_name`, `chart_version` |
| OCIRepository | `revision`, `url` |
| Receiver | `webhook_path` |
| ImageRepository | `image` |
| ImagePolicy | `source_name` |
| ImageUpdateAutomation | `source_name` |

{{< note >}}
The above metric may have extra labels after being collected in Prometheus. This
Expand Down

0 comments on commit e1673da

Please sign in to comment.