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

Add OTel Operator auto-instrumentation troubleshooting page #4724

Merged
merged 10 commits into from
Sep 11, 2024
Merged

Add OTel Operator auto-instrumentation troubleshooting page #4724

merged 10 commits into from
Sep 11, 2024

Conversation

avillela
Copy link
Contributor

Add troubleshooting tips for OTel Operator's auto-instrumentation capability.

Ref issue: #4723
Related PR: #4708

@avillela avillela requested review from a team June 20, 2024 15:42
@avillela avillela mentioned this pull request Jun 20, 2024
Merged
@avillela avillela changed the title Add OTel Operator troubleshooting tips for auto-instrumentation. Add OTel Operator auto-instrumentation troubleshooting Jun 20, 2024
@avillela avillela changed the title Add OTel Operator auto-instrumentation troubleshooting Add OTel Operator auto-instrumentation troubleshooting page Jun 20, 2024
avillela and others added 2 commits June 20, 2024 12:10
@avillela avillela requested a review from svrnm June 21, 2024 21:11
theletterf
theletterf requested changes Jun 24, 2024
View reviewed changes
Copy link
Member

@theletterf theletterf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! First review pass.

content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
@avillela @theletterf
Apply suggestions from code review
3b4fae9 
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
tiffany76
tiffany76 requested changes Jun 24, 2024
View reviewed changes
Copy link
Contributor

@tiffany76 tiffany76 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few more copy edits. Thanks.

content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Outdated Show resolved Hide resolved
@svrnm svrnm added the sig-approval-missing Co-owning SIG didn't provide an approval label Jun 25, 2024
jaronoff97
jaronoff97 reviewed Jun 25, 2024
View reviewed changes
Copy link
Contributor

@jaronoff97 jaronoff97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one note, otherwise this looks great! thank you again 🙇

content/en/docs/kubernetes/operator/troubleshooting/automatic.md Show resolved Hide resolved
@svrnm
Copy link
Member

svrnm commented Jun 27, 2024

@jaronoff97 thanks for taking a look, is this good to go now or any other requests for change?

jaronoff97
jaronoff97 approved these changes Jun 27, 2024
View reviewed changes
Copy link
Contributor

@jaronoff97 jaronoff97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!! thank you again :D

pavolloffay
pavolloffay reviewed Jun 28, 2024
View reviewed changes
Copy link
Member

@pavolloffay pavolloffay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another common issue that we have seen is that the user hardcoded JAVA_TOOLS_OPTIONS (or equivalent for python and node) in docker image or it consumes it from a config map. In this case the operator does not see it and incorrectly overrides it

content/en/docs/kubernetes/operator/troubleshooting/automatic.md Show resolved Hide resolved
content/en/docs/kubernetes/operator/troubleshooting/automatic.md Show resolved Hide resolved
@avillela
Copy link
Contributor Author

Another common issue that we have seen is that the user hardcoded JAVA_TOOLS_OPTIONS (or equivalent for python and node) in docker image or it consumes it from a config map. In this case the operator does not see it and incorrectly overrides it

Added new section to address this.

@avillela avillela requested a review from pavolloffay July 15, 2024 21:51
@svrnm
Copy link
Member

svrnm commented Jul 25, 2024

@avillela @pavolloffay is this good to go?

@avillela
Copy link
Contributor Author

@avillela @pavolloffay is this good to go?

I've made the requested changes. Just waiting on feedback from @pavolloffay on the changes. 😁

@svrnm
Copy link
Member

svrnm commented Aug 1, 2024

@pavolloffay can you take a final look at this?

@svrnm
Copy link
Member

svrnm commented Sep 11, 2024

I am merging this now, if there are any open concerns, please follow up in a new issue

@svrnm svrnm added this pull request to the merge queue Sep 11, 2024
Merged via the queue into open-telemetry:main with commit e514b30 Sep 11, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@svrnm svrnm svrnm approved these changes

@tiffany76 tiffany76 tiffany76 approved these changes

@jaronoff97 jaronoff97 jaronoff97 approved these changes

@theletterf theletterf theletterf approved these changes

@pavolloffay pavolloffay Awaiting requested review from pavolloffay

Assignees
No one assigned
Labels
sig:operator sig-approval-missing Co-owning SIG didn't provide an approval
Projects
SIG Comms: PRs & Issues
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@avillela @svrnm @theletterf @pavolloffay @jaronoff97 @tiffany76