Package io.opentelemetry.sdk.logs.export

Class BatchLogProcessor

java.lang.Object

io.opentelemetry.sdk.logs.export.BatchLogProcessor

All Implemented Interfaces:

LogProcessor, Closeable, AutoCloseable

public final class BatchLogProcessor
extends Object
implements LogProcessor

Implementation of the LogProcessor that batches logs exported by the SDK then pushes them to the exporter pipeline.

All logs reported by the SDK implementation are first added to a synchronized queue (with a maxQueueSize maximum size, if queue is full logs are dropped). Logs are exported either when there are maxExportBatchSize pending logs or scheduleDelayNanos has passed since the last export finished.

Method Summary

Modifier and Type	Method	Description
static BatchLogProcessorBuilder	builder(LogExporter logExporter)	Returns a new Builder for BatchLogProcessor.
void	emit(LogData logData)	Emit a log.
io.opentelemetry.sdk.common.CompletableResultCode	forceFlush()	Process all logs that have not yet been processed.
io.opentelemetry.sdk.common.CompletableResultCode	shutdown()	Shutdown the log processor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.opentelemetry.sdk.logs.LogProcessor

close

Method Details

builder

public static BatchLogProcessorBuilder builder(LogExporter logExporter)

Returns a new Builder for BatchLogProcessor.

Parameters:

logExporter - the LogExporter to which the Logs are pushed

Returns:

a new BatchLogProcessorBuilder.

Throws:

NullPointerException - if the logExporter is null.

emit

public void emit(LogData logData)

Description copied from interface: LogProcessor

Emit a log.

Specified by:

emit in interface LogProcessor

Parameters:

logData - the log

shutdown

public io.opentelemetry.sdk.common.CompletableResultCode shutdown()

Description copied from interface: LogProcessor

Shutdown the log processor.

Specified by:

shutdown in interface LogProcessor

Returns:

result

forceFlush

public io.opentelemetry.sdk.common.CompletableResultCode forceFlush()

Description copied from interface: LogProcessor

Process all logs that have not yet been processed.

Specified by:

forceFlush in interface LogProcessor

Returns:

result