Deprecation notice:
Deprecated in favor of InfluxDB Processors maintained in https://github.com/influxdata/nifi-influxdb-bundle
Please consider using one the following alternatives: No alternative components suggested.
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 Name | API Name | Default Value | Allowable Values | Description |
|---|
| Database Name | influxdb-dbname | | | InfluxDB database to connect to
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| InfluxDB connection URL | influxdb-url | http://localhost:8086 | | InfluxDB 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 seconds | | The maximum time for establishing connection to the InfluxDB |
| Username | influxdb-username | | | Username for accessing InfluxDB
Supports Expression Language: true (will be evaluated using variable registry only) |
| Password | influxdb-password | | | Password for user
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only) |
| Character Set | influxdb-charset | UTF-8 | | Specifies the character set of the document data.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Consistency Level | influxdb-consistency-level | One | | InfluxDB consistency level
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Retention Policy | influxdb-retention-policy | autogen | | Retention policy for the saving the records
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Max size of records | influxdb-max-records-size | 1 MB | | Maximum size of records allowed to be posted in one batch
Supports Expression Language: true (will be evaluated using variable registry only) |
Relationships:
| Name | Description |
|---|
| failure-max-size | FlowFiles exceeding max records size are routed to this relationship |
| retry | FlowFiles were not saved to InfluxDB due to retryable exception are routed to this relationship |
| success | Successful FlowFiles that are saved to InfluxDB are routed to this relationship |
| failure | FlowFiles were not saved to InfluxDB are routed to this relationship |
Reads Attributes:
None specified.Writes Attributes:
| Name | Description |
|---|
| influxdb.error.message | InfluxDB 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.