Package io.opentelemetry.sdk.logs
Interface LogRecordProcessor
- All Superinterfaces:
AutoCloseable
,Closeable
- All Known Implementing Classes:
BatchLogRecordProcessor
,MultiLogRecordProcessor
,NoopLogRecordProcessor
,SimpleLogRecordProcessor
LogRecordProcessor
is the interface to allow synchronous hooks for log records emitted by
Logger
s.- Since:
- 1.27.0
-
Method Summary
Modifier and TypeMethodDescriptiondefault 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
(Iterable<LogRecordProcessor> processors) Returns aLogRecordProcessor
which simply delegates to all processing to theprocessors
in order.default CompletableResultCode
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 Details
-
composite
Returns aLogRecordProcessor
which simply delegates to all processing to theprocessors
in order. -
composite
Returns aLogRecordProcessor
which simply delegates to all processing to theprocessors
in order. -
onEmit
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
Shutdown the log processor.- Returns:
- result
-
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 interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
-