Skip to content

Add Guidance wrt Labelling to Naming and Rules Best Practices #2691

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

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

Conversation

conallob
Copy link

Add Guidance wrt Labelling to Naming and Rules Best Practices to docs/practices/naming.md and docs/practices/rules.md, specifically:

  • The primary purposes of job and instance
  • Include WARNINGS about accidentally stripping the job label, especially in multi-tenant systems

This Fixes #2690

conallob added 2 commits July 15, 2025 13:39
Signed-off-by: Conall O'Brien <conall@conall.net>
Signed-off-by: Conall O'Brien <conall@conall.net>
@conallob
Copy link
Author

Friendly ping @SuperQ @beorn7 ?

@conallob
Copy link
Author

conallob commented Jul 28, 2025

Obligatory post-it note reminder: https://photos.app.goo.gl/Bkfir4wRiLtNVG4W8

@beorn7 beorn7 requested review from juliusv and SuperQ July 29, 2025 10:48
@beorn7
Copy link
Member

beorn7 commented Jul 29, 2025

With my current patchy availability, there is little chance I get to this anytime soon. Maybe @juliusv has a qualified opinion here?

@conallob
Copy link
Author

conallob commented Aug 3, 2025

Friendly ping @SuperQ @juliusv

@andrechalella
Copy link

Hey @conallob, congrats for the nice PR!

Just one thing: maybe you could fix the eaach typo in

  • The job label is a primary key to differentiate metrics from eaach other.

There is a small confusion I would love to see fixed, in a paragraph just below one of your edits. It is:

To keep the operations clean, _sum is omitted if there are other operations,
as sum().

I don't understand the as sum() part. Like, "x is omitted if there are other operations such as x"? It doesn't make sense to me, in a very basic way. I know it's out of the scope of this PR, but maybe you could touch it to clarify.

Signed-off-by: Conall O'Brien <conall@conall.net>
@conallob
Copy link
Author

Hey @conallob, congrats for the nice PR!

Just one thing: maybe you could fix the eaach typo in

  • The job label is a primary key to differentiate metrics from eaach other.

There is a small confusion I would love to see fixed, in a paragraph just below one of your edits. It is:

Fixed the typo.

To keep the operations clean, _sum is omitted if there are other operations,
as sum().

I don't understand the as sum() part. Like, "x is omitted if there are other operations such as x"? It doesn't make sense to me, in a very basic way. I know it's out of the scope of this PR, but maybe you could touch it to clarify.

I'm afraid that best practice is unrelated.

It also makes sense as written, once you've written enough rules. It's weighing up the trade-off between tracking the chain of operations across a pipeline of rules vs the rule name growing unwieldy. Many of these best practices trace back to specific philosophies from Prometheus' predecessor.

If you still think it needs a polish, please a separate doc bug.

@conallob
Copy link
Author

Ping @juliusv , since @SuperQ is currently unavailable for life reasons

Co-authored-by: Ben Kochie <superq@gmail.com>
Signed-off-by: Conall O'Brien <conall@conall.net>
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.

Best Practice Docs Don't Call Out the Importance of Job Label
4 participants