Skip to content

sdk/log: improve Processor documentation#7695

Merged
pellared merged 6 commits into
open-telemetry:mainfrom
pellared:issue-7685
Dec 12, 2025
Merged

sdk/log: improve Processor documentation#7695
pellared merged 6 commits into
open-telemetry:mainfrom
pellared:issue-7685

Conversation

@pellared
Copy link
Copy Markdown
Member

@pellared pellared commented Dec 10, 2025

Fixes #7685

  • Clarify EnabledParameters contents and Enabled decision semantics
  • Remove the requirement of Enabled that param cannot be held by the implementation as it is immutable
  • Refine OnEmit docs around context cancellation and retry handling
  • Update Shutdown docs to mention Processor/Exporter and OnEmit instead of Export

- Clarify EnabledParameters contents and Enabled decision semantics
- Remove the requirement of Enabled that param cannot be held by the implementation as it is immutable
- Refine OnEmit docs around context cancellation and retry handling
- Update Shutdown docs to mention Processor/Exporter and OnEmit instead of Export
@pellared
Copy link
Copy Markdown
Member Author

FYI @bboreham

@pellared pellared added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Dec 10, 2025
Removed redundant comment about Record parameters.
- Clarify that EnabledParameters may omit fields present on the final Record
- Note that unset param fields do not imply unset fields on the emitted Record
@pellared pellared added enhancement New feature or request documentation Provides helpful information pkg:SDK Related to an SDK package area:logs Part of OpenTelemetry logs labels Dec 10, 2025
@codecov
Copy link
Copy Markdown

codecov Bot commented Dec 11, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.2%. Comparing base (de937aa) to head (a031883).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #7695   +/-   ##
=====================================
  Coverage   86.2%   86.2%           
=====================================
  Files        298     298           
  Lines      21829   21829           
=====================================
+ Hits       18817   18819    +2     
+ Misses      2635    2634    -1     
+ Partials     377     376    -1     

see 1 file with indirect coverage changes

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

@pellared pellared merged commit 5b8a1d1 into open-telemetry:main Dec 12, 2025
31 checks passed
@pellared pellared deleted the issue-7685 branch December 12, 2025 19:18
@MrAlias MrAlias added this to the v1.40.0 milestone Jan 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:logs Part of OpenTelemetry logs documentation Provides helpful information enhancement New feature or request pkg:SDK Related to an SDK package Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve log.Processor documentation

4 participants