// Copyright The OpenTelemetry Authors // SPDX-License-Identifier: Apache-2.0 package log // import "go.opentelemetry.io/otel/sdk/log" import ( "context" "go.opentelemetry.io/otel/log" "go.opentelemetry.io/otel/log/embedded" "go.opentelemetry.io/otel/sdk/resource" ) // Compile-time check LoggerProvider implements log.LoggerProvider. var _ log.LoggerProvider = (*LoggerProvider)(nil) // LoggerProvider handles the creation and coordination of Loggers. All Loggers // created by a LoggerProvider will be associated with the same Resource. type LoggerProvider struct { embedded.LoggerProvider } type providerConfig struct{} // NewLoggerProvider returns a new and configured LoggerProvider. // // By default, the returned LoggerProvider is configured with the default // Resource and no Processors. Processors cannot be added after a LoggerProvider is // created. This means the returned LoggerProvider, one created with no // Processors, will perform no operations. func NewLoggerProvider(opts ...LoggerProviderOption) *LoggerProvider { // TODO (#5060): Implement. return nil } // Logger returns a new [log.Logger] with the provided name and configuration. // // This method can be called concurrently. func (p *LoggerProvider) Logger(name string, opts ...log.LoggerOption) log.Logger { // TODO (#5060): Implement. return &logger{} } // Shutdown flushes queued log records and shuts down the decorated expoter. // // This method can be called concurrently. func (p *LoggerProvider) Shutdown(ctx context.Context) error { // TODO (#5060): Implement. return nil } // ForceFlush flushes all exporters. // // This method can be called concurrently. func (p *LoggerProvider) ForceFlush(ctx context.Context) error { // TODO (#5060): Implement. return nil } // LoggerProviderOption applies a configuration option value to a LoggerProvider. type LoggerProviderOption interface { apply(providerConfig) providerConfig } type loggerProviderOptionFunc func(providerConfig) providerConfig func (fn loggerProviderOptionFunc) apply(c providerConfig) providerConfig { return fn(c) } // WithResource associates a Resource with a LoggerProvider. This Resource // represents the entity producing telemetry and is associated with all Loggers // the LoggerProvider will create. // // By default, if this Option is not used, the default Resource from the // go.opentelemetry.io/otel/sdk/resource package will be used. func WithResource(res *resource.Resource) LoggerProviderOption { return loggerProviderOptionFunc(func(cfg providerConfig) providerConfig { // TODO (#5060): Implement. return cfg }) } // WithProcessor associates Processor with a LoggerProvider. // // By default, if this option is not used, the LoggerProvider will perform no // operations; no data will be exported without a processor. // // Each WithProcessor creates a separate pipeline. Use custom decorators // for advanced scenarios such as enriching with attributes. // // For production, use [NewBatchingProcessor] to batch log records before they are exported. // For testing and debugging, use [NewSimpleProcessor] to synchronously export log records. func WithProcessor(processor Processor) LoggerProviderOption { return loggerProviderOptionFunc(func(cfg providerConfig) providerConfig { // TODO (#5060): Implement. return cfg }) } // WithAttributeCountLimit sets the maximum allowed log record attribute count. // Any attribute added to a log record once this limit is reached will be dropped. // // Setting this to zero means no attributes will be recorded. // // Setting this to a negative value means no limit is applied. // // If the OTEL_LOGRECORD_ATTRIBUTE_COUNT_LIMIT environment variable is set, // and this option is not passed, that variable value will be used. // // By default, if an environment variable is not set, and this option is not // passed, 128 will be used. func WithAttributeCountLimit(limit int) LoggerProviderOption { return loggerProviderOptionFunc(func(cfg providerConfig) providerConfig { // TODO (#5060): Implement. return cfg }) } // AttributeValueLengthLimit sets the maximum allowed attribute value length. // // This limit only applies to string and string slice attribute values. // Any string longer than this value will be truncated to this length. // // Setting this to a negative value means no limit is applied. // // If the OTEL_LOGRECORD_ATTRIBUTE_VALUE_LENGTH_LIMIT environment variable is set, // and this option is not passed, that variable value will be used. // // By default, if an environment variable is not set, and this option is not // passed, no limit (-1) will be used. func WithAttributeValueLengthLimit(limit int) LoggerProviderOption { return loggerProviderOptionFunc(func(cfg providerConfig) providerConfig { // TODO (#5060): Implement. return cfg }) }