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

[chore][exporter/debug] add description of verbosity levels #8841

Merged

Conversation

andrzej-stencel
Copy link
Member

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 the basic verbosity.

@andrzej-stencel andrzej-stencel requested review from a team and codeboten November 11, 2023 05:11
@andrzej-stencel andrzej-stencel added Skip Changelog PRs that do not require a CHANGELOG.md entry area:documentation labels Nov 11, 2023
Copy link

codecov bot commented Nov 11, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

Copy link
Contributor

@codeboten codeboten left a 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?

2023-11-10T22:49:03.510-0600 info TracesExporter {"kind": "exporter", "data_type": "traces", "name": "debug", "resource spans": 1, "spans": 2}
```

### Normal verbosity
Copy link
Contributor

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.

Copy link
Member Author

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. 🙂

Copy link
Contributor

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

@andrzej-stencel
Copy link
Member Author

Thanks @astencel-sumo! Can you also link the troubleshooting guide to this doc, to make it easier to find?

Done.

@dmitryax dmitryax merged commit e60f67f into open-telemetry:main Nov 11, 2023
31 checks passed
@github-actions github-actions bot added this to the next release milestone Nov 11, 2023
@andrzej-stencel andrzej-stencel deleted the debug-exporter-readme-verbosity branch November 11, 2023 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants