Package io.opentelemetry.sdk.logs.export

Interface LogRecordExporter

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

InMemoryLogRecordExporter

public interface LogRecordExporter
extends Closeable

An exporter is responsible for taking a collection of LogRecordDatas and transmitting them to their ultimate destination.

Method Summary

Modifier and Type	Method	Description
default void	close()	Closes this LogRecordExporter, releasing any resources.
static LogRecordExporter	composite(LogRecordExporter... exporters)	Returns a LogRecordExporter which delegates all exports to the exporters in order.
static LogRecordExporter	composite(Iterable<LogRecordExporter> exporters)	Returns a LogRecordExporter which delegates all exports to the exporters in order.
io.opentelemetry.sdk.common.CompletableResultCode	export(Collection<LogRecordData> logs)	Exports the collections of given LogRecordData.
io.opentelemetry.sdk.common.CompletableResultCode	flush()	Exports the collection of LogRecordData that have not yet been exported.
io.opentelemetry.sdk.common.CompletableResultCode	shutdown()	Shutdown the log exporter.

Method Details

composite

static LogRecordExporter composite(LogRecordExporter... exporters)

Returns a LogRecordExporter which delegates all exports to the exporters in order.

Can be used to export to multiple backends using the same LogRecordProcessor like a SimpleLogRecordProcessor or a BatchLogRecordProcessor.

composite

static LogRecordExporter composite(Iterable<LogRecordExporter> exporters)

Returns a LogRecordExporter which delegates all exports to the exporters in order.

Can be used to export to multiple backends using the same LogRecordProcessor like a SimpleLogRecordProcessor or a BatchLogRecordProcessor.

export

io.opentelemetry.sdk.common.CompletableResultCode export(Collection<LogRecordData> logs)

Exports the collections of given LogRecordData.

Parameters:

logs - the collection of LogRecordData to be exported

Returns:

the result of the export, which is often an asynchronous operation

flush

io.opentelemetry.sdk.common.CompletableResultCode flush()

Exports the collection of LogRecordData that have not yet been exported.

Returns:

the result of the flush, which is often an asynchronous operation

shutdown

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

Shutdown the log exporter. Called when SdkLoggerProvider.shutdown() is called when this exporter is registered to the provider via BatchLogRecordProcessor or SimpleLogRecordProcessor.

Returns:

a CompletableResultCode which is completed when shutdown completes

close

default void close()

Closes this LogRecordExporter, releasing any resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable