InfluxDB Streaming Output and Integration

George Alpizar
George Alpizar
  • Updated

Overview

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

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"

Review Parameters

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

name

Required

Enter a descriptive name for the output or integration.

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

Review the following example:

name: influxdb-integration

integration_name

Optional

This parameter refers to the organization-level integration created in the Integrations page. 

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 parameter. In this situation, the name should be used to refer to the specific instance of the destination in the workflows.

Review the following example:

integration_name: orgs-influxdb

type

Required

Enter influxdb.

Review the following example:

type: influxdb

version

Optional 

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

Review the following example:

version: 1.x

endpoint

Required

Enter the InfluxDB endpoint.

Review the following example:

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

port

Optional 

Enter the port to connect to InfluxDB.

Review the following example:

port: 443

db

Required only for version 1.x

Enter the InfluxDB database to stream data to.

Review the following example:

db: "specific_influxdb_database"

organization

Required only for version 2.x

Enter the organization ID that corresponds to the desired bucket.

Review the following example:

organization: yourorganization

bucket

Required only for version 2.x 

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

Review the following example:

bucket: testbucket

token

Optional 

Enter your InfluxDB token. 

Review the following example:

token: YOUR_API_TOKEN

http_user

Required only for version 1.x.

Enter the InfluxDB user credentials.

Review the following example:

http_user: admin

http_password

Required only for version 1.x.

Enter the InfluxDB password for connecting user.

Review the following example:

http_password: your_http_password

tls: disable_verify

Optional 

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. 

Review the following example: 

tls:
  disable_verify: true

tls: ca_file

Optional

Enter the absolute file path to the CA certificate file. 

Review the following example: 

tls:
  ca_file: /var/etc/cribl/ca_file

tls: ca_path

Optional 

Enter the absolute path to scan the CA certificate file. 

Review the following example: 

tls:
  ca_path: /var/etc/cribl

tls: crt_file

Optional 

Enter the absolute path to the certificate file. 

Review the following example: 

tls:
  crt_file: /var/etc/kafka/crt_file

tls: key_file

Optional

Enter the absolute path to the private key file. 

Review the following example: 

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

tls: key_password

Optional

Enter the password for the key file. 

Review the following example: 

tls:
  key_password: p@ssword123

tls: client_auth_type

Optional 

Enter a client authorization type. 

You can enter:

  • noclientcert
  • requestclientcert
  • requireanyclientcert
  • verifyclientcertifgiven
  • requireandverifyclientcert

The default setting is noclientcert.

Review the following example: 

tls:
  client_auth_type: noclientcert

tls: min_version

Optional

Enter the minimum version of TLS to accept. 

Review the following example: 

tls:
  min_version: TLSv1_1

tls: max_version 

Optional

Enter the maximum version of TLS to accept. 

Review the following example: 

tls:
  max_version: TLSv1_3

features

Optional 

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

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

Review the following example: 

features: log,edac,metric,alert

buffer_ttl

Optional

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.

Review the following example: 

buffer_ttl: 2h

buffer_path

Optional

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.

Review the following example: 

buffer_path: /var/log/edgedelta/pushbuffer/

buffer_max_bytesize

Optional 

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.

Review the following example: 

buffer_max_bytesize: 100MB

 

Share this document