Debian Codegraph @

log/embedded/embedded.go

raw
1 // Copyright The OpenTelemetry Authors
2 // SPDX-License-Identifier: Apache-2.0
3
4 // Package embedded provides interfaces embedded within the [OpenTelemetry Logs
5 // Bridge API].
6 //
7 // Implementers of the [OpenTelemetry Logs API] can embed the relevant
8 // type from this package into their implementation directly. Doing so will
9 // result in a compilation error for users when the [OpenTelemetry Logs Bridge
10 // API] is extended (which is something that can happen without a major version
11 // bump of the API package).
12 //
13 // [OpenTelemetry Logs API]: https://pkg.go.dev/go.opentelemetry.io/otel/log
14 package embedded // import "go.opentelemetry.io/otel/log/embedded"
15
16 // LoggerProvider is embedded in the [Logs API LoggerProvider].
17 //
18 // Embed this interface in your implementation of the [Logs API
19 // LoggerProvider] if you want users to experience a compilation error,
20 // signaling they need to update to your latest implementation, when the [Logs
21 // Bridge API LoggerProvider] interface is extended (which is something that
22 // can happen without a major version bump of the API package).
23 //
24 // [Logs API LoggerProvider]: https://pkg.go.dev/go.opentelemetry.io/otel/log#LoggerProvider
25 type LoggerProvider interface{ loggerProvider() }
26
27 // Logger is embedded in [Logs API Logger].
28 //
29 // Embed this interface in your implementation of the [Logs API Logger]
30 // if you want users to experience a compilation error, signaling they need to
31 // update to your latest implementation, when the [Logs API Logger]
32 // interface is extended (which is something that can happen without a major
33 // version bump of the API package).
34 //
35 // [Logs API Logger]: https://pkg.go.dev/go.opentelemetry.io/otel/log#Logger
36 type Logger interface{ logger() }