prometheus / prometheus/docs

Need clarification of docs/instrumenting/exposition_formats.md, is it missing information?

Open
#1,779 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
717
Forks
1.2k
Avg merge
3d 15h
Merged PRs (30d)
19

Description

# HELP foo_total  
# TYPE foo_total counter
foo_total{hostname="localhost",optionalExtraMetadata="my-cool-value",} 1.0
# HELP foo_total  
# TYPE foo_total counter
foo_total{hostname="localhost",} 1.0

☝️ is this valid as of v0.4.0? I wrote an integration test that proves it is, but there is some debate on whether that's to spec or not.

Reading through https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md

I am not seeing any reference to

A given metric name MAY NOT repeat if the cardinality of the label-value pairs between its instances varies.

From this section

image

of the legacy Client Data Exposition Format document.

Does this mean as of the current spec you can have the same metric more than once with varying labels?

Would be nice to add this info to the current doc.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/instrumenting/exposition_formats.md, then compare its wording with the linked legacy Client Data Exposition Format document and review the linked integration test. Confirm whether repeated metric names with varying label sets are valid in the current specification; done means documenting the clarified rule in the current exposition-format documentation if warranted.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.