Skip to content

docs: add application server setup and JAVA_TOOL_OPTIONS scope warning#1059

Merged
alexandra5000 merged 3 commits intoelastic:mainfrom
alexandra5000:docs/java-server-config-gap
Apr 22, 2026
Merged

docs: add application server setup and JAVA_TOOL_OPTIONS scope warning#1059
alexandra5000 merged 3 commits intoelastic:mainfrom
alexandra5000:docs/java-server-config-gap

Conversation

@alexandra5000
Copy link
Copy Markdown
Contributor

@alexandra5000 alexandra5000 commented Apr 20, 2026

Summary

  • Adds a new Application servers section to the EDOT Java setup page with a summary table
  • Adds a note warning that applies to every JVM in scope, which can cause unintended instrumentation in multi-JVM environments (application servers, Kubernetes pods)
  • Links to the upstream OpenTelemetry server config docs for full details

Closes elastic/docs-content#5773

@github-actions
Copy link
Copy Markdown

📋 Changelog

⚠️ Cannot generate changelog: no matching type label found on this PR.

🔖 Add one of these type labels to your PR:

Label Type
breaking-change breaking-change
bug bug-fix
deprecation deprecation
feature feature
enhancement enhancement
changelog:upstream-update enhancement
docs docs
documentation docs

🔖 To skip changelog generation or configure label rules, see docs/changelog.yml.

@alexandra5000 alexandra5000 added the documentation Improvements or additions to documentation label Apr 20, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 20, 2026

🔍 Preview links for changed docs

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 20, 2026

Vale Linting Results

Summary: 1 suggestion found

💡 Suggestions (1)
File Line Rule Message
docs/reference/edot-java/setup/index.md 97 Elastic.Wordiness Consider using 'impossible' instead of 'not possible'.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

@alexandra5000 alexandra5000 marked this pull request as ready for review April 20, 2026 15:04
@alexandra5000 alexandra5000 requested review from a team as code owners April 20, 2026 15:04
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d8492699-17ad-4b47-9cd6-8b8a1c4894ec

📥 Commits

Reviewing files that changed from the base of the PR and between b24dbdf and 2754db0.

📒 Files selected for processing (1)
  • docs/reference/edot-java/setup/index.md

📝 Walkthrough

Walkthrough

The docs update clarifies Java agent configuration: it changes “Runtime attach” wording from “not possible” to “impossible”; replaces a terse JAVA_TOOL_OPTIONS note with an explicit example (export JAVA_TOOL_OPTIONS="-javaagent:/path/to/agent.jar"), warns that JAVA_TOOL_OPTIONS affects every JVM in the environment, and advises preferring server-specific -javaagent settings in startup scripts instead of system/pod-level variables. It adds an “Application servers” subsection with a table mapping common servers to the files/commands where -javaagent belongs and links to upstream server-configuration docs.

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed PR successfully addresses issue #5773 by adding application server configuration guidance and JAVA_TOOL_OPTIONS scope warnings as requested.
Out of Scope Changes check ✅ Passed All changes are confined to documentation updates directly addressing the linked issue; no unrelated code modifications present.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • 🛠️ Update Documentation: Commit on current branch
  • 🛠️ Update Documentation: Create PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

SylvainJuge
SylvainJuge previously approved these changes Apr 20, 2026
Comment thread docs/reference/edot-java/setup/index.md Outdated
theletterf
theletterf previously approved these changes Apr 22, 2026
@alexandra5000 alexandra5000 dismissed stale reviews from theletterf and SylvainJuge via 2754db0 April 22, 2026 10:42
@alexandra5000 alexandra5000 enabled auto-merge (squash) April 22, 2026 10:42
@alexandra5000 alexandra5000 merged commit 3a81c80 into elastic:main Apr 22, 2026
16 of 21 checks passed
@alexandra5000 alexandra5000 deleted the docs/java-server-config-gap branch April 22, 2026 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agent-java changelog:skip documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Website]: EDOT Java page to reference the upstream for application server configuration

3 participants