`<relabel_config>` -> <relabel_action> description not comlete for `drop` and `keep`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 717
- Forks
- 1.2k
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 19
Description
From https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config:
keep: Drop targets for which regex does not match the concatenated source_labels.
drop: Drop targets for which regex matches the concatenated source_labels.
This incorrectly says that drop/keep is only to drop targets, when it is also to drop/keep metrics when used with <metric_relabel_configs>
This is slightly related to https://github.com/prometheus/docs/issues/341, but https://github.com/prometheus/docs/issues/341 says that relabel_config is accurate which is not true.
Contributor guide
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 with the relabel_config section at the linked Prometheus configuration documentation page and compare the keep and drop descriptions with metric_relabel_configs. Update the wording so it covers both targets and metrics, then verify that the descriptions no longer imply they apply only to targets.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100