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.CloseableLogRecordProcessoris the interface to allow synchronous hooks for log records emitted byLoggers.- Since:
- 1.27.0
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default voidclose()Closes thisLogRecordProcessorafter processing any remaining log records, releasing any resources.static LogRecordProcessorcomposite(LogRecordProcessor... processors)Returns aLogRecordProcessorwhich simply delegates to all processing to theprocessorsin order.static LogRecordProcessorcomposite(java.lang.Iterable<LogRecordProcessor> processors)Returns aLogRecordProcessorwhich simply delegates to all processing to theprocessorsin order.default CompletableResultCodeforceFlush()Process all log records that have not yet been processed.voidonEmit(Context context, ReadWriteLogRecord logRecord)Called when aLoggerLogRecordBuilder.emit()s a log record.default CompletableResultCodeshutdown()Shutdown the log processor.
-
-
-
Method Detail
-
composite
static LogRecordProcessor composite(LogRecordProcessor... processors)
Returns aLogRecordProcessorwhich simply delegates to all processing to theprocessorsin order.
-
composite
static LogRecordProcessor composite(java.lang.Iterable<LogRecordProcessor> processors)
Returns aLogRecordProcessorwhich simply delegates to all processing to theprocessorsin order.
-
onEmit
void onEmit(Context context, ReadWriteLogRecord logRecord)
Called when aLoggerLogRecordBuilder.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 thisLogRecordProcessorafter processing any remaining log records, releasing any resources.- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.io.Closeable
-
-