InfluxDB
InfluxDB is an open source time series database platform that lets users collect, process, and analyze data to optimize their infrastructure.
InfluxDB parameters and supported features in Nobl9
- General support:
- Release channel: Stable, Beta
- Connection method: Agent, Direct
- Replay and SLI Analyzer: Not supported
- Event logs: Supported
- Query checker: Not supported
- Query parameters retrieval: Not supported
- Timestamp cache persistence: Supported
- Query parameters:
- Query interval: 1 min
- Query delay: 1 min
- Jitter: 15 sec
- Timeout: 60 sec
- Agent details and minimum required versions for supported features:
- Plugin name: n9influxdb
- Query delay environment variable: INFLUXDB_QUERY_DELAY
- Timestamp cache persistence: 0.65.0
- Additional notes:
- No support for InfluxQL.
- Write queries in Flux instead. Flux queries are only validated against bucket name, params.n9time_start, params.n9time_stop
Authenticationβ
When configuring a Nobl9 agent or direct connection to InfluxDB, you need to provide the API Token and Organization ID.
You can create the API Token using the InfluxDB user interface (UI), the command-line interface (CLI), or the InfluxDB API. For detailed instructions, refer to the Create an API Token | InfluxDB documentation.
You can get your Organization ID from:
- The URL in the InfluxDB UI by looking for the
orgs
value, for example,http://localhost:8086/orgs/03a2bbf46249a000/...
- The Organization Settings in InfluxDBβs UI
- Click the organization name icon in your InfluxDB panel and go to the Organization Settings. You can copy the Organization ID to the clipboard.
For more details, refer to the View Organizations | InfluxDB documentation.
Adding InfluxDB as a data sourceβ
To ensure data transmission between Nobl9 and InfluxDB, it may be necessary to list Nobl9 IP addresses as trusted.
app.nobl9.com
instance:- 18.159.114.21
- 18.158.132.186
- 3.64.154.26
us1.nobl9.com
instance:- 34.121.54.120
- 34.123.193.191
- 34.134.71.10
- 35.192.105.150
- 35.225.248.37
- 35.226.78.175
- 104.198.44.161
You can add the InfluxDB data source using the direct or agent connection methods.
Direct connection methodβ
A direct connection to InfluxDB requires users to enter their credentials which Nobl9 stores safely.
Nobl9 Webβ
To set up this type of connection:
- Navigate to Integrations > Sources.
- Click .
- Click the required Source button.
- Choose Direct.
-
Select one of the following Release Channels:
- The
stable
channel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abeta
release. Use it to avoid crashes and other limitations. - The
beta
channel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel can change.
- The
-
Enter an InfluxDB URL (mandatory).
This is the Cluster URL which you can get by clicking the Account settings icon in the InfluxDB panel, and navigating to the Organization Settings. You can also copy and paste it from the address line of your browser after logging in to your InfluxDB account. -
Enter your InfluxDB API Token (mandatory).
For more details, refer to the Create an API Token | InfluxDB documentation. -
Enter your InfluxDB Organization ID (mandatory).
For more details, refer to the Authentication section above.
- Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. - Enter a Display Name.
You can enter a user-friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in InfluxDB integration for Query delay is
1 minute
.
infoChanging the Query delay may affect your SLI data. For more details, check the Query delay documentation. - The default value in InfluxDB integration for Query delay is
- Click Add Data Source
sloctlβ
- Create a YAML definition to set up a direct connection with InfluxDB. For this, refer to the following example:
apiVersion: n9/v1alpha
kind: Direct
metadata:
name: influx-d-b
displayName: InfluxDB Direct
project: default
spec:
description: Example InfluxDB Direct
releaseChannel: stable
influxdb:
url: https://us-west-2-2.aws.cloud2.influxdata.com
apiToken: "[secret]"
organizationID: my-org
queryDelay:
value: 2
unit: Minute
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . β’ Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. β’ Must be a number less than 1440 minutes (24 hours). β’ Check query delay documentation for default unit of query delay for each source. |
logCollectionEnabled optional | boolean | Optional. Defaults to false . Set to true if you'd like your direct to collect event logs. Contact us to activate it. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
Source-specific fields | ||
influxDB.url mandatory | string | The Cluster URL which you can get by clicking the Account settings icon in the InfluxDB panel, and navigating to the Organization settings. You can also copy and paste it from the address line of your browser after logging in to your InfluxDB account. |
influxDB.organizationID mandatory | string, secret | See authentication section above for more details. |
influxDB.apiToken mandatory | string, secret | See authentication section above for more details. |
- Apply your YAML definition using the
sloctl apply
command.
Agent connection methodβ
Nobl9 Webβ
Follow the instructions below to set up an agent connection.
- Navigate to Integrations > Sources.
- Click .
- Click the required Source button.
- Choose Agent.
-
Select one of the following Release Channels:
- The
stable
channel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abeta
release. Use it to avoid crashes and other limitations. - The
beta
channel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel can change.
- The
-
Add the InfluxDB URL to connect to your data source.
- Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. - Enter a Display Name.
You can enter a user-friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in InfluxDB integration for Query delay is
1 minute
.
infoChanging the Query delay may affect your SLI data. For more details, check the Query delay documentation. - The default value in InfluxDB integration for Query delay is
- Click Add Data Source
- Deploy your agent in a Kubernetes cluster or Docker container.
sloctlβ
- Create a YAML definition to set up an agent connection with InfluxDB. For this, refer to the following example:
apiVersion: n9/v1alpha
kind: Agent
metadata:
name: influx-d-b
displayName: InfluxDB Agent
project: default
spec:
description: Example InfluxDB Agent
releaseChannel: stable
influxdb:
url: https://us-west-2-2.aws.cloud2.influxdata.com
queryDelay:
value: 2
unit: Minute
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . β’ Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. β’ Must be a number less than 1440 minutes (24 hours). β’ Check query delay documentation for default unit of query delay for each source. |
logCollectionEnabled optional | boolean | Optional. Defaults to false . Set to true if you'd like your direct to collect event logs. Contact us to activate it. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
Source-specific fields | ||
influxDB.url mandatory | string | The Cluster URL which you can get by clicking the Account settings icon in the InfluxDB panel, and navigating to the Organization settings. You can also copy and paste it from the address line of your browser after logging in to your InfluxDB account. |
- Apply your YAML definition using the
sloctl apply
command. - Deploy your agent in a Kubernetes cluster or Docker container.