Skip to content

log: clarify that Logger.Enabled is optional - #8764

Merged
pellared merged 5 commits into
open-telemetry:mainfrom
pellared:agent/logger-enabled-optional-guidance
Aug 18, 2026
Merged

pellared merged 5 commits into
open-telemetry:mainfrom
pellared:agent/logger-enabled-optional-guidance

Conversation

@pellared

@pellared pellared commented Aug 17, 2026 •

Copy link
Copy Markdown
Member

Changes

  • document that calling Logger.Enabled is optional
  • explain when the check is useful and when callers can emit directly
  • warn that cached Enabled results can become stale

Motivation

The Stable Logs API specification now explicitly says that Enabled is an optional performance optimization. The existing GoDoc instead tells callers to invoke it before every Emit, which can encourage unnecessary checks and contradicts the current specification guidance.

This is a follow-up to #5679 after open-telemetry/opentelemetry-specification#5198 updated the requirement.

@pellared pellared added this to the v1.46.0 milestone Aug 17, 2026
@pellared pellared added pkg:API Related to an API package documentation Provides helpful information area:logs Part of OpenTelemetry logs labels Aug 17, 2026
@pellared pellared moved this from Todo to In Progress in Go: Logs (GA) Aug 17, 2026
@pellared
pellared marked this pull request as ready for review August 17, 2026 11:10
@codecov

codecov Bot commented Aug 17, 2026 •

Copy link
Copy Markdown

Codecov Report

โœ… All modified and coverable lines are covered by tests.
โœ… Project coverage is 84.1%. Comparing base (4ef7cf2) to head (fe1e74f).

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #8764   +/-   ##
=====================================
  Coverage   84.1%   84.1%           
=====================================
  Files        331     331           
  Lines      26487   26487           
=====================================
  Hits       22288   22288           
  Misses      3794    3794           
  Partials     405     405           
Files with missing lines Coverage ฮ”
log/logger.go 100.0% <รธ> (รธ)

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

@pellared
pellared merged commit 3d62aa6 into open-telemetry:main Aug 18, 2026
50 checks passed
@pellared
pellared deleted the agent/logger-enabled-optional-guidance branch August 18, 2026 16:50
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Go: Logs (GA) Aug 18, 2026
This was referenced Aug 18, 2026
pellared added a commit that referenced this pull request Aug 25, 2026
This release is the last to support [Go 1.25].
The next release will require at least [Go 1.26].

### Added

- Support testing of [Go 1.27]. (#8811)
- Support `http/json` protocol in
`go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp`.
(#8273, #8775, #8831)
- Add `Hasher` struct and methods in
`go.opentelemetry.io/otel/attribute` to compute authoritative `Distinct`
hashes incrementally for attribute filtering and deduplication. (#8598)

### Changed

- Lazily evaluate filtered and dropped attributes on measurement hot
paths in `go.opentelemetry.io/otel/sdk/metric` to avoid unnecessary
attribute set allocations. (#8598)
- Add `ErrExporterShutdown` to `go.opentelemetry.io/otel/sdk/log` and
return it from the
`go.opentelemetry.io/otel/exporters/stdout/stdoutlog`,
`go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc`, and
`go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp` exporters
when `Export` is called after `Shutdown`. (#8773)
- Clarify in `go.opentelemetry.io/otel/log` that calling
`Logger.Enabled` is optional and that cached results can become stale.
(#8764)

### Fixed

- Export dropped attribute counts in OTLP log records from
`go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc` and
`go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp`. (#8829)
- Name span events created from OpenTracing logs after the `event` log
field, falling back to `log`, instead of always using an empty name in
`go.opentelemetry.io/otel/bridge/opentracing`. (#8648)
- Count exception attributes omitted due to the attribute count limit as
dropped in `go.opentelemetry.io/otel/sdk/log`. (#8796)
- Prevent log record and instrumentation scope attributes with empty
keys from reaching processors and exporters in
`go.opentelemetry.io/otel/sdk/log`. (#8797)
- Fix a data race when span attributes are read concurrently in
`go.opentelemetry.io/otel/sdk/trace`. (#8706)
- Prevent a panic in `(*Set).Filter` when called on a nil receiver in
`go.opentelemetry.io/otel/attribute`. (#8792)
- The simple span and log processors record
`otel.sdk.processor.{span,log}.processed` when the record is submitted
to the exporter instead of after the export completes, and no longer set
`error.type` from the export outcome, in
`go.opentelemetry.io/otel/sdk/trace` and
`go.opentelemetry.io/otel/sdk/log`. (#8705)
- Prevent `Resource.MarshalLog` from panicking on nil resources in
`go.opentelemetry.io/otel/sdk/resource`. (#8758)

[Go 1.27]: https://go.dev/doc/go1.27
[Go 1.26]: https://go.dev/doc/go1.26
[Go 1.25]: https://go.dev/doc/go1.25
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 pkg:API Related to an API package

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants