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.

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: Update labels, add cardinality topic #15399

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

JStickler
Copy link
Contributor

What this PR does / why we need it:

Reorganizes and revises the Labels topic to take into account:

  • New default service_name label
  • Label defaults for OTEL
  • Provides additional guidance to help customers avoid known issues with labels

Adds a new topic for cardinality.

@JStickler JStickler added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Dec 12, 2024
@JStickler JStickler requested a review from a team as a code owner December 12, 2024 18:06
@Jayclifford345
Copy link
Contributor

Really great write up on labels and cardinality. These are just a few points I noticed but they are only suggestions :)

@JStickler JStickler force-pushed the 2024.12.12_labels_cardinality branch from 6f40023 to 307ad6d Compare December 16, 2024 14:53
Copy link
Contributor

github-actions bot commented Dec 16, 2024

docs/sources/get-started/labels/_index.md Outdated Show resolved Hide resolved

{{< admonition type="note" >}}
[Structured metadata](https://grafana.com/docs/loki/<LOKI_VERSION>/get-started/labels/structured-metadata/) is a feature in Loki and Cloud Logs that allows customers to store metadata that is too high cardinality for log lines, without needing to embed that information in log lines themselves.
It is a great home for metadata which is not easily embeddable in a log line, but is too high cardinality to be used effectively as a label.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should it mention bloom filters here as well? The whole point of putting high cardinality fields into structured metadata is that you can filter them relatively efficiently using blooms.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. What do you suggest for wording?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/L type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants