sdk/log: Add package example (#5579)

Towards https://github.com/open-telemetry/opentelemetry-go/issues/5065

Co-authored-by: Sam Xie <sam@samxie.me>

sdk/log/example_test.go

@@ -5,16 +5,55 @@ package log_test
 
 import (
 	"context"
+	"fmt"
 	"strings"
 
-	"go.opentelemetry.io/otel/log"
-	logsdk "go.opentelemetry.io/otel/sdk/log"
+	logapi "go.opentelemetry.io/otel/log"
+	"go.opentelemetry.io/otel/log/global"
+	"go.opentelemetry.io/otel/sdk/log"
 )
 
+// Initialize OpenTelemetry Logs SDK and setup logging using a log bridge.
+func Example() {
+	// Create an exporter that will emit log records.
+	// E.g. use go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp
+	// to send logs using OTLP over HTTP:
+	// exporter, err := otlploghttp.New(ctx)
+	var exporter log.Exporter
+
+	// Create a log record processor pipeline.
+	processor := log.NewBatchProcessor(exporter)
+
+	// Create a logger provider.
+	// You can pass this instance directly when creating a log bridge.
+	provider := log.NewLoggerProvider(
+		log.WithProcessor(processor),
+	)
+
+	// Handle shutdown properly so that nothing leaks.
+	defer func() {
+		err := provider.Shutdown(context.Background())
+		if err != nil {
+			fmt.Println(err)
+		}
+	}()
+
+	// Register as global logger provider so that it can be used via global.Meter
+	// and accessed using global.GetMeterProvider.
+	// Most log bridges use the global logger provider as default.
+	// If the global logger provider is not set then a no-op implementation
+	// is used, which fails to generate data.
+	global.SetLoggerProvider(provider)
+
+	// Use a bridge so that you can emit logs using your Go logging library of preference.
+	// E.g. use go.opentelemetry.io/contrib/bridges/otelslog so that you can use log/slog:
+	// slog.SetDefault(otelslog.NewLogger("my/pkg/name", otelslog.WithLoggerProvider(provider)))
+}
+
 // Use a processor that filters out records based on the provided context.
 func ExampleProcessor_filtering() {
 	// Existing processor that emits telemetry.
-	var processor logsdk.Processor = logsdk.NewBatchProcessor(nil)
+	var processor log.Processor = log.NewBatchProcessor(nil)
 
 	// Wrap the processor so that it ignores processing log records
 	// when a context deriving from WithIgnoreLogs is passed
@@ -23,8 +62,8 @@ func ExampleProcessor_filtering() {
 
 	// The created processor can then be registered with
 	// the OpenTelemetry Logs SDK using the WithProcessor option.
-	_ = logsdk.NewLoggerProvider(
-		logsdk.WithProcessor(processor),
+	_ = log.NewLoggerProvider(
+		log.WithProcessor(processor),
 	)
 }
 
@@ -41,17 +80,17 @@ func WithIgnoreLogs(ctx context.Context) context.Context {
 // ContextFilterProcessor filters out logs when a context deriving from
 // [WithIgnoreLogs] is passed to its methods.
 type ContextFilterProcessor struct {
-	logsdk.Processor
+	log.Processor
 }
 
-func (p *ContextFilterProcessor) OnEmit(ctx context.Context, record logsdk.Record) error {
+func (p *ContextFilterProcessor) OnEmit(ctx context.Context, record log.Record) error {
 	if ignoreLogs(ctx) {
 		return nil
 	}
 	return p.Processor.OnEmit(ctx, record)
 }
 
-func (p *ContextFilterProcessor) Enabled(ctx context.Context, record logsdk.Record) bool {
+func (p *ContextFilterProcessor) Enabled(ctx context.Context, record log.Record) bool {
 	return !ignoreLogs(ctx) && p.Processor.Enabled(ctx, record)
 }
 
@@ -63,35 +102,35 @@ func ignoreLogs(ctx context.Context) bool {
 // Use a processor which redacts sensitive data from some attributes.
 func ExampleProcessor_redact() {
 	// Existing processor that emits telemetry.
-	var processor logsdk.Processor = logsdk.NewBatchProcessor(nil)
+	var processor log.Processor = log.NewBatchProcessor(nil)
 
 	// Wrap the processor so that it redacts values from token attributes.
 	processor = &RedactTokensProcessor{processor}
 
 	// The created processor can then be registered with
 	// the OpenTelemetry Logs SDK using the WithProcessor option.
-	_ = logsdk.NewLoggerProvider(
-		logsdk.WithProcessor(processor),
+	_ = log.NewLoggerProvider(
+		log.WithProcessor(processor),
 	)
 }
 
-// RedactTokensProcessor is a [logsdk.Processor] decorator that redacts values
+// RedactTokensProcessor is a [log.Processor] decorator that redacts values
 // from attributes containing "token" in the key.
 type RedactTokensProcessor struct {
-	logsdk.Processor
+	log.Processor
 }
 
 // OnEmit redacts values from attributes containing "token" in the key
 // by replacing them with a REDACTED value.
-func (p *RedactTokensProcessor) OnEmit(ctx context.Context, record logsdk.Record) error {
+func (p *RedactTokensProcessor) OnEmit(ctx context.Context, record log.Record) error {
 	cloned := false
-	record.WalkAttributes(func(kv log.KeyValue) bool {
+	record.WalkAttributes(func(kv logapi.KeyValue) bool {
 		if strings.Contains(strings.ToLower(kv.Key), "token") {
 			if !cloned {
 				record = record.Clone()
 				cloned = true
 			}
-			record.AddAttributes(log.String(kv.Key, "REDACTED"))
+			record.AddAttributes(logapi.String(kv.Key, "REDACTED"))
 		}
 		return true
 	})