public class VertxInfluxDbOptions extends Object
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_BATCH_SIZE
Default value for the maximum number of metrics in a batch = 10000.
|
static boolean |
DEFAULT_COMPRESSION_ENABLED
The default gzip enabled on InfluxDb = true.
|
static int |
DEFAULT_CONNECT_TIMEOUT
The default connection timeout (seconds) = 1.
|
static String |
DEFAULT_DATABASE
The default InfluxDb database = default.
|
static boolean |
DEFAULT_ENABLED
Default value for enabled = false.
|
static int |
DEFAULT_NUM_THREADS
The default number of threads used = 2.
|
static int |
DEFAULT_READ_TIMEOUT
The default read timeout (seconds) = 10.
|
static int |
DEFAULT_STEP
Default value for metric collection interval (in seconds) = 10.
|
static String |
DEFAULT_URI
The default InfluxDb server URI = http://localhost:8086.
|
Constructor and Description |
---|
VertxInfluxDbOptions()
Create default options for InfluxDB reporting.
|
VertxInfluxDbOptions(JsonObject json)
Creates new options object for InfluxDB reporting from
json input. |
VertxInfluxDbOptions(VertxInfluxDbOptions other)
Creates new options object for InfluxDB reporting, which is a copy of
other . |
Modifier and Type | Method and Description |
---|---|
int |
getBatchSize()
Get batch size, which is the maximum number of measurements sent per request to the InfluxDB server.
|
String |
getBucket() |
int |
getConnectTimeout()
Get the connection timeout for InfluxDB server connections, in seconds.
|
String |
getDb()
Get the InfluxDB database name used to store metrics
|
int |
getNumThreads()
Deprecated.
no longer used by Micrometer
|
String |
getOrg() |
String |
getPassword()
Get the password used for authenticated connections
|
int |
getReadTimeout()
Get the read timeout for InfluxDB server connections, in seconds.
|
String |
getRetentionPolicy()
Get the InfluxDB retention policy
|
int |
getStep()
Get the step of push intervals, in seconds
|
String |
getToken() |
String |
getUri()
Get the InfluxDB server URI
|
String |
getUserName()
Get the username used for authenticated connections
|
boolean |
isCompressed()
Get the GZIP compression flag for requests
|
boolean |
isEnabled()
Will InfluxDB reporting be enabled?
|
VertxInfluxDbOptions |
setBatchSize(int batchSize)
Maximum number of measurements sent per request to the InfluxDB server.
|
VertxInfluxDbOptions |
setBucket(String bucket)
Specifies the destination bucket for writes.
|
VertxInfluxDbOptions |
setCompressed(boolean compressed)
Activate or deactivate GZIP compression.
|
VertxInfluxDbOptions |
setConnectTimeout(int connectTimeout)
Connection timeout for InfluxDB server connections, in seconds.
|
VertxInfluxDbOptions |
setDb(String db)
Database name used to store metrics.
|
VertxInfluxDbOptions |
setEnabled(boolean enabled)
Set true to enable InfluxDB reporting
|
VertxInfluxDbOptions |
setNumThreads(int numThreads)
Deprecated.
no longer used by Micrometer
|
VertxInfluxDbOptions |
setOrg(String org)
Specifies the destination organization for writes.
|
VertxInfluxDbOptions |
setPassword(String password)
Password used for authenticated connections
|
VertxInfluxDbOptions |
setReadTimeout(int readTimeout)
Read timeout for InfluxDB server connections, in seconds.
|
VertxInfluxDbOptions |
setRetentionPolicy(String retentionPolicy)
InfluxDB retention policy
|
VertxInfluxDbOptions |
setStep(int step)
Push interval steps, in seconds.
|
VertxInfluxDbOptions |
setToken(String token)
Authentication token for the InfluxDB API.
|
VertxInfluxDbOptions |
setUri(String uri)
URI of the InfluxDB server.
|
VertxInfluxDbOptions |
setUserName(String userName)
Username used for authenticated connections
|
JsonObject |
toJson() |
io.micrometer.influx.InfluxConfig |
toMicrometerConfig()
Convert these options to a Micrometer's
InfluxConfig object |
public static final boolean DEFAULT_ENABLED
public static final int DEFAULT_STEP
public static final int DEFAULT_BATCH_SIZE
public static final String DEFAULT_URI
public static final String DEFAULT_DATABASE
public static final boolean DEFAULT_COMPRESSION_ENABLED
public static final int DEFAULT_NUM_THREADS
public static final int DEFAULT_CONNECT_TIMEOUT
public static final int DEFAULT_READ_TIMEOUT
public VertxInfluxDbOptions()
public VertxInfluxDbOptions(VertxInfluxDbOptions other)
other
.public VertxInfluxDbOptions(JsonObject json)
json
input.public JsonObject toJson()
public boolean isEnabled()
public VertxInfluxDbOptions setEnabled(boolean enabled)
public String getUri()
public VertxInfluxDbOptions setUri(String uri)
public String getDb()
public VertxInfluxDbOptions setDb(String db)
public String getUserName()
public VertxInfluxDbOptions setUserName(String userName)
public String getPassword()
public VertxInfluxDbOptions setPassword(String password)
public String getRetentionPolicy()
public VertxInfluxDbOptions setRetentionPolicy(String retentionPolicy)
public boolean isCompressed()
public VertxInfluxDbOptions setCompressed(boolean compressed)
public int getStep()
public VertxInfluxDbOptions setStep(int step)
@Deprecated public int getNumThreads()
@Deprecated public VertxInfluxDbOptions setNumThreads(int numThreads)
public int getConnectTimeout()
public VertxInfluxDbOptions setConnectTimeout(int connectTimeout)
public int getReadTimeout()
public VertxInfluxDbOptions setReadTimeout(int readTimeout)
public int getBatchSize()
public VertxInfluxDbOptions setBatchSize(int batchSize)
public String getOrg()
public VertxInfluxDbOptions setOrg(String org)
org
- the destination organization for writespublic String getBucket()
public VertxInfluxDbOptions setBucket(String bucket)
bucket
- the destination bucket for writespublic String getToken()
public VertxInfluxDbOptions setToken(String token)
token
- the authentication token for the InfluxDB APIpublic io.micrometer.influx.InfluxConfig toMicrometerConfig()
InfluxConfig
objectCopyright © 2023 Eclipse. All rights reserved.