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

[Question] Is there a straightforward way to see what is instrumented in each package? #474

Closed
julealgon opened this issue Jun 29, 2022 · 3 comments

Comments

@julealgon
Copy link

Issue that does not fit into other categories

I found out that there is a "Runtime" instrumentation extension and got curious about what exactly it exposed. When looking at that specific project's README or CHANGELOG files, I don't see direct mentions of all exposed metrics and traces.

While I'd want to know what that particular package exposes, the same question could also apply to all other instrumentation packages.

Is there a simple way of getting a full description of all instrumentations being done by one given library, or will the library authors (you guys) have to document each one of them at some point?

@cijothomas
Copy link
Member

The best documentation is the respective readme.md files.

Is there a simple way of getting a full description of all instrumentations being done by one given library

Could you elaborate what is "simply" ? Is readme.md not simple? For Metrics, the emitted metrics, has name and description, but its not something you can see until you actually use it to collect metrics! Nothing equivalent for traces, other than linking to the semantic conventions it follows.

@julealgon
Copy link
Author

Could you elaborate what is "simply" ? Is readme.md not simple?

The readme is definitely simple, but requires manual maintenance by the maintainers. I see you just updated the document for the Runtime instrumentation, so that's pretty nice. I was wondering if there was a way to automatically "export" telemetry metadata from an instrumentation package so that one could see everything that is provided without the need to have to document it all by hand. I assume the answer here is "there is no such capability".

@cijothomas
Copy link
Member

Yes. no such automatic discovery capability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants