Skip to content

Document OTLP logs and traces endpoints, move page out of TSDS subtree#6219

Merged
felixbarny merged 13 commits into
mainfrom
otlp-docs
May 7, 2026
Merged

Document OTLP logs and traces endpoints, move page out of TSDS subtree#6219
felixbarny merged 13 commits into
mainfrom
otlp-docs

Conversation

@felixbarny
Copy link
Copy Markdown
Member

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 in quickstart-tsds.md, advanced-topics-tsds.md, time-series-data-stream-tsds.md, and manage-data/toc.yml are 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_doc and auto_configure), with per-signal index patterns that match the OTLP REST integration tests. Traces ingestion requires both traces-* and logs-* 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: bodymap header or the elastic.mapping.mode scope 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.

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.
@felixbarny felixbarny requested review from a team as code owners April 30, 2026 12:53
@felixbarny felixbarny self-assigned this Apr 30, 2026
@felixbarny felixbarny requested a review from theletterf April 30, 2026 12:53
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 30, 2026

Elastic Docs AI PR menu

Check 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.

@felixbarny felixbarny requested a review from kkrik-es April 30, 2026 12:54
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 deployment subkeys are missing lifecycle values (invalid syntax); (2) the description field 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 % TODO comment will appear verbatim in the published output — remove before merging or link to a tracking issue.
  • The ## Why OTLP heading is terse; consider ## Why use the OTLP endpoint for 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 new manage-data/ingest/otlp-endpoint.md path.

Generated by Docs review agent for issue #6219 · ● 544.5K

Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md
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.
@felixbarny felixbarny requested a review from a team as a code owner April 30, 2026 15:36
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 30, 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 30, 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.

@theletterf
Copy link
Copy Markdown
Member

@leemthompo WDYT?

Copy link
Copy Markdown
Member

@theletterf theletterf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggestions!

Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/data-store/data-streams/time-series-data-stream-tsds.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
Comment thread manage-data/ingest/otlp-endpoint.md
Comment thread manage-data/ingest/otlp-endpoint.md Outdated
felixbarny and others added 7 commits May 5, 2026 11:00
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>
Comment thread manage-data/data-store/data-streams/tsds-ingest-otlp.md Outdated
Co-authored-by: Cursor <cursoragent@cursor.com>
@felixbarny
Copy link
Copy Markdown
Member Author

Looks like @theletterf and @kkrik-es are happy now.

@shainaraskas could you also have a look? Thanks!

@felixbarny felixbarny requested a review from shainaraskas May 5, 2026 16:13
@leemthompo
Copy link
Copy Markdown
Member

should we just delete and redirect the stub page at this point? wdyt @theletterf? should the related prometheus page go live in ingest too? 🤔

@felixbarny
Copy link
Copy Markdown
Member Author

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.

Copy link
Copy Markdown
Member

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

toc ✅

@felixbarny felixbarny enabled auto-merge (squash) May 7, 2026 18:16
@felixbarny felixbarny merged commit cbbabd3 into main May 7, 2026
11 checks passed
@felixbarny felixbarny deleted the otlp-docs branch May 7, 2026 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants