Class VertxInfluxDbOptions

Vert.x InfluxDb micrometer configuration.

Hierarchy

VertxInfluxDbOptions

Index

Constructors

constructor

Constructors

constructor

new VertxInfluxDbOptions(): VertxInfluxDbOptions
new VertxInfluxDbOptions(obj: VertxInfluxDbOptions | {}): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:427
Returns VertxInfluxDbOptions
- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:429
Parameters
- obj: VertxInfluxDbOptions | {}
Returns VertxInfluxDbOptions

Methods

getBatchSize

getBatchSize(): number

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:437
Maximum number of measurements sent per request to the InfluxDB server. When the maximum is reached, several requests are made. Default is 10000.

Returns number

getBucket

getBucket(): string

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:449
Specifies the destination bucket for writes. Takes either the ID or Name interchangeably. This is only used with InfluxDB v2.

Returns string

getConnectTimeout

getConnectTimeout(): number

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:470
Connection timeout for InfluxDB server connections, in seconds. Default is 1 second.

Returns number

getDb

getDb(): string

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:480
Database name used to store metrics. Default is "default".

Returns string

getNumThreads

getNumThreads(): number

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:500
Number of threads to use by the push scheduler. Default is 2.

Returns number

getOrg

getOrg(): string

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:511
Specifies the destination organization for writes. Takes either the ID or Name interchangeably. This is only used with InfluxDB v2.

Returns string

getPassword

getPassword(): string

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:522
Password used for authenticated connections

Returns string

getReadTimeout

getReadTimeout(): number

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:532
Read timeout for InfluxDB server connections, in seconds. Default is 10 seconds.

Returns number

getRetentionPolicy

getRetentionPolicy(): string

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:542
InfluxDB retention policy

Returns string

getStep

getStep(): number

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:552
Push interval steps, in seconds. Default is 10 seconds.

Returns number

getToken

getToken(): string

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:562
Authentication token for the InfluxDB API. This takes precedence over userName/password if configured.

Returns string

getUri

getUri(): string

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:572
URI of the InfluxDB server. Example: http://influx:8086.

Returns string

getUserName

getUserName(): string

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:582
Username used for authenticated connections

Returns string

isCompressed

isCompressed(): boolean

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:460
Activate or deactivate GZIP compression. It is activated by default.

Returns boolean

isEnabled

isEnabled(): boolean

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:490
Set true to enable InfluxDB reporting

Returns boolean

setBatchSize

setBatchSize(batchSize: number): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:443
Maximum number of measurements sent per request to the InfluxDB server. When the maximum is reached, several requests are made. Default is 10000.

Parameters
- batchSize: number
Returns VertxInfluxDbOptions

setBucket

setBucket(bucket: string): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:455
Specifies the destination bucket for writes. Takes either the ID or Name interchangeably. This is only used with InfluxDB v2.

Parameters
- bucket: string
Returns VertxInfluxDbOptions

setCompressed

setCompressed(compressed: boolean): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:465
Activate or deactivate GZIP compression. It is activated by default.

Parameters
- compressed: boolean
Returns VertxInfluxDbOptions

setConnectTimeout

setConnectTimeout(connectTimeout: number): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:475
Connection timeout for InfluxDB server connections, in seconds. Default is 1 second.

Parameters
- connectTimeout: number
Returns VertxInfluxDbOptions

setDb

setDb(db: string): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:485
Database name used to store metrics. Default is "default".

Parameters
- db: string
Returns VertxInfluxDbOptions

setEnabled

setEnabled(enabled: boolean): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:495
Set true to enable InfluxDB reporting

Parameters
- enabled: boolean
Returns VertxInfluxDbOptions

setNumThreads

setNumThreads(numThreads: number): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:505
Number of threads to use by the push scheduler. Default is 2.

Parameters
- numThreads: number
Returns VertxInfluxDbOptions

setOrg

setOrg(org: string): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:517
Specifies the destination organization for writes. Takes either the ID or Name interchangeably. This is only used with InfluxDB v2.

Parameters
- org: string
Returns VertxInfluxDbOptions

setPassword

setPassword(password: string): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:527
Password used for authenticated connections

Parameters
- password: string
Returns VertxInfluxDbOptions

setReadTimeout

setReadTimeout(readTimeout: number): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:537
Read timeout for InfluxDB server connections, in seconds. Default is 10 seconds.

Parameters
- readTimeout: number
Returns VertxInfluxDbOptions

setRetentionPolicy

setRetentionPolicy(retentionPolicy: string): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:547
InfluxDB retention policy

Parameters
- retentionPolicy: string
Returns VertxInfluxDbOptions

setStep

setStep(step: number): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:557
Push interval steps, in seconds. Default is 10 seconds.

Parameters
- step: number
Returns VertxInfluxDbOptions

setToken

setToken(token: string): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:567
Authentication token for the InfluxDB API. This takes precedence over userName/password if configured.

Parameters
- token: string
Returns VertxInfluxDbOptions

setUri

setUri(uri: string): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:577
URI of the InfluxDB server. Example: http://influx:8086.

Parameters
- uri: string
Returns VertxInfluxDbOptions

setUserName

setUserName(userName: string): VertxInfluxDbOptions

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:587
Username used for authenticated connections

Parameters
- userName: string
Returns VertxInfluxDbOptions

toJson

toJson(): {}

- Defined in io.vertx/vertx-micrometer-metrics/target/npm/options.d.ts:590
Returns {}
- [key: string]: any

Generated using TypeDoc