vertx / io.vertx.micrometer / VertxInfluxDbOptions

VertxInfluxDbOptions

open class VertxInfluxDbOptions

Vert.x InfluxDb micrometer configuration.

Author
Dan Kristensen

Author
Joel Takvorian

Constructors

<init>

VertxInfluxDbOptions()

Create default options for InfluxDB reporting. Note that they are disabled by default.

VertxInfluxDbOptions(other: VertxInfluxDbOptions)

Creates new options object for InfluxDB reporting, which is a copy of other.

VertxInfluxDbOptions(json: JsonObject)

Creates new options object for InfluxDB reporting from json input.

Properties

DEFAULT_BATCH_SIZE

static val DEFAULT_BATCH_SIZE: Int

Default value for the maximum number of metrics in a batch = 10000.

DEFAULT_COMPRESSION_ENABLED

static val DEFAULT_COMPRESSION_ENABLED: Boolean

The default gzip enabled on InfluxDb = true.

DEFAULT_CONNECT_TIMEOUT

static val DEFAULT_CONNECT_TIMEOUT: Int

The default connection timeout (seconds) = 1.

DEFAULT_DATABASE

static val DEFAULT_DATABASE: String

The default InfluxDb database = default.

DEFAULT_ENABLED

static val DEFAULT_ENABLED: Boolean

Default value for enabled = false.

DEFAULT_NUM_THREADS

static val DEFAULT_NUM_THREADS: Int

The default number of threads used = 2.

DEFAULT_READ_TIMEOUT

static val DEFAULT_READ_TIMEOUT: Int

The default read timeout (seconds) = 10.

DEFAULT_STEP

static val DEFAULT_STEP: Int

Default value for metric collection interval (in seconds) = 10.

DEFAULT_URI

static val DEFAULT_URI: String

The default InfluxDb server URI = http://localhost:8086.

Functions

getBatchSize

open fun getBatchSize(): Int

Get batch size, which is the maximum number of measurements sent per request to the InfluxDB server.

getConnectTimeout

open fun getConnectTimeout(): Int

Get the connection timeout for InfluxDB server connections, in seconds.

getDb

open fun getDb(): String

Get the InfluxDB database name used to store metrics

getNumThreads

open fun getNumThreads(): Int

Get the number of threads used by the push scheduler

getPassword

open fun getPassword(): String

Get the password used for authenticated connections

getReadTimeout

open fun getReadTimeout(): Int

Get the read timeout for InfluxDB server connections, in seconds.

getRetentionPolicy

open fun getRetentionPolicy(): String

Get the InfluxDB retention policy

getStep

open fun getStep(): Int

Get the step of push intervals, in seconds

getUri

open fun getUri(): String

Get the InfluxDB server URI

getUserName

open fun getUserName(): String

Get the username used for authenticated connections

isCompressed

open fun isCompressed(): Boolean

Get the GZIP compression flag for requests

isEnabled

open fun isEnabled(): Boolean

Will InfluxDB reporting be enabled?

setBatchSize

open fun setBatchSize(batchSize: Int): VertxInfluxDbOptions

Maximum number of measurements sent per request to the InfluxDB server. When the maximum is reached, several requests are made. Default is 10000.

setCompressed

open fun setCompressed(compressed: Boolean): VertxInfluxDbOptions

Activate or deactivate GZIP compression. It is activated by default.

setConnectTimeout

open fun setConnectTimeout(connectTimeout: Int): VertxInfluxDbOptions

Connection timeout for InfluxDB server connections, in seconds. Default is 1 second.

setDb

open fun setDb(db: String): VertxInfluxDbOptions

Database name used to store metrics. Default is "default".

setEnabled

open fun setEnabled(enabled: Boolean): VertxInfluxDbOptions

Set true to enable InfluxDB reporting

setNumThreads

open fun setNumThreads(numThreads: Int): VertxInfluxDbOptions

Number of threads to use by the push scheduler. Default is 2.

setPassword

open fun setPassword(password: String): VertxInfluxDbOptions

Password used for authenticated connections

setReadTimeout

open fun setReadTimeout(readTimeout: Int): VertxInfluxDbOptions

Read timeout for InfluxDB server connections, in seconds. Default is 10 seconds.

setRetentionPolicy

open fun setRetentionPolicy(retentionPolicy: String): VertxInfluxDbOptions

InfluxDB retention policy

setStep

open fun setStep(step: Int): VertxInfluxDbOptions

Push interval steps, in seconds. Default is 10 seconds.

setUri

open fun setUri(uri: String): VertxInfluxDbOptions

URI of the InfluxDB server. Example: http://influx:8086.

setUserName

open fun setUserName(userName: String): VertxInfluxDbOptions

Username used for authenticated connections

toMicrometerConfig

open fun toMicrometerConfig(): InfluxConfig

Convert these options to a Micrometer's InfluxConfig object