-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Add documentation on the OTel Spring Boot starter #3377
Conversation
This PR could be merged after an OTel Java instrumentation release contains open-telemetry/opentelemetry-java-instrumentation#9625 |
since it will be ~ a month before next OTel Java Instrumentation release, what do you think of submitting a PR without the DataSource docs first and we can merge that, and a follow-up PR adding in the DataSource docs? |
Documentation on JDBC instrumentation removed |
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 for taking the time to write this down @jeanbisutti! I provided some change requests below.
My major point is that people not familiar with OpenTelemetry might get confused what the differences between this approach and the agent are. This document should either link to another page clarifying that or doing it directly.
Hi @svrnm! Many thanks for your review! I have worked on addressing your feedback. Could you please review the last changes? Could you please provide some guidance to fix the CI issues? Thank you! |
I was out of office last week, so apologies for the delay, let me take another pass
do not worry too much about them, some of them can be fixed when the PR is ready to be merged. |
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.
a few more comments.
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.
See inline suggestions that replace javaInstrumentationVersion
with vers.instrumentation
.
Fix linter
Fix linter
Remove documentation on JDBC instrumentation
Co-authored-by: Severin Neumann <[email protected]>
Co-authored-by: Severin Neumann <[email protected]>
Co-authored-by: Severin Neumann <[email protected]>
Co-authored-by: Severin Neumann <[email protected]>
Co-authored-by: Severin Neumann <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
/fix:format |
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.
A (hopefully final) copyedit pass, adding tabbed panes too.
Co-authored-by: Patrice Chalin <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
Signed-off-by: svrnm <[email protected]>
First PR to add Spring OTel starter documentation
Preview: https://deploy-preview-3377--opentelemetry.netlify.app/docs/instrumentation/java/automatic/spring-boot/