java.lang.Object
- com.github.loki4j.client.pipeline.PipelineConfig

public class PipelineConfig
extends java.lang.Object

Configuration properties for Loki4j pipeline.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PipelineConfig.Builder

static class PipelineConfig.WriterFactory
A factory for Writer.

Field Summary

Fields
Modifier and Type	Field	Description
`int`	`batchMaxBytes`	Max number of bytes a single batch can contain (as counted by Loki).
`int`	`batchMaxItems`	Max number of events to put into a single batch before sending it to Loki.
`long`	`batchTimeoutMs`	Max time in milliseconds to keep a batch before sending it to Loki, even if max items/bytes limits for this batch are not reached.
`static java.util.function.Function<HttpConfig,Loki4jHttpClient>`	`defaultHttpClientFactory`
`boolean`	`drainOnStop`	If true, the pipeline will try to send all the remaining events on shutdown, so the proper shutdown procedure might take longer.
`boolean`	`dropRateLimitedBatches`	If true, batches that Loki responds to with a 429 status code (TooManyRequests) will be dropped rather than retried.
`java.util.function.Function<HttpConfig,Loki4jHttpClient>`	`httpClientFactory`	A factory for HTTP client for sending logs to Loki.
`HttpConfig`	`httpConfig`	Configuration properties for HTTP clients.
`java.util.function.Function<java.lang.Object,Loki4jLogger>`	`internalLoggingFactory`	A factory for an internal logger.
`long`	`internalQueuesCheckTimeoutMs`	A timeout for Loki4j threads to sleep if encode or send queues are empty.
`static PipelineConfig.WriterFactory`	`json`
`int`	`maxRetries`	Max number of attempts to send a batch to Loki before it will be dropped.
`long`	`maxRetryBackoffMs`	Maximum backoff delay before the next attempt to re-send a failed batch.
`int`	`maxRetryJitterMs`	Upper bound for a jitter added to the retry delays.
`boolean`	`metricsEnabled`	If true, the pipeline will report its metrics using Micrometer.
`long`	`minRetryBackoffMs`	Initial backoff delay before the next attempt to re-send a failed batch.
`java.lang.String`	`name`	Name of this pipeline.
`static PipelineConfig.WriterFactory`	`protobuf`
`long`	`sendQueueMaxBytes`	Max number of bytes to keep in the send queue.
`boolean`	`sortByTime`	If true, log records in batch are sorted by timestamp.
`boolean`	`staticLabels`	If you use only one label for all log records, you can set this flag to true and save some CPU time on grouping records by label.
`boolean`	`useDirectBuffers`	Use off-heap memory for storing intermediate data.
`PipelineConfig.WriterFactory`	`writerFactory`	A factory for Writer.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static HttpConfig.Builder`	`apache(int maxConnections, long connectionKeepAliveMs)`
`static PipelineConfig.Builder`	`builder()`
`static HttpConfig.Builder`	`java(long innerThreadsExpirationMs)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - json
```
public static final PipelineConfig.WriterFactory json
```
  - protobuf
```
public static final PipelineConfig.WriterFactory protobuf
```
  - defaultHttpClientFactory
```
public static final java.util.function.Function<HttpConfig,Loki4jHttpClient> defaultHttpClientFactory
```
  - name
```
public final java.lang.String name
```
    Name of this pipeline.
  - batchMaxItems
```
public final int batchMaxItems
```
    Max number of events to put into a single batch before sending it to Loki.
  - batchMaxBytes
```
public final int batchMaxBytes
```
    Max number of bytes a single batch can contain (as counted by Loki). This value should not be greater than server.grpc_server_max_recv_msg_size in your Loki config.
  - batchTimeoutMs
```
public final long batchTimeoutMs
```
    Max time in milliseconds to keep a batch before sending it to Loki, even if max items/bytes limits for this batch are not reached.
  - sortByTime
```
public final boolean sortByTime
```
    If true, log records in batch are sorted by timestamp. If false, records will be sent to Loki in arrival order. Turn this on if you see 'entry out of order' error from Loki.
  - staticLabels
```
public final boolean staticLabels
```
    If you use only one label for all log records, you can set this flag to true and save some CPU time on grouping records by label.
  - sendQueueMaxBytes
```
public final long sendQueueMaxBytes
```
    Max number of bytes to keep in the send queue. When the queue is full, incoming log events are dropped.
  - maxRetries
```
public final int maxRetries
```
    Max number of attempts to send a batch to Loki before it will be dropped. A failed batch send could be retried only in case of ConnectException, or receiving statuses 429, 503 from Loki. All other exceptions and 4xx-5xx statuses do not cause a retry in order to avoid duplicates.
  - minRetryBackoffMs
```
public final long minRetryBackoffMs
```
    Initial backoff delay before the next attempt to re-send a failed batch. Batches are retried with an exponential backoff (e.g. 0.5s, 1s, 2s, 4s, etc.) and jitter.
  - maxRetryBackoffMs
```
public final long maxRetryBackoffMs
```
    Maximum backoff delay before the next attempt to re-send a failed batch.
  - maxRetryJitterMs
```
public final int maxRetryJitterMs
```
    Upper bound for a jitter added to the retry delays.
  - dropRateLimitedBatches
```
public final boolean dropRateLimitedBatches
```
    If true, batches that Loki responds to with a 429 status code (TooManyRequests) will be dropped rather than retried.
  - internalQueuesCheckTimeoutMs
```
public final long internalQueuesCheckTimeoutMs
```
    A timeout for Loki4j threads to sleep if encode or send queues are empty. Decreasing this value means lower latency at cost of higher CPU usage.
  - useDirectBuffers
```
public final boolean useDirectBuffers
```
    Use off-heap memory for storing intermediate data.
  - drainOnStop
```
public final boolean drainOnStop
```
    If true, the pipeline will try to send all the remaining events on shutdown, so the proper shutdown procedure might take longer. Otherwise, the pipeline will drop the unsent events.
  - metricsEnabled
```
public final boolean metricsEnabled
```
    If true, the pipeline will report its metrics using Micrometer.
  - writerFactory
```
public final PipelineConfig.WriterFactory writerFactory
```
    A factory for Writer.
  - httpConfig
```
public final HttpConfig httpConfig
```
    Configuration properties for HTTP clients.
  - httpClientFactory
```
public final java.util.function.Function<HttpConfig,Loki4jHttpClient> httpClientFactory
```
    A factory for HTTP client for sending logs to Loki. Argument is a config required for constructing an HTTP client.
  - internalLoggingFactory
```
public final java.util.function.Function<java.lang.Object,Loki4jLogger> internalLoggingFactory
```
    A factory for an internal logger. Argument is a source class to report log messages from.
- Method Detail
  - apache
```
public static HttpConfig.Builder apache(int maxConnections,
                                        long connectionKeepAliveMs)
```
  - java
```
public static HttpConfig.Builder java(long innerThreadsExpirationMs)
```
  - builder
```
public static final PipelineConfig.Builder builder()
```

Modifier and Type	Class	Description
`static class`	`PipelineConfig.Builder`
`static class`	`PipelineConfig.WriterFactory`	A factory for Writer.

Class PipelineConfig

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

json

protobuf

defaultHttpClientFactory

name

batchMaxItems

batchMaxBytes

batchTimeoutMs

sortByTime

staticLabels

sendQueueMaxBytes

maxRetries

minRetryBackoffMs

maxRetryBackoffMs

maxRetryJitterMs

dropRateLimitedBatches

internalQueuesCheckTimeoutMs

useDirectBuffers

drainOnStop

metricsEnabled

writerFactory

httpConfig

httpClientFactory

internalLoggingFactory

Method Detail

apache

java

builder