Skip to content
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

Generate docs on available metrics from metrics.yaml file and improve it #611

Open
andy-maier opened this issue Aug 15, 2024 · 0 comments
Open
Labels
area: docs type: enhancement New feature or request
Milestone

Comments

@andy-maier
Copy link
Member

andy-maier commented Aug 15, 2024

The current documentation on available metrics is a separate copy in the usage.rst file. As a separate copy, there is the risk of discrepancies between the actual metric definition and that documentation.

This ticket is to generate the metrics documentation from the metric definition file.

On that opportunity, some deficiencies of the current metrics documentation should be addressed. The generated metrics documentation should:

  • Group the metrics by metric group, because that is the granularity at which metrics can be enabled or disabled.
  • Provide the attributes shown in the current documentation (exported metric name, CPC modes, metric type, metric description)
  • Provide the labels of each metric (label name and description)
  • Provide the origin of the metrics (HMC metric name / resource type & property name)
  • Provide information about HMC and SE/CPC version dependencies of each metric

This requires some additional data to be defined in the metric definition file:

  • Add a description to the labels
  • Add the CPC modes (on the metric group?)
  • Add human readable version information to the metrics, where needed (they already exist as comments in the metric definition file)
@andy-maier andy-maier changed the title Generate docs on available metrics from metrics.yaml file Generate docs on available metrics from metrics.yaml file and improve it Aug 15, 2024
@andy-maier andy-maier added type: enhancement New feature or request area: docs labels Aug 15, 2024
@andy-maier andy-maier added this to the 2.1.0 milestone Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant