InfluxDB Streaming Output and Integration

George Alpizar
George Alpizar
  • Updated

Overview

The InfluxDB output will stream analytics and insights to your InfluxDB deployment.


Review Parameters

Review the following parameters that you can configure in the Edge Delta App:

YAML Description
name

Enter a descriptive name for the output or integration.

For outputs, this name will be used to map this destination to a workflow.

This parameter is required. 

Review the following example:

name: influxdb-integration
integration_name

This parameter only appears when you create an individual output.

This parameter refers to the organization-level integration created in the Integrations page. If you enter this name, then the rest of the fields will be automatically populated.

If you need to add multiple instances of the same integration into the config, then you can add a custom name to each instance via the name field. In this situation, the name should be used to refer to the specific instance of the destination in the workflows.

This parameter is optional. 

Review the following example:

integration_name: orgs-influxdb
type

Enter influxdb.

This parameter is required. 

Review the following example:

type: influxdb
version

Enter the version number of the InfluxDB deployment.

This parameter supports versions 1.x and 2.x.

An empty version will default to version 2.x

This parameter is optional. 

Review the following example:

version: 1.x
endpoint

Enter the InfluxDB endpoint.

This parameter is required. 

Review the following example:

endpoint: "https://influxdb.<your-domain>.com/"
port

Enter the port to connect to InfluxDB.

This parameter is optional. 

Review the following example:

port: 443
db

Enter the InfluxDB database to stream data to.

This parameter is only required for version 1.x.

Review the following example:

db: "specific_influxdb_database"
organization

Enter the organization ID that corresponds to the desired bucket.

This parameter is only required for version 2.x.

Review the following example:

organization: yourorganization
bucket

Enter the name of the bucket that the agent will stream data to.  

This parameter is only required for version 2.x.

This parameter is required. 

Review the following example:

bucket: testbucket
token

Enter your InfluxDB token. 

This parameter is optional. 

Review the following example:

token: YOUR_API_TOKEN
http_user

Enter the InfluxDB user credentials.

This parameter is only required for version 1.x.

This parameter is required. 

Review the following example:

http_user: admin
http_password

Enter the InfluxDB password for connecting user.

This parameter is only required for version 1.x.

This parameter is required. 

Review the following example:

http_password: your_http_password

tls:

  disable_verify

To disable a TLS verification of a certificate, in the YAML file, enter:

  • disable_verify: true

To enable a TLS verification of the certificate, in the YAML file, you can enter disable_verify: false or you can remove this line entirely. 

This parameter is optional. 

Review the following example:

tls:
  disable_verify: true

tls:

  ca_file

Enter the absolute file path to the CA certificate file. 

This parameter is optional. 

Review the following example:

tls:
  ca_file: /var/etc/influxdb

tls:

  ca_path

Enter the absolute path to scan the CA certificate file.

This parameter is optional. 

Review the following example:

tls:
  ca_path: /certs/ca.pem

tls:

  crt_file

Enter the absolute path to the certificate file. 

This parameter is optional. 

Review the following example:

tls:
  crt_file: /certs/server-cert.pem

tls:

  key_file

Enter the absolute path to the private key file. 

This parameter is optional. 

Review the following example:

tls:
  key_file: /certs/server-key.pem

tls:

  key_password

Enter the password for the key file.

This parameter is optional. 

Review the following example:

tls:
  key_password: p@ssword123

tls:

 client_auth_type

enter a client authorization type. 

You can enter:

  • noclientcert
  • requestclientcert
  • requireanyclientcert
  • verifyclientcertifgiven
  • requireandverifyclientcert 

The default setting is noclientcert.

This parameter is optional. 

Review the following example:

tls:
client_auth_type: noclientcert

tls:

  min_version

Enter the minimum version of TLS to accept. 

This parameter is optional. 

Review the following example:

tls:
min_version: TLSv1_1

tls:

  max_version

Enter the maximum version of TLS to accept. 

This parameter is optional. 

Review the following example:

tls:
max_version: TLSv1_3

 

features

This parameter defines which data types to stream to the destination.

If you do not provide a value, then all will be set.

To learn more, review the Review Feature Types section in Stream Outputs and Integrations Overview.

This parameter is optional. 

Review the following example:

features: metric,alert
buffer_ttl

Enter a length of time to retry failed streaming data.

After this length of time is reached, the failed streaming data will no longer be tried.

This parameter is optional. 

Review the following example: 

buffer_ttl: 2h
buffer_path

Enter a folder path to temporarily store failed streaming data.

The failed streaming data will be retried until the data reaches its destinations or until the Buffer TTL value is reached.

If you enter a path that does not exist, then the agent will create directories, as needed.

This parameter is optional.

Review the following example:

buffer_path: /var/log/edgedelta/pushbuffer/
buffer_max_bytesize

Enter the maximum size of failed streaming data that you want to retry.

If the failed streaming data is larger than this size, then the failed streaming data will not be retried.

This parameter is optional.

Review the following example:

buffer_max_bytesize: 100MB

Review Sample Configuration

The following sample configuration displays an output without the name of the organization-level integration:

   - name: influxdb-integration
      type: influxdb
      endpoint: "https://influxdb.<your-domain>.com/"
      token: YOUR_API_TOKEN
      bucket: testbucket
      organization: yourorganization
      port: 443
    - name: influxdb-integration-v1x
      type: influxdb
      version: 1.x
      endpoint: "https://influxdb.<your-domain>.com/"
      token: YOUR_API_TOKEN
      port: 443
      http_user: admin
      http_password: your_http_password
      db: "specific_influxdb_database"

 

Share this document