You've already forked opentelemetry-go
mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2026-06-03 18:35:08 +02:00
Yevhenii Solomchenko
84d02c0f39
Fixes #6572 ## What - Update documentation in `log/doc.go`. - Fix naming of the Logs API in several documentation files `(Logs Bridge API -> Logs API)`. --------- Co-authored-by: Robert Pająk <pellared@hotmail.com> Co-authored-by: Damien Mathieu <42@dmathieu.com>
37 lines
1.7 KiB
Go
37 lines
1.7 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Package embedded provides interfaces embedded within the [OpenTelemetry Logs
|
|
// Bridge API].
|
|
//
|
|
// Implementers of the [OpenTelemetry Logs API] can embed the relevant
|
|
// type from this package into their implementation directly. Doing so will
|
|
// result in a compilation error for users when the [OpenTelemetry Logs Bridge
|
|
// API] is extended (which is something that can happen without a major version
|
|
// bump of the API package).
|
|
//
|
|
// [OpenTelemetry Logs API]: https://pkg.go.dev/go.opentelemetry.io/otel/log
|
|
package embedded // import "go.opentelemetry.io/otel/log/embedded"
|
|
|
|
// LoggerProvider is embedded in the [Logs API LoggerProvider].
|
|
//
|
|
// Embed this interface in your implementation of the [Logs API
|
|
// LoggerProvider] if you want users to experience a compilation error,
|
|
// signaling they need to update to your latest implementation, when the [Logs
|
|
// Bridge API LoggerProvider] interface is extended (which is something that
|
|
// can happen without a major version bump of the API package).
|
|
//
|
|
// [Logs API LoggerProvider]: https://pkg.go.dev/go.opentelemetry.io/otel/log#LoggerProvider
|
|
type LoggerProvider interface{ loggerProvider() }
|
|
|
|
// Logger is embedded in [Logs API Logger].
|
|
//
|
|
// Embed this interface in your implementation of the [Logs API Logger]
|
|
// if you want users to experience a compilation error, signaling they need to
|
|
// update to your latest implementation, when the [Logs API Logger]
|
|
// interface is extended (which is something that can happen without a major
|
|
// version bump of the API package).
|
|
//
|
|
// [Logs API Logger]: https://pkg.go.dev/go.opentelemetry.io/otel/log#Logger
|
|
type Logger interface{ logger() }
|