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

Update troubleshooting.md #103

Merged
merged 4 commits into from
Mar 13, 2025
Merged

Conversation

jackshirazi
Copy link
Contributor

Initial cut

@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)
Words + phrases
(Brand, terms)
Correctness
(Spelling, grammar)
Clarity
(Readability)
docs/_edot-sdks/java/troubleshooting.md 51 20 43 13

*TBD

@jackshirazi jackshirazi requested review from AlexanderWert and a team March 13, 2025 12:29
## General

Ensure you have set a service name (eg `-Dotel.service.name=Service1` or environment variable `OTEL_SERVICE_NAME` set to `Service1`) otherwise by default the data (traces, metrics, logs) will be sent to `unknown_service_java` - you may be getting data but it may all be under that service
Copy link
Member

Choose a reason for hiding this comment

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

[for later improvement] here when we have the configuration part ready, I think it would be simpler to link to it for how to set the config option, we only need to explain the "why we need it".

Determine if the issue is related to the agent by

1. Starting the application with no agent and seeing if the issue is not present, but then the issue is again present when restarting with the agent
Copy link
Member

Choose a reason for hiding this comment

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

[minor] we can advise to disable the agent through configuration or env variable as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, but I've seen people think they have but haven't. Better to advise to remove it I think

Copy link
Member

Choose a reason for hiding this comment

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

Good point, this is also something that can be easily verified on a running JVM by doing a ps -ef|grep javaagent, unlike setting an environment variable.

Co-authored-by: SylvainJuge <763082+SylvainJuge@users.noreply.github.com>
@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)
Words + phrases
(Brand, terms)
Correctness
(Spelling, grammar)
Clarity
(Readability)
docs/_edot-sdks/java/troubleshooting.md 51 20 43 13

*TBD

jackshirazi and others added 2 commits March 13, 2025 14:34
Co-authored-by: SylvainJuge <763082+SylvainJuge@users.noreply.github.com>
Co-authored-by: SylvainJuge <763082+SylvainJuge@users.noreply.github.com>
@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)
Words + phrases
(Brand, terms)
Correctness
(Spelling, grammar)
Clarity
(Readability)
docs/_edot-sdks/java/troubleshooting.md 51 20 43 14

*TBD

@elastic-acrolinx
Copy link

Acrolinx Scorecards

Select the total score link to review all feedback on clarity, consistency, tone, brand, terms, spelling, grammar, readability, and inclusive language. You should fix all spelling errors regardless of your total score. Fixing spelling errors helps maintain user trust in overall content quality.

Article Total score
(Required: 80)
Words + phrases
(Brand, terms)
Correctness
(Spelling, grammar)
Clarity
(Readability)
docs/_edot-sdks/java/troubleshooting.md 53 20 45 13

*TBD

@jackshirazi jackshirazi merged commit 7056827 into elastic:main Mar 13, 2025
3 checks passed
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

Successfully merging this pull request may close these issues.

3 participants