open class VertxInfluxDbOptions
Vert.x InfluxDb micrometer configuration.
Author
Dan Kristensen
Author
Joel Takvorian
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 VertxInfluxDbOptions(json: JsonObject)
Creates new options object for InfluxDB reporting from |
static val DEFAULT_BATCH_SIZE: Int
Default value for the maximum number of metrics in a batch = 10000. |
|
static val DEFAULT_COMPRESSION_ENABLED: Boolean
The default gzip enabled on InfluxDb = true. |
|
static val DEFAULT_CONNECT_TIMEOUT: Int
The default connection timeout (seconds) = 1. |
|
static val DEFAULT_DATABASE: String
The default InfluxDb database = default. |
|
static val DEFAULT_ENABLED: Boolean
Default value for enabled = false. |
|
static val DEFAULT_NUM_THREADS: Int
The default number of threads used = 2. |
|
static val DEFAULT_READ_TIMEOUT: Int
The default read timeout (seconds) = 10. |
|
static val DEFAULT_STEP: Int
Default value for metric collection interval (in seconds) = 10. |
|
static val DEFAULT_URI: String
The default InfluxDb server URI = http://localhost:8086. |
open fun getBatchSize(): Int
Get batch size, which is the maximum number of measurements sent per request to the InfluxDB server. |
|
open fun getConnectTimeout(): Int
Get the connection timeout for InfluxDB server connections, in seconds. |
|
open fun getDb(): String
Get the InfluxDB database name used to store metrics |
|
open fun getNumThreads(): Int
Get the number of threads used by the push scheduler |
|
open fun getPassword(): String
Get the password used for authenticated connections |
|
open fun getReadTimeout(): Int
Get the read timeout for InfluxDB server connections, in seconds. |
|
open fun getRetentionPolicy(): String
Get the InfluxDB retention policy |
|
open fun getStep(): Int
Get the step of push intervals, in seconds |
|
open fun getUri(): String
Get the InfluxDB server URI |
|
open fun getUserName(): String
Get the username used for authenticated connections |
|
open fun isCompressed(): Boolean
Get the GZIP compression flag for requests |
|
open fun isEnabled(): Boolean
Will InfluxDB reporting be enabled? |
|
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. |
|
open fun setCompressed(compressed: Boolean): VertxInfluxDbOptions
Activate or deactivate GZIP compression. It is activated by default. |
|
open fun setConnectTimeout(connectTimeout: Int): VertxInfluxDbOptions
Connection timeout for InfluxDB server connections, in seconds. Default is 1 second. |
|
open fun setDb(db: String): VertxInfluxDbOptions
Database name used to store metrics. Default is "default". |
|
open fun setEnabled(enabled: Boolean): VertxInfluxDbOptions
Set true to enable InfluxDB reporting |
|
open fun setNumThreads(numThreads: Int): VertxInfluxDbOptions
Number of threads to use by the push scheduler. Default is 2. |
|
open fun setPassword(password: String): VertxInfluxDbOptions
Password used for authenticated connections |
|
open fun setReadTimeout(readTimeout: Int): VertxInfluxDbOptions
Read timeout for InfluxDB server connections, in seconds. Default is 10 seconds. |
|
open fun setRetentionPolicy(retentionPolicy: String): VertxInfluxDbOptions
InfluxDB retention policy |
|
open fun setStep(step: Int): VertxInfluxDbOptions
Push interval steps, in seconds. Default is 10 seconds. |
|
open fun setUri(uri: String): VertxInfluxDbOptions
URI of the InfluxDB server. Example: http://influx:8086. |
|
open fun setUserName(userName: String): VertxInfluxDbOptions
Username used for authenticated connections |
|
open fun toMicrometerConfig(): InfluxConfig
Convert these options to a Micrometer's |