prometheus / prometheus/OpenMetrics
UNIT and HELP must not be present
Open
Nobody has claimed this yet.
triage:deciding:needs-info
- Dominant language
- Go
- Stars
- 2.5k
- Forks
- 175
- PR merge metrics
- No merged PRs in 30d
Description
In the spec:
MetricFamily
A MetricFamily MAY have zero or more Metrics. A MetricFamily MUST have a name, HELP, TYPE, and UNIT metadata. Every Metric within a MetricFamily MUST have a unique LabelSet.
The first MUST is not correct.
In ABNF:
metricfamily = *metric-descriptor *metric
metric-descriptor = HASH SP type SP metricname SP metric-type LF
metric-descriptor =/ HASH SP help SP metricname SP escaped-string LF
metric-descriptor =/ HASH SP unit SP metricname SP *metricname-char LF
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the MetricFamily requirement and the metricfamily/metric-descriptor ABNF in the specification. Reconcile the prose with the grammar so the requirement accurately reflects whether HELP and UNIT metadata are optional, then check the surrounding specification for consistent wording.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100