mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-04-17 11:46:27 +02:00
3542ee68a9
* Implement the SimpleProcessor * Add BenchmarkSimpleProcessorOnEmit * Remove stale comment * Run benchmarks in parallel
51 lines
1.9 KiB
Go
51 lines
1.9 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package log // import "go.opentelemetry.io/otel/sdk/log"
|
|
|
|
import (
|
|
"context"
|
|
)
|
|
|
|
// Exporter handles the delivery of log records to external receivers.
|
|
type Exporter interface {
|
|
// Export transmits log records to a receiver.
|
|
//
|
|
// The deadline or cancellation of the passed context must be honored. An
|
|
// appropriate error should be returned in these situations.
|
|
//
|
|
// All retry logic must be contained in this function. The SDK does not
|
|
// implement any retry logic. All errors returned by this function are
|
|
// considered unrecoverable and will be reported to a configured error
|
|
// Handler.
|
|
//
|
|
// Implementations must not retain the records slice.
|
|
//
|
|
// Before modifying a Record, the implementation must use Record.Clone
|
|
// to create a copy that shares no state with the original.
|
|
Export(ctx context.Context, records []Record) error
|
|
// Shutdown is called when the SDK shuts down. Any cleanup or release of
|
|
// resources held by the exporter should be done in this call.
|
|
//
|
|
// The deadline or cancellation of the passed context must be honored. An
|
|
// appropriate error should be returned in these situations.
|
|
//
|
|
// After Shutdown is called, calls to Export, Shutdown, or ForceFlush
|
|
// should perform no operation and return nil error.
|
|
Shutdown(ctx context.Context) error
|
|
// ForceFlush exports log records to the configured Exporter that have not yet
|
|
// been exported.
|
|
//
|
|
// The deadline or cancellation of the passed context must be honored. An
|
|
// appropriate error should be returned in these situations.
|
|
ForceFlush(ctx context.Context) error
|
|
}
|
|
|
|
type noopExporter struct{}
|
|
|
|
func (noopExporter) Export(context.Context, []Record) error { return nil }
|
|
|
|
func (noopExporter) Shutdown(context.Context) error { return nil }
|
|
|
|
func (noopExporter) ForceFlush(context.Context) error { return nil }
|