mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-28 21:09:17 +02:00
002c0a4c03
Closes #5425 Our current log `Processor` interface contains more functionality than the [OTel spec](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/sdk.md#logrecordprocessor-operations). The additional functionality allows processors to report back to the API if a Record should be constructed and emitted or not, which is quite helpful[^1][^2][^3][^4][^5]. This removes the `Enabled` method from the `Processor` type. It adds this functionality a new optional and experimental `FilterProcessor` interface type. The logger and provider are updated to check for this optional interface to be implemented with the configured processors and uses them to back the `Logger.Enabled` method, preserving existing functionality. By making this change: - The `Processor` interface is now compliant with the OTel spec and does not contain any additional unspecified behavior. - All `Processor` implementations are no longer required to implement an `Enabled` method. The default, when they do not implement this method, is to assume they are enabled. ### Benchmark ```terminal goos: linux goarch: amd64 pkg: go.opentelemetry.io/otel/sdk/log cpu: Intel(R) Core(TM) i7-8550U CPU @ 1.80GHz │ old.txt │ new7.txt │ │ sec/op │ sec/op vs base │ LoggerEnabled-8 133.30n ± 3% 32.36n ± 3% -75.72% (p=0.000 n=10) │ old.txt │ new7.txt │ │ B/op │ B/op vs base │ LoggerEnabled-8 0.000 ± 0% 0.000 ± 0% ~ (p=1.000 n=10) ¹ ¹ all samples are equal │ old.txt │ new7.txt │ │ allocs/op │ allocs/op vs base │ LoggerEnabled-8 0.000 ± 0% 0.000 ± 0% ~ (p=1.000 n=10) ¹ ¹ all samples are equal ``` This is a significant performance improvement due to the `Record` no longer being converted from the API version to the SDK version. [^1]: https://pkg.go.dev/go.opentelemetry.io/contrib/processors/minsev [^2]: https://pkg.go.dev/go.opentelemetry.io/otel/sdk/log#BatchProcessor.Enabled [^3]: https://pkg.go.dev/go.opentelemetry.io/otel/sdk/log#SimpleProcessor.Enabled [^4]:af75717ac4/bridges/otelslog/handler.go (L206-L211)[^5]:d0309ddd8c/bridges/otelzap/core.go (L142-L146)--------- Co-authored-by: Robert Pająk <pellared@hotmail.com> Co-authored-by: Sam Xie <sam@samxie.me>
40 lines
1.7 KiB
Go
40 lines
1.7 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
/*
|
|
Package log provides the OpenTelemetry Logs SDK.
|
|
|
|
See https://opentelemetry.io/docs/concepts/signals/logs/ for information
|
|
about the concept of OpenTelemetry Logs and
|
|
https://opentelemetry.io/docs/concepts/components/ for more information
|
|
about OpenTelemetry SDKs.
|
|
|
|
The entry point for the log package is [NewLoggerProvider].
|
|
[LoggerProvider] is the object that all Bridge API calls use to create
|
|
Loggers, and ultimately emit log records.
|
|
Also, it is an object that should be used to
|
|
control the life-cycle (start, flush, and shutdown) of the Logs SDK.
|
|
|
|
A LoggerProvider needs to be configured to process the log records, this is
|
|
done by configuring it with a [Processor] implementation using [WithProcessor].
|
|
The log package provides the [BatchProcessor] and [SimpleProcessor]
|
|
that are configured with an [Exporter] implementation which
|
|
exports the log records to given destination. See
|
|
[go.opentelemetry.io/otel/exporters] for exporters that can be used with these
|
|
Processors.
|
|
|
|
The data generated by a LoggerProvider needs to include information about its
|
|
origin. A LoggerProvider needs to be configured with a Resource, by using
|
|
[WithResource], to include this information. This Resource
|
|
should be used to describe the unique runtime environment instrumented code
|
|
is being run on. That way when multiple instances of the code are collected
|
|
at a single endpoint their origin is decipherable.
|
|
|
|
See [go.opentelemetry.io/otel/log] for more information about
|
|
the OpenTelemetry Logs Bridge API.
|
|
|
|
See [go.opentelemetry.io/otel/sdk/log/internal/x] for information about the
|
|
experimental features.
|
|
*/
|
|
package log // import "go.opentelemetry.io/otel/sdk/log"
|