Skip to content

docs: clarify that OTLP endpoint is not the APM Server URL#997

Open
strawgate wants to merge 1 commit intoelastic:mainfrom
strawgate:docs/clarify-otlp-endpoint-config
Open

docs: clarify that OTLP endpoint is not the APM Server URL#997
strawgate wants to merge 1 commit intoelastic:mainfrom
strawgate:docs/clarify-otlp-endpoint-config

Conversation

@strawgate
Copy link

@strawgate strawgate commented Mar 7, 2026

Summary

  • Setup page: Replace example hostname my-deployment.apm.… with my-deployment.ingest.… to match the actual OTLP ingest endpoint pattern (consistent with other EDOT SDK docs like PHP).
  • Migration page: Change server_url mapping wording from "corresponds to" to "is replaced by" and add a link to the setup page for endpoint details.

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

✅ Vale Linting Results

No issues found on modified lines!


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.

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

🔍 Preview links for changed docs

- Replace `my-deployment.apm.…` with `my-deployment.ingest.…` in the
  setup example to avoid implying the APM Server URL should be used.
- Change `server_url` mapping from "corresponds to" to "is replaced by"
  and link to the setup page for endpoint configuration details.

Made-with: Cursor
@strawgate strawgate force-pushed the docs/clarify-otlp-endpoint-config branch from 5bbe78f to bb974b9 Compare March 7, 2026 05:14
@coderabbitai
Copy link

coderabbitai bot commented Mar 7, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d50343d7-8b02-4ab9-aedf-0388980f5ebc

📥 Commits

Reviewing files that changed from the base of the PR and between 09b32f8 and bb974b9.

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

📝 Walkthrough

Walkthrough

This pull request updates documentation for Elastic's OpenTelemetry Java agent's OTLP endpoint configuration. The migration guide clarifies that the Elastic server_url is "replaced by" the OpenTelemetry OTLP endpoint and adds a reference to the Setup section for configuration details. The Setup documentation example is corrected to use the Ingest endpoint URL instead of the APM endpoint URL for Elasticsearch.

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant