remove outdated APM Server references from upstream OTel collector/SDK page#6880
Open
alexandra5000 wants to merge 1 commit into
Open
remove outdated APM Server references from upstream OTel collector/SDK page#6880alexandra5000 wants to merge 1 commit into
alexandra5000 wants to merge 1 commit into
Conversation
…page Replaces APM Server-specific language with generic Elastic endpoint terminology. Updates env var examples (ELASTIC_APM_* → ELASTIC_OTLP_*), fixes invalid `product: preview` applies_to syntax, and aligns the serverless section to reference the Managed OTLP endpoint instead of elastic-apm-server:8200. Closes elastic#6706 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
🔍 Preview links for changed docs |
Contributor
Elastic Docs Style Checker (Vale)Summary: 2 warnings found
|
| File | Line | Rule | Message |
|---|---|---|---|
| solutions/observability/apm/opentelemetry/upstream-opentelemetry-collectors-language-sdks.md | 83 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| solutions/observability/apm/opentelemetry/upstream-opentelemetry-collectors-language-sdks.md | 134 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
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.
Contributor
Author
|
/docs-review |
alexandra5000
commented
Jun 10, 2026
alexandra5000
left a comment
alexandra5000
left a comment
Contributor
Author
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: Two
e.g.instances in changed lines (prohibited Latin abbreviation →for example,). One code comment introduces a minor auth-format ambiguity (see inline). Remaining prose is clear and well-updated. - Jargon:
ECHis spelled out on first use in footnote 5 — correct. No unexplained internal abbreviations in changed content. - Frontmatter and
applies_to: All four inlineapplies_tofixes are correct and verified against the published schema.product: preview(no subkey) was invalid; replacements withstack: preview,serverless: preview, andstack: gaare all valid. - Content type fit: How-to structure intact. No regressions.
- Parent issue satisfaction: Substantially satisfied. Issue #6706 asked to investigate outdated APM Server references. The PR correctly updates configuration examples, env var names, footnotes, and example placeholders. The "Proxy requests to APM Server" section is intentionally preserved — it's genuinely about APM Server proxy setup.
Nits
- Footnote 7 in both sections also uses
documented [here](...)— "here" is non-descriptive link text. Suggest:documented in the [OpenTelemetry Collector environment variables reference](...). - Changed callout reads "...is currently in technical preview." Style discourages "currently" in static docs. Suggest: "...is in technical preview."
Reviewed with /docs-review (local fork-friendly adaptation)
| headers: | ||
| # Elastic APM Server secret token | ||
| Authorization: "Bearer ${env:ELASTIC_APM_SECRET_TOKEN}" <6> <7> | ||
| # Elastic API key or secret token |
Contributor
Author
There was a problem hiding this comment.
Style / Technical accuracy — The comment was changed from # Elastic APM Server secret token to # Elastic API key or secret token, but the code hardcodes the Bearer prefix:
Authorization: "Bearer ${env:ELASTIC_SECRET_TOKEN}"Bearer is the secret-token format only. API key authorization requires ApiKey as the prefix. A user who copies this snippet and substitutes an API key without reading footnote 6 will end up with a broken auth header.
Suggested fix:
Suggested change
| # Elastic API key or secret token | |
| # Elastic secret token (for API key auth use ApiKey prefix — see footnote 6) |
| 4. Elastic endpoint configuration. Elastic supports a ProtoBuf payload via both the OTLP protocol over gRPC transport [(OTLP/gRPC)](https://opentelemetry.io/docs/specs/otlp/#otlpgrpc) and the OTLP protocol over HTTP transport [(OTLP/HTTP)](https://opentelemetry.io/docs/specs/otlp/#otlphttp). To learn more about these exporters, see the OpenTelemetry Collector documentation: [OTLP/HTTP Exporter](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/otlphttpexporter) or [OTLP/gRPC exporter](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/otlpexporter). When adding an endpoint to an existing configuration an optional name component can be added, like `otlp/elastic`, to distinguish endpoints as described in the [OpenTelemetry Collector Configuration Basics](https://opentelemetry.io/docs/collector/configuration/#basics). | ||
| 5. Hostname and port of the Elastic endpoint. For self-managed deployments, use your APM Server address (for example, `apm-server:8200`). For Elastic Cloud Hosted (ECH), use the [Managed OTLP endpoint](opentelemetry://reference/motlp/index.md). | ||
| 6. Credential for Elastic [secret token authorization](/solutions/observability/apm/secret-token.md) (`Authorization: "Bearer a_secret_token"`) or [API key authorization](/solutions/observability/apm/api-keys.md) (`Authorization: "ApiKey an_api_key"`). | ||
| 7. Environment-specific configuration parameters can be conveniently passed in as environment variables documented [here](https://opentelemetry.io/docs/collector/configuration/#environment-variables) (e.g. `ELASTIC_OTLP_ENDPOINT` and `ELASTIC_SECRET_TOKEN`). |
Contributor
Author
There was a problem hiding this comment.
Style — e.g. is a Latin abbreviation the Elastic style guide prohibits. Use for example, instead.
Suggested change
| 7. Environment-specific configuration parameters can be conveniently passed in as environment variables documented [here](https://opentelemetry.io/docs/collector/configuration/#environment-variables) (e.g. `ELASTIC_OTLP_ENDPOINT` and `ELASTIC_SECRET_TOKEN`). | |
| 7. Environment-specific configuration parameters can be conveniently passed in as environment variables documented [here](https://opentelemetry.io/docs/collector/configuration/#environment-variables) (for example, `ELASTIC_OTLP_ENDPOINT` and `ELASTIC_SECRET_TOKEN`). |
| 8. To send OpenTelemetry logs to your project, declare a `logs` pipeline. {applies_to}`product: preview` | ||
| 5. URL of the [Managed OTLP endpoint](opentelemetry://reference/motlp/index.md). Find your endpoint URL in the {{serverless-full}} project settings. | ||
| 6. Credential for Elastic API key authorization (`Authorization: "ApiKey an_api_key"`). | ||
| 7. Environment-specific configuration parameters can be conveniently passed in as environment variables documented [here](https://opentelemetry.io/docs/collector/configuration/#configuration-environment-variables) (e.g. `ELASTIC_OTLP_ENDPOINT` and `ELASTIC_API_KEY`). |
Contributor
Author
There was a problem hiding this comment.
Style — Same as above: e.g. → for example,.
Suggested change
| 7. Environment-specific configuration parameters can be conveniently passed in as environment variables documented [here](https://opentelemetry.io/docs/collector/configuration/#configuration-environment-variables) (e.g. `ELASTIC_OTLP_ENDPOINT` and `ELASTIC_API_KEY`). | |
| 7. Environment-specific configuration parameters can be conveniently passed in as environment variables documented [here](https://opentelemetry.io/docs/collector/configuration/#configuration-environment-variables) (for example, `ELASTIC_OTLP_ENDPOINT` and `ELASTIC_API_KEY`). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
NOTE: This PR is AI-generated for the purpose of testing some workflows etc.
Summary
ELASTIC_APM_SERVER_ENDPOINT→ELASTIC_OTLP_ENDPOINT,ELASTIC_APM_SECRET_TOKEN→ELASTIC_SECRET_TOKEN,ELASTIC_APM_API_KEY→ELASTIC_API_KEY) to remove the misleading APM-specific prefixelastic-apm-server:8200as an example; now correctly points to the Managed OTLP endpointapm_server_url:8200toyour-motlp-endpointstack: gaonly (was incorrectly using invalidproduct: previewsyntax){applies_to}\product: preview`inline syntax → correctly scopedstack: previeworserverless: preview`Context
Flagged in elastic/opentelemetry-dev#801: "I think the content is a bit outdated as I do see APM server mentioned. We expect our users to use an EDOT collector or an EDOT-like custom collector or send the data to the managed OTLP endpoint."
Closes #6706
🤖 Generated with Claude Code