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.

Sign up for GitHub

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

Jump to bottom

Oximeter macros could collect docstrings to use for timeseries descriptions #3922

Closed
bnaecker opened this issue Aug 21, 2023 · 1 comment
Closed

Oximeter macros could collect docstrings to use for timeseries descriptions #3922

bnaecker opened this issue Aug 21, 2023 · 1 comment
Labels
oximeter

Comments

@bnaecker
Copy link
Collaborator

We currently use the oximeter::{Target,Metric} derive macros for describing the components of a timeseries schema. These don't really have any descriptions beyond the name. We could grab the doc attributes in that macro, and use those for a description attached to the target and metric. That could go into the timeseries schema record itself that we store in the database.
@bnaecker
Copy link
Collaborator Author

Completed in #5889

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
oximeter
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bnaecker