Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Hint about potential high cardinality metrics #5603

Merged
merged 2 commits into from
May 20, 2022
Merged

Docs: Hint about potential high cardinality metrics #5603

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12924e0
Hint about potential high cardinality metrics
m1keil Mar 11, 2022
87b474d
Reword observability.md
m1keil Mar 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/sources/operations/observability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,13 @@ exposed by Promtail at its `/metrics` endpoint. See Promtail's documentation on
An example Grafana dashboard was built by the community and is available as
dashboard [10004](https://grafana.com/dashboards/10004).

## Metrics cardinality

Some of the Loki observability metrics are emitted per tracked file (active), with the file path included in labels.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should mention Promtail here explicitly... "per tracked file" only makes sense in the context of Promtail.

Removed redundancy:

Suggested change
Some of the Loki observability metrics are emitted per tracked file (active), with the file path included in labels.
Some of the Loki metrics are emitted per tracked file (active), with the file path included in labels.

A hint about which metrics are emitted per tracked file would be kind to the operator, so they are able to configure the scraping to avoid this issue.

This increases the quantity of label values across the environment, thereby increasing cardinality. Best practices with Prometheus [labels](https://prometheus.io/docs/practices/naming/#labels) discourage increasing cardinality in this way.
Review your emitted metrics before scraping with Prometheus, and configure the scraping to avoid this issue.


## Mixins

The Loki repository has a [mixin](https://github.com/grafana/loki/blob/master/production/loki-mixin) that includes a
Expand Down