elastic / elastic/opentelemetry

Docs fix — coherence: shard 1/1 — 4 findings

Open
#617 0 comments 1 reaction 2 assignees Claimed by @theletterf View on GitHub
docs-fix:coherence docs-quality-sweep
Dominant language
Python
Stars
37
Forks
50
Avg merge
23h 31m
Merged PRs (30d)
3

Description

Generated by `gh-aw-docs-coherence-sweep` for `elastic/opentelemetry` on 2026-W25.

Shard 1/1 · 27 pages in slice · 0 recently-changed · 27 total in scope · corpus 27 pages.

## Findings (4)

```yaml
- file: docs/reference/compatibility/sdks.md
line: 47
category: contradictory-content
severity: high
evidence: >
States '{{product.apm-server}} OTel intake: Not supported — Telemetry might ingest
but mapping, enrichment, and troubleshooting are not guaranteed.' The related published
APM overview page says EDOT distributions are 'ready to send data to the Managed OTLP
endpoint, APM Server, or directly to Elasticsearch', presenting APM Server as a valid
EDOT ingestion target.
related_url: https://www.elastic.co/docs/solutions/observability/apm/opentelemetry
suggested_fix: |
The EDOT reference docs are the source of truth. Update the APM overview page at
/docs/solutions/observability/apm/opentelemetry (in the docs-content repo) to remove
'APM Server' from the list of EDOT SDK destination options, or add a caveat that APM
Server OTel intake is not officially supported for EDOT SDKs. The APM limitations page
at /docs/solutions/observability/apm/opentelemetry/limitations already correctly states
'EDOT SDKs are tested and supported only with EDOT Collector Gateway or Managed OTel
intake.'

- file: docs/reference/edot-sdks/index.md
line: 84
category: contradictory-content
severity: high
evidence: >
States 'Using EDOT SDKs directly with APM Server's OpenTelemetry intake endpoint is
not supported.' The related published APM overview page contradicts this by listing APM
Server as a ready destination for EDOT: 'Each Elastic Distribution of OpenTelemetry is
a customized version... ready to send data to the Managed OTLP endpoint, APM Server, or
directly to Elasticsearch.'
related_url: https://www.elastic.co/docs/solutions/observability/apm/opentelemetry
suggested_fix: |
Same fix as above — the APM overview page in the docs-content repo is the page that
needs to be updated. The 'APM Server' destination should be removed or marked unsupported
for EDOT SDKs specifically, to match what this file, docs/reference/compatibility/sdks.md,
and docs/reference/architecture/index.md (line 74) all consistently state.

- file: docs/reference/edot-cloud-forwarder/index.md
line: 19
category: contradictory-content
severity: high
evidence: >
States the Cloud Forwarder sends data to the Managed OTLP Endpoint 'of {{serverless-full}}'
(Elastic Cloud Serverless), implying serverless-only. However, the file's own applies_to
frontmatter includes 'deployment: ech: preview', and the published mOTLP reference page
explicitly states the endpoint is available for both Elastic Cloud Serverless and Elastic
Cloud Hosted (ECH): 'An Elastic Cloud Serverless project or an Elastic Cloud Hosted (ECH)
deployment.' ECH users reading this page would incorrectly conclude the Cloud Forwarder
cannot send to their ECH mOTLP endpoint.
related_url: https://www.elastic.co/docs/reference/opentelemetry/motlp
suggested_fix: |
Change 'of {{serverless-full}}' to 'of {{ecloud}}' or 'of Elastic Cloud Serverless and
Elastic Cloud Hosted' to match the applies_to metadata and the mOTLP documentation, which
both confirm ECH is a supported target. The GCP Cloud Forwarder page
(docs/reference/edot-cloud-forwarder/gcp/index.md) correctly avoids this restriction by
saying 'the {{motlp}}' without a serverless qualifier.

- file: docs/reference/compatibility/edot-vs-upstream.md
line: 71
category: near-duplicate
severity: low
evidence: >
States 'Crash reporting: Available in EDOT only. Captures native crash data on mobile
platforms for post-mortem analysis.' The phrase 'mobile platforms' implies both EDOT
Android and EDOT iOS, but the published EDOT SDKs feature table shows crash reporting
is NOT available for EDOT Android (❌) and is only available for EDOT iOS (✅ v1.0+).
related_url: https://www.elastic.co/docs/reference/opentelemetry/edot-sdks
suggested_fix: |
Narrow the description to 'iOS' or 'mobile iOS platforms' to accurately reflect that only
EDOT iOS supports crash reporting. Alternatively, add a parenthetical: 'Captures native
crash data on supported mobile platforms (currently iOS only) for post-mortem analysis.'
This aligns the comparison table with the EDOT SDKs feature matrix in edot-sdks/index.md.
```

## Done when
- Contradictions are reconciled, with one page as source of truth.
- A PR addressing this issue is merged.

## Notes
- Findings 1 and 2 share the same related published page. The highest-impact fix is to update `/docs/solutions/observability/apm/opentelemetry` (in the `docs-content` repo, not this one) to remove APM Server as a EDOT destination.
- The GCP Cloud Forwarder sub-page avoids the serverless-restriction wording in Finding 3; the fix is only needed in `edot-cloud-forwarder/index.md`.

> Generated by [Docs coherence sweep agent](https://github.com/elastic/opentelemetry/actions/runs/27820355097) · 620 AIC · ⌖ 24.8 AIC · ⊞ 33.2K · [◷](https://github.com/search?q=repo%3Aelastic%2Fopentelemetry+is%3Aissue+%22gh-aw-workflow-call-id%3A+elastic%2Fopentelemetry%2Fgh-aw-docs-coherence-sweep%22&type=issues)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.