Skip to content

docs(otlp-transformer): mark log APIs experimental - #7016

Merged
JacksonWeber merged 2 commits into
open-telemetry:mainfrom
JacksonWeber:jacksonweber-document-otlp-log-apis
Aug 19, 2026
Merged

docs(otlp-transformer): mark log APIs experimental#7016
JacksonWeber merged 2 commits into
open-telemetry:mainfrom
JacksonWeber:jacksonweber-document-otlp-log-apis

Conversation

@JacksonWeber

Copy link
Copy Markdown
Contributor

Summary

  • mark LogsExporterMetricsHelper as experimental because it exposes ReadableLogRecord[]
  • make the existing experimental annotations on JsonLogsSerializer and ProtobufLogsSerializer TypeDoc-compatible
  • leave internal APIs and self-contained log export response interfaces unchanged, per the maintainer clarification

Validation

  • targeted ESLint on the three changed files
  • targeted TypeScript no-emit check using repository compiler options
  • TypeDoc conversion confirming exactly the three intended public exports are marked @experimental
  • git diff --check

Closes #4584

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@codecov

codecov Bot commented Aug 19, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.02%. Comparing base (756f49a) to head (45ee692).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7016   +/-   ##
=======================================
  Coverage   95.02%   95.02%           
=======================================
  Files         409      409           
  Lines       14304    14304           
  Branches     3276     3276           
=======================================
  Hits        13593    13593           
  Misses        711      711           
Files with missing lines Coverage Δ
...al/packages/otlp-transformer/src/logs/json/logs.ts 100.00% <ø> (ø)
...ackages/otlp-transformer/src/logs/protobuf/logs.ts 100.00% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@JacksonWeber
JacksonWeber marked this pull request as ready for review August 19, 2026 19:15
@JacksonWeber
JacksonWeber requested a review from a team as a code owner August 19, 2026 19:15
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@JacksonWeber
JacksonWeber added this pull request to the merge queue Aug 19, 2026
Merged via the queue into open-telemetry:main with commit 640e11b Aug 19, 2026
29 checks passed
@JacksonWeber
JacksonWeber deleted the jacksonweber-document-otlp-log-apis branch August 19, 2026 20:56
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.

[otlp-transformer] document experimental APIs

2 participants