InfluxDB

Standard time-series database idea for instrumentation or live KPI tracking

Overview

Time series database support is provided using the InfluxDB publisher connector. Processed events are published to a designated InfluxDB organisation bucket using either the event or ingestion timestamp.

The transport is ideal for use cases such as offline time series analytics, device monitoring and alerting. It offers flexibility in how tags and measurements are configured, which are aligned with the final processed event in the pipeline.

Further details on InfluxDB see the documentation.

Some key features are:

  1. InfluxDB integration The transport stores data in an InfluxDB bucket, ideal for handling time series data.

  2. Independent configuration Tags and measurements can be configured separately and aligned with the processed events.

  3. Use cases Designed for time series analytics, device monitoring and alerting scenarios.

Example & DSL attributes

This example configures the InfluxDB transport to send data to a local instance at http://localhost:8086.

It stores data in the banking organisation and nasdaqBaseAnalytics bucket, with a 3-hour retention time.

Gzip compression is enabled and logging is set to BASIC. Events use the symbol as a tag and include three Bollinger Band values:

  • ask_upper_BollingerBand

  • ask_middle_BollingerBand

  • ask_lower_BollingerBand

as DOUBLE measurements.

influxdb:
  url: http://localhost:8086
  authToken: 1d892e1ab6f70b3b9b3d619899a847957033e76385c231e02892ebfa59f1791f
  organisation: banking
  bucket: nasdaqBaseAnalytics
  retentionTime: 10800
  enableGzip: true
  logLevel: BASIC
  formatter:
    useEventTime: true
    tags:
      - symbol
    measurements:
      ask_upper_BollingerBand: DOUBLE
      ask_middle_BollingerBand: DOUBLE
      ask_lower_BollingerBand: DOUBLE

Attributes schema

Configuration parameters available for the InfluxDB publisher transport. The parameters are organised by order of importance, ranked from high to low.

AttributeDescriptionData TypeRequired

url

InfluxDB server address

http://<ip-address>:port

authToken

InfluxDB UI / CLI Authentication access token

String

username password

Authentication access details for v1.x InfluxDB.

Note: Only required if authToken has not been provided.

String

organisation

InfluxDB UI / CLI organisation token

String

bucket

Bucket where event measurements are persisted

String

formatter

See Formatter section below

See Formatter section below

enableGzip

Compress batched data to improve I/O transfer for large data loads

Boolean

Default: true

retentionTime

Number of seconds to retain measurements

Seconds as a integer value Default: 3600 seconds

loglevel

InfluxDB logging level

Options: NONE, BASIC, BODY, HEADERS

Default: BASIC

Formatter Attributes

This topic provides configuration parameters available for the formatter attribute. The parameters are organised by order of importance, ranked from high to low.

AttributeDescriptionData TypeRequired

measurements

Map of event measurements to persist mapped to data type

Map String -> DOUBLE, FLOAT, LONG, INTEGER, SHORT, BYTE, BOOLEAN, STRING

tags

List of record tags for enable aggregate query processing

String list

useEventTime

Specifies which event timestamp to persist

Boolean: Default: true

True: eventTimestamp

False: ingestionTimestamp

Last updated