Add metricsmd package #3
Merged
Conversation
This file contains 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
Signed-off-by: Anna Kapuscinska <anna@isovalent.com>
lambdanis
force-pushed
the
ft/lambdanis/docs-generator
branch
2 times, most recently
from
8ee44dd to
5e19bd7
Compare
The metricsmd.Generate function reads a Prometheus registry and generates a Markdown reference documentation listing metrics, their help texts and labels. Signed-off-by: Anna Kapuscinska <anna@isovalent.com>
It's intended to be used as an add-on to applications that have a Cobra CLI and expose Prometheus metrics. The returned command generates a metrics reference documentation. Co-authored-by: Chance Zibolski <chance.zibolski@gmail.com> Signed-off-by: Anna Kapuscinska <anna@isovalent.com>
lambdanis
force-pushed
the
ft/lambdanis/docs-generator
branch
from
5e19bd7 to
2858155
Compare
Signed-off-by: Anna Kapuscinska <anna@isovalent.com>
This was referenced Feb 28, 2024
Move all configuration options into one Config struct, passed to NewCmd and Generate functions. Signed-off-by: Anna Kapuscinska <anna@isovalent.com>
lambdanis
force-pushed
the
ft/lambdanis/docs-generator
branch
from
4a9deeb to
8a3cd99
Compare
Having such a comment in the final docs HTML might be undesirable, and this is the case e.g. when the markdown is rendered with Hugo. Additionally, if metrics from multiple targets are compiled into one reference file, then it would include redundant comments. The "autogenerated" comment can still be enabled with a config option. Signed-off-by: Anna Kapuscinska <anna@isovalent.com>
This is useful when the metrics reference is embedded in another markdown document. Requested here: cilium/tetragon#2164 (comment) cilium/tetragon#2164 (comment) Signed-off-by: Anna Kapuscinska <anna@isovalent.com>
Validating passed Config prevents a panic or rendering invalid markdown. Signed-off-by: Anna Kapuscinska <anna@isovalent.com>
lambdanis
force-pushed
the
ft/lambdanis/docs-generator
branch
from
8a3cd99 to
23fc556
Compare
mtardy
approved these changes
Mar 1, 2024
mtardy
reviewed
Mar 1, 2024
There was a problem hiding this comment.
I think GitHub automatically does this appropriately?
There was a problem hiding this comment.
oh, does it? That's cool.
There was a problem hiding this comment.
ah go.sum is always displayed but vendored stuff is redacted except for appropriate stuff like vendor/modules.txt. See your PR for example https://github.com/cilium/tetragon/pull/2164/files.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
pkg/metricsmdis a utility for generating a metrics reference in the markdown format from initialized Prometheus registry. It's intended to be used as an add-on to applications that have a Cobra CLI and expose Prometheus metrics.For example usage see cilium/tetragon#2164