InfluxDB 2.x

The InfluxDB 2.x destination writes data to an InfluxDB 2.x database. To write to an InfluxDB 0.9 - 1.x database, use the InfluxDB destination. For information about supported versions, see Supported Systems and Versions.

When you configure the InfluxDB 2.x destination, you define connection information including an API token, and the organization and bucket to use. You can have the destination create the bucket if it does not exist. You can also use a connection to configure the destination.

You specify database details, such as the measurement, time, time field, and write precision. You also define tag and value fields.

Configuring an InfluxDB 2.x Destination

Configure an InfluxDB 2.x destination to write data to an InfluxDB 2.x database.

  1. In the Properties panel, on the General tab, configure the following properties:
    General Property Description
    Name Stage name.
    Description Optional description.
    Required Fields Fields that must include data for the record to be passed into the stage.
    Tip: You might include fields that the stage uses.

    Records that do not include all required fields are processed based on the error handling configured for the pipeline.
    Preconditions Conditions that must evaluate to TRUE to allow a record to enter the stage for processing. Click Add to create additional preconditions.

    Records that do not meet all preconditions are processed based on the error handling configured for the stage.
    On Record Error Error record handling for the stage:
    • Discard - Discards the record.
    • Send to Error - Sends the record to the pipeline for error handling.
    • Stop Pipeline - Stops the pipeline.
  2. On the InfluxDB tab, configure the following properties:
    InfluxDB Property Description
    Connection Connection that defines the information required to connect to an external system.

    To connect to an external system, you can select a connection that contains the details, or you can directly enter the details in the pipeline. When you select a connection, Control Hub hides other properties so that you cannot directly enter connection details in the pipeline.

    To create a new connection, click the Add New Connection icon: . To view and edit the details of the selected connection, click the Edit Connection icon: .
    URL URL to the InfluxDB 2.x HTTP API.
    Token API token to use. The API token must provide write access to the specified bucket.

    For information about creating an API token, see the InfluxDB documentation.

    Organization Organization name.
    Bucket Name of the bucket to write to.
    Measurement Field Field that contains the measurement name to use for the write.
    Time Field Field containing timestamp values associated with a point. Leave blank to use the Data Collector system timestamp.
    Write Precision The precision of the UNIX timestamps within the data.
    Tag Fields One or more fields that contain the tag key and value metadata for a point.
    Value Fields One or more fields that contain field value for a point.
    Create Bucket Creates a bucket of the specified name if it does not exist.
    Retention Time Retention time in seconds for the bucket.

    Use 0 to retain the data in the bucket indefinitely.