PutInfluxDB

Description:

Processor to write the content of a FlowFile in 'line protocol'. Please check details of the 'line protocol' in InfluxDB documentation (https://www.influxdb.com/). The flow file can contain single measurement point or multiple measurement points separated by line seperator. The timestamp (last field) should be in nano-seconds resolution.

Tags:

influxdb, measurement, insert, write, put, timeseries

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Database Nameinfluxdb-dbnameInfluxDB database to connect to
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
InfluxDB connection URLinfluxdb-urlhttp://localhost:8086InfluxDB URL to connect to. Eg: http://influxdb:8086
Supports Expression Language: true (will be evaluated using variable registry only)
InfluxDB Max Connection Time Out (seconds)InfluxDB Max Connection Time Out (seconds)0 secondsThe maximum time for establishing connection to the InfluxDB
Usernameinfluxdb-usernameUsername for accessing InfluxDB
Supports Expression Language: true (will be evaluated using variable registry only)
Passwordinfluxdb-passwordPassword for user
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Character Setinfluxdb-charsetUTF-8Specifies the character set of the document data.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Consistency Levelinfluxdb-consistency-levelOne
  • One Return success when one node has responded with write success
  • Any Return success when any nodes have responded with write success
  • All Return success when all nodes have responded with write success
  • Quorum Return success when a majority of nodes have responded with write success
InfluxDB consistency level
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Retention Policyinfluxdb-retention-policyautogenRetention policy for the saving the records
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Max size of recordsinfluxdb-max-records-size1 MBMaximum size of records allowed to be posted in one batch
Supports Expression Language: true (will be evaluated using variable registry only)

Relationships:

NameDescription
failure-max-sizeFlowFiles exceeding max records size are routed to this relationship
retryFlowFiles were not saved to InfluxDB due to retryable exception are routed to this relationship
successSuccessful FlowFiles that are saved to InfluxDB are routed to this relationship
failureFlowFiles were not saved to InfluxDB are routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
influxdb.error.messageInfluxDB error message

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.