prometheus / prometheus/docs

Naming conventions: Refine the recommendations.

Open
#2,469 3 comments 0 reactions 1 assignee View on GitHub

@Gopi-eng2202 is already working on this.

Since Nov 14, 2024.

help-wanted kind/enhancement
Dominant language
TypeScript
Stars
717
Forks
1.2k
Avg merge
3d 15h
Merged PRs (30d)
19

Description

https://github.com/prometheus/prometheus/issues/8718 discusses "misnamed" metrics and comes to the conclusion that their names are actually fine and we should improve the recommendations for naming metrics to match the actually existing "fine" metric names.

So the task here is to turn the discussion in https://github.com/prometheus/prometheus/issues/8718 into changes of the metric naming best practices page.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.