Logs API No-Op Implementation
Status: Stable
Users of OpenTelemetry need a way to disable the API from actually performing any operations. The No-Op OpenTelemetry API implementation (henceforth referred to as the No-Op) provides users with this functionally. It implements the OpenTelemetry Logs API so that no telemetry is produced and computation resources are minimized.
All language implementations of OpenTelemetry MUST provide a No-Op.
The Logs API defines components with various operations. All No-Op components MUST NOT hold configuration or operational state. All No-op operations MUST accept all defined parameters, MUST NOT validate any arguments received, and MUST NOT return any non-empty error or log any message.
LoggerProvider
The No-Op MUST allow the creation of multiple LoggerProviderss.
Since all LoggerProviderss hold the same empty state, a No-Op MAY
provide the same LoggerProvider instances to all creation requests.
Logger Creation
New Logger instances are always created with a LoggerProvider.
Therefore, LoggerProvider MUST allow for the creation of Loggers.
All Loggers created MUST be an instance of the No-Op Logger.
Since all Loggers will hold the same empty state, a LoggerProvider MAY
return the same Logger instances to all creation requests.
Logger
Emit LogRecord
The No-Op Logger MUST allow
for emitting LogRecords.
Enabled
MUST always return false.
Feedback
Was this page helpful?
Thank you. Your feedback is appreciated!
Please let us know how we can improve this page. Your feedback is appreciated!