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

Metrics Docs Improvements #2116

Open
cijothomas opened this issue Sep 14, 2024 · 0 comments
Open

Metrics Docs Improvements #2116

cijothomas opened this issue Sep 14, 2024 · 0 comments
Assignees
Labels
A-metrics Area: issues related to metrics documentation/examples Improvements or additions to documentation or examples

Comments

@cijothomas
Copy link
Member

  1. Show best practices.
  2. Warn users about high-cardinality, and the built-in capping.
  3. Iterate that MeterProvider, Meter and Instruments should be created once and re-used.
  4. Call out that creating Instrument of same name from different modules will get the same instrument instance. This maybe leveraged to avoid passing around instruments across module.
  5. Show that every additional attributes increases memory/cpu cost, and recommend Resource for fully static attributes and Meter scope attributes for fixed-within-scope attributes.
  6. Show proper initialization/shutdown tricks.
  7. If Views make it to 1.0, show how to use views to drop unwanted attributes.
  8. // More
@cijothomas cijothomas added documentation/examples Improvements or additions to documentation or examples A-metrics Area: issues related to metrics labels Sep 14, 2024
@cijothomas cijothomas self-assigned this Sep 14, 2024
@cijothomas cijothomas added this to the Metrics beta release milestone Sep 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-metrics Area: issues related to metrics documentation/examples Improvements or additions to documentation or examples
Projects
None yet
Development

No branches or pull requests

1 participant