-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
[chore][exporter/debug] add description of verbosity levels #8841
[chore][exporter/debug] add description of verbosity levels #8841
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @astencel-sumo! Can you also link the troubleshooting guide to this doc, to make it easier to find?
exporter/debugexporter/README.md
Outdated
2023-11-10T22:49:03.510-0600 info TracesExporter {"kind": "exporter", "data_type": "traces", "name": "debug", "resource spans": 1, "spans": 2} | ||
``` | ||
|
||
### Normal verbosity |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is the default, I would prefer the documentation for basic
to be under normal
with basic
referencing the normal
level.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. Although I believe this description fits better into the basic
section and it's the normal
behavior that is somehow incorrect and subject to be changed. I also beileve the default verbosity also needs to be changed from normal
to basic
. We can talk about this in future pull requests/issues though. 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @astencel-sumo, i've opened up #8844 to follow up on this comment
Done. |
This improves the documentation of the
debug
exporter by adding descriptions of the available verbosity levels of the component.Hopefully this update also brings to light the fact that the verbosity levels need some work. For starters, it makes sense for the
normal
verbosity to have different output from thebasic
verbosity.