Package io.opentelemetry.sdk.logs.export
Class BatchLogRecordProcessorBuilder
java.lang.Object
io.opentelemetry.sdk.logs.export.BatchLogRecordProcessorBuilder
Builder class for
BatchLogRecordProcessor
.- Since:
- 1.27.0
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final int
(package private) static final int
(package private) static final int
(package private) static final long
private long
private final LogRecordExporter
private int
private int
private MeterProvider
private long
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Returns a newBatchLogRecordProcessor
that batches, then forwards them to the givenlogRecordExporter
.(package private) long
(package private) int
(package private) int
(package private) long
setExporterTimeout
(long timeout, TimeUnit unit) Sets the maximum time an export will be allowed to run before being cancelled.setExporterTimeout
(Duration timeout) Sets the maximum time an export will be allowed to run before being cancelled.setMaxExportBatchSize
(int maxExportBatchSize) Sets the maximum batch size for every export.setMaxQueueSize
(int maxQueueSize) Sets the maximum number of Logs that are kept in the queue before start dropping.setMeterProvider
(MeterProvider meterProvider) Sets theMeterProvider
to use to collect metrics related to batch export.setScheduleDelay
(long delay, TimeUnit unit) Sets the delay interval between two consecutive exports.setScheduleDelay
(Duration delay) Sets the delay interval between two consecutive exports.
-
Field Details
-
DEFAULT_SCHEDULE_DELAY_MILLIS
static final long DEFAULT_SCHEDULE_DELAY_MILLIS- See Also:
-
DEFAULT_MAX_QUEUE_SIZE
static final int DEFAULT_MAX_QUEUE_SIZE- See Also:
-
DEFAULT_MAX_EXPORT_BATCH_SIZE
static final int DEFAULT_MAX_EXPORT_BATCH_SIZE- See Also:
-
DEFAULT_EXPORT_TIMEOUT_MILLIS
static final int DEFAULT_EXPORT_TIMEOUT_MILLIS- See Also:
-
logRecordExporter
-
scheduleDelayNanos
private long scheduleDelayNanos -
maxQueueSize
private int maxQueueSize -
maxExportBatchSize
private int maxExportBatchSize -
exporterTimeoutNanos
private long exporterTimeoutNanos -
meterProvider
-
-
Constructor Details
-
BatchLogRecordProcessorBuilder
BatchLogRecordProcessorBuilder(LogRecordExporter logRecordExporter)
-
-
Method Details
-
setScheduleDelay
Sets the delay interval between two consecutive exports. If unset, defaults to 1000Lms. -
setScheduleDelay
Sets the delay interval between two consecutive exports. If unset, defaults to 1000Lms. -
getScheduleDelayNanos
long getScheduleDelayNanos() -
setExporterTimeout
Sets the maximum time an export will be allowed to run before being cancelled. If unset, defaults to 30000ms. -
setExporterTimeout
Sets the maximum time an export will be allowed to run before being cancelled. If unset, defaults to 30000ms. -
getExporterTimeoutNanos
long getExporterTimeoutNanos() -
setMaxQueueSize
Sets the maximum number of Logs that are kept in the queue before start dropping. More memory than this value may be allocated to optimize queue access.Default value is
2048
.- Parameters:
maxQueueSize
- the maximum number of Logs that are kept in the queue before start dropping.- Returns:
- this.
- See Also:
-
getMaxQueueSize
int getMaxQueueSize() -
setMaxExportBatchSize
Sets the maximum batch size for every export. This must be smaller or equal tomaxQueueSize
.Default value is
512
.- Parameters:
maxExportBatchSize
- the maximum batch size for every export.- Returns:
- this.
- See Also:
-
setMeterProvider
Sets theMeterProvider
to use to collect metrics related to batch export. If not set, metrics will not be collected. -
getMaxExportBatchSize
int getMaxExportBatchSize() -
build
Returns a newBatchLogRecordProcessor
that batches, then forwards them to the givenlogRecordExporter
.- Returns:
- a new
BatchLogRecordProcessor
.
-