For the complete documentation index, see llms.txt. This page is also available as Markdown.

InfluxDB Connection Properties

scheme (string, enum)

Protocol to use for connecting to the InfluxDB server. Choose 'http' for unencrypted or 'https' for encrypted connections.

This element must be one of the following enum values:

  • http

  • https

Default: "http"

Example: "https"

host (string, required)

Hostname or IP address of the InfluxDB server.

Example: "connectware"

port (integer)

Network port on which the InfluxDB server is listening.

Default: 8086

Example: 8086

token (string)

Authentication token used to access the InfluxDB server.

Default: ""

Example: "an-influx-auth-token"

probeInterval (integer)

Interval (in milliseconds) at which the connection to InfluxDB is checked for availability.

Default: 2000

Additional restrictions:

  • Minimum: 1000

timeout (integer)

Maximum time (in milliseconds) to wait for a connection to the InfluxDB server before timing out.

Default: 10000

Example: 10000

Additional restrictions:

  • Minimum: 1000

transportOptions (object)

Additional HTTP or HTTPS request options passed directly to the underlying Node.js client, depending on the configured connection scheme. When scheme is set to http, the options are forwarded to http.request. When scheme is set to https, the options are forwarded to https.request. This allows advanced configuration such as custom headers, agents, proxies, or TLS settings. Supported options follow the Node.js request options specification available at nodejs.org: HTTP, HTTPS

Default:

org (string)

Name of the InfluxDB organization. An organization is a workspace for a group of users All data and resources are grouped under this organization.

Default: "generic"

bucket (string)

Name of the InfluxDB bucket where data will be stored.

Default: "measurement_data"

precision (string, enum)

Time precision for timestamps written to InfluxDB. Options: nanoseconds (ns), microseconds (us), milliseconds (ms), or seconds (s).

This element must be one of the following enum values:

  • ns

  • us

  • ms

  • s

Default: "ms"

maxRetryDelay (integer)

Maximum time (in milliseconds) to wait between retry attempts when writing data.

Default: 180000

Example: 180000

minRetryDelay (integer)

Minimum time (in milliseconds) to wait before retrying a failed write operation.

Default: 5000

Example: 5000

retryJitter (integer)

Random value (up to this amount in milliseconds) added to the retry delay to avoid retry storms.

Default: 200

Example: 200

maxBufferLines (integer)

Maximum number of data points to buffer if they cannot be sent immediately.

Default: 100000

Example: 100000

maxRetries (integer)

Maximum number of times to retry a failed write operation before giving up.

Default: 3

Example: 3

exponentialBase (integer)

Base value for exponential backoff when calculating the next retry delay.

Default: 5

Example: 5

batchSize (integer)

Maximum number of data points to send in a single batch to InfluxDB.

Default: 1000

Example: 1000

flushInterval (integer)

Maximum time (in milliseconds) to keep data points in a batch before sending them to InfluxDB.

Default: 10000

Example: 10000

Additional restrictions:

  • Minimum: 1

connectionStrategy (object)

Configuration for retrying failed connection attempts using an exponential backoff strategy. The following properties define how the delay between retries increases.

Properties of the connectionStrategy object:

initialDelay (integer)

Delay (in milliseconds) before the first retry attempt after a failed connection. For each subsequent retry, this delay is multiplied by the incrementFactor until reaching maxDelay.

Default: 1000

Additional restrictions:

  • Minimum: 1000

maxDelay (integer)

Maximum delay (in milliseconds) between retry attempts. The calculated delay will not exceed this value, even as it increases with each retry. Must be greater than initialDelay.

Default: 30000

incrementFactor (integer)

Multiplier applied to the previous delay to calculate the next retry delay, up to the maxDelay. For example, with initialDelay of 1000 and incrementFactor of 2, the sequence would be 1000, 2000, 4000, 5000 (capped at maxDelay).

Default: 2

Additional restrictions:

  • Minimum: 2

Last updated

Was this helpful?