prometheus / prometheus/node_exporter

Complete Documentation of the Metrics

Open
#2,302 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
13.8k
Forks
2.7k
Avg merge
1d 23h
Merged PRs (30d)
8

Description

Would it be possible to document the full metrics that this exporter exposes? What I mean is simply state the metric, what it measures in a sentence or two, what the unit of measure is (if applicable) and what kind it is: counter, guage, histogram or summary. There is a section in the README that lists "meta-classes" of metrics (for lack of a better word) but it does not go into the details of the metrics contained in each one. Thanks.

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 the README section that currently lists metric meta-classes and inventory the full set of metrics exposed by the exporter. Document each metric’s name, measurement, unit where applicable, and type as requested, then verify the documentation covers the exporter’s exposed metrics.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation, observability
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.