Comment on page

Configuration

This section explains each of the properties in the configuration blade.
General
Property
Description
Collection
This associates the Agent to a specific Collection (default to that of the current Data Stream).
Polling Interval (seconds)

A timespan to specify how often should the Agent check for new data/changes or update its cache.
Refer to Collections and Stream Hosts to understand more about Collections.
Database
Once the URL, Token, and Org are entered, the Agent will attempt to connect with the InfluxDB Cloud. If successful, the Bucket is populated with a list of available buckets.
Property
Description
Use Connection Variables
Tick to select saved variables; or enter the text manually for the authentication properties.
URL
The address of the InfluxDB Cloud.
Token
The API token generated through InfluxDB Cloud.
Org
The user's workspace. Usually part of the URL address that identifies the workspace.
Bucket
The named location where time series data is persisted for the retention period.
Measurement
A container for tags, fields, and timestamps. Use a measurement name that describes your data.
Payload
Property
Description
Tags(Name, Type)
The Name and Type of each tag property, as they will appear in the output payload.
Fields(Name, Type)
The Name and Type of each field property, as they will appear in the output payload.
Data Filter
Rules to filter the returned time series data. As tags are indexed and fields are not, filtering on tags is more performant than on fields.
The attribute Name should combine words or use a _, rather than a space.
The attribute Type options for the output payload are String, Long, Double, Boolean, DateTime, or Integer.
Endpoints
Name
Description
Output
The read events will be made available on this Endpoint with attributes as per the Payload.
Error
Errors encountered during the execution of this Agent will be published on this endpoint.

Property	Description
Collection	This associates the Agent to a specific Collection (default to that of the current Data Stream).
Polling Interval (seconds)	A timespan to specify how often should the Agent check for new data/changes or update its cache.

Property	Description
Use Connection Variables	Tick to select saved variables; or enter the text manually for the authentication properties.
URL	The address of the InfluxDB Cloud.
Token	The API token generated through InfluxDB Cloud.
Org	The user's workspace. Usually part of the URL address that identifies the workspace.
Bucket	The named location where time series data is persisted for the retention period.
Measurement	A container for tags, fields, and timestamps. Use a measurement name that describes your data.

Property	Description
Tags(Name, Type)	The Name and Type of each tag property, as they will appear in the output payload.
Fields(Name, Type)	The Name and Type of each field property, as they will appear in the output payload.
Data Filter	Rules to filter the returned time series data. As tags are indexed and fields are not, filtering on tags is more performant than on fields.

Name	Description
Output	The read events will be made available on this Endpoint with attributes as per the Payload.
Error	Errors encountered during the execution of this Agent will be published on this endpoint.

CONTEXT PROVIDER - Previous

Example

Next - CONTEXT PROVIDER

Release Notes

Last modified 1yr ago