prometheus / prometheus/docs

Exposition format: Clearly specify the case of empty MetricFamilies

Open
#544 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

There is unclarity about the handling of empty MetricFamilies. See https://github.com/prometheus/common/issues/50 for discussion.

This issue is about the decision if it should be allowed or not, and then about the documentation of the behavior.

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 by reading the discussion in prometheus/common#50, then determine whether empty MetricFamilies should be allowed. Once that behavior is decided, identify the relevant documentation location and update it so the handling is explicit and unambiguous.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.