Skip to content

InfluxDB Exporter Component

The InfluxDB Exporter component subscribes to a Bus and exports data matching subscription patterns to a configurable InfluxDB database.

InfluxDB Exporter Configuration Variables

The following table describes the configuration variables that can be used with the InfluxDB Exporter component:

Parameter Type Description Valid Values Required
ServerURI String The URI of the database connection to use URI where the influxDB service is started Y
DBName String The name of the database to use The name of the database Y
Bus String The name of the Bus component to use The name of an existing Bus component Y
Logger String The name of the Logger component to use The name of an existing Logger component N
SelectData Array An array of selection data See Select Data Configuration Variables Y
QueueSize Unsigned Integer The size of the queue for the subscriber to hold messages Default: 4 N
UserName String Username for authentication

Set if AuthEnabled is set to true
A valid username N
Password String Password for authentication

Set if AuthEnabled is set to true
A valid password N
ConnectTimeout Unsigned Integer The connection timeout in milliseconds Default is 1000 N
Timeout Unsigned Integer The data transfer timeout in milliseconds Default is 0 (no timeout during transfer) N
AuthEnabled Boolean Determines user authentication

Set to true if auth-enabled is set to true in the influxdb.conf file
Valid values are as follows:
  • true
  • false (default)
N

Select Data Configuration Variables

The following table describes the configuration variables that can be used to configure the selection data from various sources:

Parameter Type Description Valid Values Required
Format Enum The default JSON encoding used for data received from the device Valid values are as follows:
  • Device
  • Raw (default)
N
Pattern String The pattern to match on the Bus component for subscription Y
Scope String The name to store as measurement

measurement is determined based on the value of Format, as follows:
  • If Format is set to Device, measurement is the name of the device
  • If Format is set to Raw, measurement is the value of Scope, if set, or the name of the topic
Measurement identifier to use when Format is set to Raw N

InfluxDB Exporter Configuration Example

The following example configures an InfluxDB export component:

{
  "ServerURI": "http://127.0.0.1:8086",
  "DBName": "influxdb_test",
  "AuthEnabled": true,
  "UserName": "admin",
  "Password": "admin",
  "SelectData": [
  {"Pattern": "device/data", "Format": "Device"}
  ],
  "Bus": "bus",
  "Logger": "logger",
  "ConnectTimeout": 750,
  "Timeout": 1500
}

Back to top