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

Documenting example labels #8

Open
lambdanis opened this issue Mar 8, 2024 · 0 comments
Open

Documenting example labels #8

lambdanis opened this issue Mar 8, 2024 · 0 comments

Comments

@lambdanis
Copy link
Collaborator

lambdanis commented Mar 8, 2024

metricsmd tool iterates over a Prometheus metrics registry and documents all metrics with their label values. This works well if all possible label values are known beforehand.

However, observability tools like Tetragon expose metrics with labels depending on the environment, e.g. Kubernetes namespace. Such metrics can't be initialized with all possible label values.

How Tetragon deals with it is by initializing metrics for docs with example label values. See for example here. This works, however, the generated docs don't distinguish between the real label values and the example ones. While in most cases it's pretty obvious which values are examples, it would be nice if metricsmd supported rendering them differently.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant