Package io.opentelemetry.sdk.logs
Interface LogRecordProcessor
-
- All Superinterfaces:
java.lang.AutoCloseable
,java.io.Closeable
- All Known Implementing Classes:
BatchLogRecordProcessor
,MultiLogRecordProcessor
,NoopLogRecordProcessor
,SimpleLogRecordProcessor
@ThreadSafe public interface LogRecordProcessor extends java.io.Closeable
LogRecordProcessor
is the interface to allow synchronous hooks for log records emitted byLogger
s.- Since:
- 1.27.0
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
close()
Closes thisLogRecordProcessor
after processing any remaining log records, releasing any resources.static LogRecordProcessor
composite(LogRecordProcessor... processors)
Returns aLogRecordProcessor
which simply delegates to all processing to theprocessors
in order.static LogRecordProcessor
composite(java.lang.Iterable<LogRecordProcessor> processors)
Returns aLogRecordProcessor
which simply delegates to all processing to theprocessors
in order.default CompletableResultCode
forceFlush()
Process all log records that have not yet been processed.void
onEmit(Context context, ReadWriteLogRecord logRecord)
Called when aLogger
LogRecordBuilder.emit()
s a log record.default CompletableResultCode
shutdown()
Shutdown the log processor.
-
-
-
Method Detail
-
composite
static LogRecordProcessor composite(LogRecordProcessor... processors)
Returns aLogRecordProcessor
which simply delegates to all processing to theprocessors
in order.
-
composite
static LogRecordProcessor composite(java.lang.Iterable<LogRecordProcessor> processors)
Returns aLogRecordProcessor
which simply delegates to all processing to theprocessors
in order.
-
onEmit
void onEmit(Context context, ReadWriteLogRecord logRecord)
Called when aLogger
LogRecordBuilder.emit()
s a log record.- Parameters:
context
- the context set viaLogRecordBuilder.setContext(Context)
, orContext.current()
if not explicitly setlogRecord
- the log record
-
shutdown
default CompletableResultCode shutdown()
Shutdown the log processor.- Returns:
- result
-
forceFlush
default CompletableResultCode forceFlush()
Process all log records that have not yet been processed.- Returns:
- result
-
close
default void close()
Closes thisLogRecordProcessor
after processing any remaining log records, releasing any resources.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
-
-