com.influxdb.client

Class WriteOptions

java.lang.Object

com.influxdb.client.WriteOptions

@ThreadSafe
public final class WriteOptions
extends Object

WriteOptions are used to configure writes the data point into InfluxDB 2.0.

The default setting use the batching configured to (consistent with Telegraf):

• batchSize = 1000
• flushInterval = 1000 ms
• retryInterval = 5000 ms
• jitterInterval = 0
• bufferLimit = 10_000

The default backpressure strategy is BackpressureOverflowStrategy.DROP_OLDEST.

Author:

Jakub Bednar (bednar@github) (21/09/2018 10:11)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WriteOptions.Builder A builder for WriteOptions.

Field Summary

Fields

Modifier and Type	Field and Description
static WriteOptions	DEFAULTS Default configuration with values that are consistent with Telegraf.

Method Summary

Modifier and Type	Method and Description
static WriteOptions.Builder	builder() Creates a builder instance.
io.reactivex.BackpressureOverflowStrategy	getBackpressureStrategy()
int	getBatchSize()
int	getBufferLimit()
int	getExponentialBase() The base for the exponential retry delay.
int	getFlushInterval()
int	getJitterInterval()
int	getMaxRetries() The number of max retries when write fails.
int	getMaxRetryDelay() The maximum delay between each retry attempt in milliseconds.
int	getRetryInterval() The retry interval is used when the InfluxDB server does not specify "Retry-After" header.
io.reactivex.Scheduler	getWriteScheduler()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULTS

public static final WriteOptions DEFAULTS

Default configuration with values that are consistent with Telegraf.

Method Detail

getBatchSize

public int getBatchSize()

Returns:

the number of data point to collect in batch

See Also:

WriteOptions.Builder.batchSize(int)

getFlushInterval

public int getFlushInterval()

Returns:

the time to wait at most (milliseconds)

See Also:

(int)

getJitterInterval

public int getJitterInterval()

Returns:

batch flush jitter interval value (milliseconds)

See Also:

WriteOptions.Builder.jitterInterval(int)

getRetryInterval

public int getRetryInterval()

The retry interval is used when the InfluxDB server does not specify "Retry-After" header.
Retry-After: A non-negative decimal integer indicating the seconds to delay after the response is received.

Returns:

the time to wait before retry unsuccessful write (milliseconds)

See Also:

WriteOptions.Builder.retryInterval(int)

getMaxRetries

public int getMaxRetries()

The number of max retries when write fails.

Returns:

number of max retries

See Also:

WriteOptions.Builder.maxRetries(int)

getMaxRetryDelay

public int getMaxRetryDelay()

The maximum delay between each retry attempt in milliseconds.

Returns:

maximum delay

See Also:

WriteOptions.Builder.maxRetryDelay(int)

getExponentialBase

public int getExponentialBase()

The base for the exponential retry delay. The next delay is computed as: retryInterval * exponentialBase^(attempts-1) + random(jitterInterval)

Returns:

exponential base

See Also:

WriteOptions.Builder.exponentialBase(int)

getBufferLimit

public int getBufferLimit()

Returns:

Maximum number of points stored in the retry buffer.

See Also:

WriteOptions.Builder.bufferLimit(int)

getWriteScheduler

@Nonnull
public io.reactivex.Scheduler getWriteScheduler()

Returns:

The scheduler which is used for write data points.

See Also:

WriteOptions.Builder.writeScheduler(Scheduler)

getBackpressureStrategy

@Nonnull
public io.reactivex.BackpressureOverflowStrategy getBackpressureStrategy()

Returns:

the strategy to deal with buffer overflow when using onBackpressureBuffer

See Also:

WriteOptions.Builder.backpressureStrategy(BackpressureOverflowStrategy)

builder

@Nonnull
public static WriteOptions.Builder builder()

Creates a builder instance.

Returns:

a builder