doc: add automated metrics documentation generator#3585
Open
Pittu-Sharma wants to merge 1 commit intoprometheus:masterfrom
Open
doc: add automated metrics documentation generator#3585Pittu-Sharma wants to merge 1 commit intoprometheus:masterfrom
Pittu-Sharma wants to merge 1 commit intoprometheus:masterfrom
Conversation
This adds a tool to statically analyze collectors and generate a comprehensive metrics list in docs/METRICS.md. This ensures the documentation remains accurate and maintainable. Signed-off-by: pittu sharma <pittusharma47@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces an automated approach to generate metrics documentation directly from the node_exporter collector source code.
Problem
Currently, maintaining
docs/METRICS.mdis a manual process, which can become outdated as new metrics are added or modified. This creates inconsistency between the actual exported metrics and the documentation.Solution
This PR adds a tool that parses the collector source files using Go AST (
go/ast) to extract:The extracted information is used to automatically generate the metrics documentation.
Changes Made
docs/METRICS.mdwith generated contentBenefits
Related Issue
Fixes #2302
Notes
This approach avoids requiring a running exporter instance and instead relies on static analysis of the source code.