Skip to content

Document missing environment variables in internal/x READMEs - #9017

Open
om7057 wants to merge 2 commits into
open-telemetry:mainfrom
om7057:internal-x-readme-env-docs
Open

om7057 wants to merge 2 commits into
open-telemetry:mainfrom
om7057:internal-x-readme-env-docs

Conversation

@om7057

@om7057 om7057 commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes #9014, part of #2046.

  • Adds the Observability and Per-Series Start Timestamps sections to sdk/internal/x/README.md, which previously documented OTEL_GO_X_RESOURCE only.
  • Adds the missing README.md for exporters/otlp/otlptrace/otlptracehttp/internal/x, following the pattern of the equivalent README in otlptracegrpc.

Test plan

  • make verify-readmes

Add the Observability and Per-Series Start Timestamps sections to
sdk/internal/x/README.md, which previously documented OTEL_GO_X_RESOURCE
only. Add the missing README for
exporters/otlp/otlptrace/otlptracehttp/internal/x, following the pattern
of the equivalent README in otlptracegrpc.

Fixes open-telemetry#9014
@dmathieu dmathieu added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Sep 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think that we miss a reference to this package documentation in exporters/otlp/otlptrace/otlptracehttp/doc.go

@om7057
om7057 requested a review from ps-mir as a code owner September 24, 2026 19:33
@om7057

om7057 commented Sep 24, 2026

Copy link
Copy Markdown
Contributor Author

Added the missing reference to otlptracehttp/doc.go.

@codecov

codecov Bot commented Sep 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.1%. Comparing base (9a39658) to head (a3258b3).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #9017   +/-   ##
=====================================
  Coverage   89.1%   89.1%           
=====================================
  Files        338     338           
  Lines      22274   22274           
=====================================
+ Hits       19854   19856    +2     
+ Misses      2420    2418    -2     

see 2 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document missing environment variables in internal/x READMEs

3 participants