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: document Prometheus tag/label parsing behaviour #1151

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

Conversation

clample
Copy link
Contributor

@clample clample commented Dec 11, 2024

Affected Components

  • Content & Marketing
  • Pricing
  • Test
  • Docs
  • Learn
  • Other

Pre-Requisites

  • Code is linted (npm run lint)

Notes for the Reviewer

Please see for more context https://github.com/checkly/checkly-backend/pull/5911

Prometheus label keys should only contain a limited set of characters (docs):

Labels may contain ASCII letters, numbers, as well as underscores. They must match the regex [a-zA-Z_][a-zA-Z0-9_]*.

This PR encourages users to only use valid characters in the label name.

Copy link

vercel bot commented Dec 11, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
checklyhq-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 11, 2024 1:39pm

Copy link
Member

@tnolet tnolet left a comment

Choose a reason for hiding this comment

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

@clample maybe explicitly also link to the prometheus spec? https://prometheus.io/docs/concepts/data_model/

@clample
Copy link
Contributor Author

clample commented Dec 11, 2024

@clample maybe explicitly also link to the prometheus spec? https://prometheus.io/docs/concepts/data_model/

Thanks Tim, I agree. I've updated this to link back to Prometheus.

Copy link
Member

@tnolet tnolet left a comment

Choose a reason for hiding this comment

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

vamos

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

Successfully merging this pull request may close these issues.

2 participants