Document OTLP logs and traces endpoints, move page out of TSDS subtree#6219
Conversation
Elasticsearch 9.5 adds OTLP/HTTP endpoints for logs and traces as tech preview, alongside the existing metrics endpoint. Move the page from the TSDS subtree to manage-data/ingest/otlp-endpoint.md and reframe it to cover all three signals.
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. |
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: One "via" → "through" issue (lines 53 and 200). Content is otherwise clear and well-structured.
- Jargon: ECH, ECE, ECK are used without expansion on first use. Substitution variables (
\{\{ech}},\{\{ece}},\{\{eck}}) are available and will render the full product names. - Frontmatter and applies_to: Two issues — (1) the
deploymentsubkeys are missing lifecycle values (invalid syntax); (2) thedescriptionfield is absent (required). Also, an inline{applies_to}serverless: ga`` tag in the histogram section conflicts with the page-level deployment-only scope. - Content type fit: The page is a well-structured how-to/reference hybrid covering prerequisites, configuration, and limitations. The structure is appropriate for this type of content.
- Parent issue satisfaction: No linked parent issue referenced.
Nits
- Line 133: A
% TODOcomment will appear verbatim in the published output — remove before merging or link to a tracking issue. - The
## Why OTLPheading is terse; consider## Why use the OTLP endpointfor parallel structure with## When to use the OTLP endpoint.
Notes
- Vale was not available in this environment; style checks were performed manually against the Elastic style guide.
- The restructuring and cross-reference updates in the other changed files (TSDS quickstart, advanced topics, time-series overview, and
toc.yml) look correct — all point to the newmanage-data/ingest/otlp-endpoint.mdpath.
Generated by Docs review agent for issue #6219 · ● 544.5K
Add page description and applies_to lifecycle values, expand ECH/ECE/ECK abbreviations, drop the redundant serverless badge on the histogram bullet, fix Vale word-choice and latinism findings, and remove the inline TODO. Add a redirect from the old TSDS path so inbound cross-links from the elasticsearch repo continue to resolve.
🔍 Preview links for changed docs |
✅ Vale Linting ResultsNo 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. |
|
@leemthompo WDYT? |
Co-authored-by: Fabrizio Ferri-Benedetti <fabri.ferribenedetti@elastic.co> Co-authored-by: Kostas Krikellas <131142368+kkrik-es@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Looks like @theletterf and @kkrik-es are happy now. @shainaraskas could you also have a look? Thanks! |
|
should we just delete and redirect the stub page at this point? wdyt @theletterf? should the related prometheus page go live in ingest too? 🤔 |
|
We've had that discussion in this thread: #6219 (comment) where we concluded to keep the stub page to make it more discoverable from the TSDS docs. |
Elasticsearch 9.5 adds OTLP/HTTP endpoints for logs (
/_otlp/v1/logs) and traces (/_otlp/v1/traces) as tech preview, alongside the existing metrics endpoint. This PR documents the new endpoints and restructures the page accordingly.The OTLP endpoint page moves from the TSDS subtree to
manage-data/ingest/otlp-endpoint.md, since it's no longer metrics-only. Cross-references inquickstart-tsds.md,advanced-topics-tsds.md,time-series-data-stream-tsds.md, andmanage-data/toc.ymlare repointed.The page is reframed to position the OTLP endpoint as a non-default ingestion path. Users on ECH or serverless should still use mOTLP; users on ECE, ECK, or self-managed should still use a gateway Collector with the Elasticsearch exporter. The OTLP endpoint is recommended for applications that export OTLP natively without running a Collector, and for lightweight dev setups (SDK to Elasticsearch).
The Collector example switches from basic auth to API key auth using the
Authorization: ApiKey <api_key>header. A new section explains how to create an API key with the minimum required privileges (create_docandauto_configure), with per-signal index patterns that match the OTLP REST integration tests. Traces ingestion requires bothtraces-*andlogs-*because span events are written to logs data streams.The page also documents the body map mapping mode for logs, opt-in via the
X-Elastic-Mapping-Mode: bodymapheader or theelastic.mapping.modescope attribute. The Limitations section calls out that logs and traces can be duplicated on retry because acknowledgement is per-batch; metrics aren't affected because TSDS deduplicates documents based on their dimensions and timestamp.Depends on elastic/elasticsearch#147811 (feature-flag removal). Only merge after that lands.