docs: add tool for generating docs for metrics #2133
Conversation
This commit adds a tool for generating docs for metrics. The tool extracts the metrics information from the various prometheus collectors and generates a markdown file with the metrics information. This is useful for generating the metrics documentation for the kepler Signed-off-by: vprashar2929 <vibhu.sharma2929@gmail.com>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## reboot #2133 +/- ##
==========================================
- Coverage 92.80% 86.22% -6.58%
==========================================
Files 33 34 +1
Lines 2779 2991 +212
==========================================
Hits 2579 2579
- Misses 157 369 +212
Partials 43 43 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| @@ -1,4 +1,4 @@ | |||
| .PHONY: all build build-debug clean test coverage lint vet fmt deps image push run | |||
| .PHONY: all build build-debug clean test coverage lint vet fmt deps image push run deploy undeploy cluster-restart cluster-down cluster-up gen-metrics-docs | |||
There was a problem hiding this comment.
Instead of this can we please have multiple .PHONY close to the target so that when you are deleting a target, the .PHONY gets removed as well ? -- In a separate PR
| // SPDX-FileCopyrightText: 2025 The Kepler Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package main |
There was a problem hiding this comment.
Very nice!
Could we write tests as well (in a separate PR) :) so that when we make a change, we don't break doc generation by mistake?
There was a problem hiding this comment.
yes will do that
There was a problem hiding this comment.
@vprashar2929 Good idea!!
Can we please add a CI test to ensure that the doc is up to date?
36ecc29
into
sustainable-computing-io:reboot
This commit adds a tool for generating docs for metrics.
The tool extracts the metrics information from the various prometheus collectors and generates a markdown file with the metrics information.
This is useful for generating the metrics documentation for the kepler