Package io.opentelemetry.sdk.logs.export

Class BatchLogRecordProcessor

java.lang.Object

io.opentelemetry.sdk.logs.export.BatchLogRecordProcessor

All Implemented Interfaces:

LogRecordProcessor, Closeable, AutoCloseable

public final class BatchLogRecordProcessor
extends Object
implements LogRecordProcessor

Implementation of the LogRecordProcessor 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.

Since:

1.27.0

Method Summary

Modifier and Type	Method	Description
static BatchLogRecordProcessorBuilder	builder(LogRecordExporter logRecordExporter)	Returns a new Builder for BatchLogRecordProcessor.
io.opentelemetry.sdk.common.CompletableResultCode	forceFlush()	Process all log records that have not yet been processed.
LogRecordExporter	getLogRecordExporter()	Return the processor's configured LogRecordExporter.
void	onEmit(io.opentelemetry.context.Context context, ReadWriteLogRecord logRecord)	Called when a Logger LogRecordBuilder.emit()s a log record.
io.opentelemetry.sdk.common.CompletableResultCode	shutdown()	Shutdown the log processor.
String	toString()

Methods inherited from class java.lang.Object

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

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

close

Method Details

builder

public static BatchLogRecordProcessorBuilder builder(LogRecordExporter logRecordExporter)

Returns a new Builder for BatchLogRecordProcessor.

Parameters:

logRecordExporter - the LogRecordExporter to which the Logs are pushed

Returns:

a new BatchLogRecordProcessor.

Throws:

NullPointerException - if the logRecordExporter is null.

onEmit

public void onEmit(io.opentelemetry.context.Context context,
 ReadWriteLogRecord logRecord)

Description copied from interface: LogRecordProcessor

Called when a Logger LogRecordBuilder.emit()s a log record.

Specified by:

onEmit in interface LogRecordProcessor

Parameters:

context - the context set via LogRecordBuilder.setContext(Context), or Context.current() if not explicitly set

logRecord - the log record

shutdown

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

Description copied from interface: LogRecordProcessor

Shutdown the log processor.

Specified by:

shutdown in interface LogRecordProcessor

Returns:

result

forceFlush

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

Description copied from interface: LogRecordProcessor

Process all log records that have not yet been processed.

Specified by:

forceFlush in interface LogRecordProcessor

Returns:

result

getLogRecordExporter

public LogRecordExporter getLogRecordExporter()

Return the processor's configured LogRecordExporter.

Since:

1.37.0

toString

public String toString()

Overrides:

toString in class Object