-
Notifications
You must be signed in to change notification settings - Fork 181
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve metric markdown generation #1040
Comments
We have also the status which has a field in YAML that we can use to render in markdown, instead of "hard-coding" it. In some cases the document has mixed statuses like the http metrics semconv and it would be nice if that can also be auto-generated from the YAML definitions. |
Note that the same / something very similar applies to other types of attributes: #1086 |
We're adding stability column in the open-telemetry/build-tools#278. Also adding related issues to this bigger one |
@joaopgrassi I'd love to see your request moved over into semconv repo, as I think you could implement it after #1000 is merged. |
@joaopgrassi I think you should be able to expand support for metric tables directly in semconv via the JINJA templates now. |
Support to generate markdown for metrics from yaml was added in open-telemetry/build-tools#79.
I'm currently moving the existing "hard-coded" metric semantic convention from the markdown files to yaml and I noticed a few things that can be improved:
For example, in the runtime-environment-metrics the metrics are organized as such:
When moving the metrics to YAML, to be able to achieve the same output as above, I need to manually add the (1) header and the recommendation.
In the end, it would be great if the only thing required to generate consistent markdown, are the placeholders such as
And that would generate
The text was updated successfully, but these errors were encountered: