3.2.19. telegraf¶
Note
requires a Product License.
Telegraf configuration.
vsr running config# vrf <vrf> kpi telegraf
enabled (pushed)¶
Enable or disable telegraf.
vsr running config# vrf <vrf> kpi telegraf
vsr running telegraf# enabled true|false
- Default value
true
interval¶
unit: seconds
Default data collection interval in seconds.
vsr running config# vrf <vrf> kpi telegraf
vsr running telegraf# interval <2-65535>
- Default value
10
elasticsearch-output¶
Configure an Elasticsearch server.
vsr running config# vrf <vrf> kpi telegraf elasticsearch-output url <elasticsearch-output>
|
Description |
|---|---|
|
An UDP URL. |
|
An IPv6 UDP URL. |
|
An HTTP(S) URL. |
|
An IPv6 HTTP(S) URL. |
index-name¶
The target index of the metrics Usually <static_index_name> or <dynamic_index_name>-%Y.%m.%d Refer to: https://github.com/influxdata/ telegraf/blob/master/plugins/outputs/elasticsearch/README.md#configura tion for more information.
vsr running config# vrf <vrf> kpi telegraf elasticsearch-output url <elasticsearch-output>
vsr running elasticsearch-output url <elasticsearch-output># index-name <string>
- Default value
telegraf-%Y.%m.%d
tls-ca-certificate¶
The CA certificate to enable TLS.
vsr running config# vrf <vrf> kpi telegraf elasticsearch-output url <elasticsearch-output>
vsr running elasticsearch-output url <elasticsearch-output># tls-ca-certificate <string>
tls-certificate¶
The certificate to enable TLS.
vsr running config# vrf <vrf> kpi telegraf elasticsearch-output url <elasticsearch-output>
vsr running elasticsearch-output url <elasticsearch-output># tls-certificate <string>
insecure-skip-verify¶
Use SSL but skip chain and host verification.
vsr running config# vrf <vrf> kpi telegraf elasticsearch-output url <elasticsearch-output>
vsr running elasticsearch-output url <elasticsearch-output># insecure-skip-verify
influxdb-output¶
Configure an InfluxDB v1.x server.
vsr running config# vrf <vrf> kpi telegraf influxdb-output url <influxdb-output>
|
Description |
|---|---|
|
An UDP URL. |
|
An IPv6 UDP URL. |
|
An HTTP(S) URL. |
|
An IPv6 HTTP(S) URL. |
database (mandatory)¶
The target database for metrics (telegraf will create it if not exists).
vsr running config# vrf <vrf> kpi telegraf influxdb-output url <influxdb-output>
vsr running influxdb-output url <influxdb-output># database <string>
username¶
The username to connect to InfluxDB.
vsr running config# vrf <vrf> kpi telegraf influxdb-output url <influxdb-output>
vsr running influxdb-output url <influxdb-output># username <string>
insecure-skip-verify¶
Use SSL but skip chain and host verification.
vsr running config# vrf <vrf> kpi telegraf influxdb-output url <influxdb-output>
vsr running influxdb-output url <influxdb-output># insecure-skip-verify
influxdbv2-output¶
Configure an InfluxDB v2 server.
vsr running config# vrf <vrf> kpi telegraf influxdbv2-output url <influxdbv2-output>
|
Description |
|---|---|
|
An UDP URL. |
|
An IPv6 UDP URL. |
|
An HTTP(S) URL. |
|
An IPv6 HTTP(S) URL. |
organization (mandatory)¶
The name of the organization that owns the target bucket.
vsr running config# vrf <vrf> kpi telegraf influxdbv2-output url <influxdbv2-output>
vsr running influxdbv2-output url <influxdbv2-output># organization <string>
bucket (mandatory)¶
The name of the bucket to write data to.
vsr running config# vrf <vrf> kpi telegraf influxdbv2-output url <influxdbv2-output>
vsr running influxdbv2-output url <influxdbv2-output># bucket <string>
insecure-skip-verify¶
Use SSL but skip chain and host verification.
vsr running config# vrf <vrf> kpi telegraf influxdbv2-output url <influxdbv2-output>
vsr running influxdbv2-output url <influxdbv2-output># insecure-skip-verify
kafka-output¶
Configure a Kafka server.
vsr running config# vrf <vrf> kpi telegraf kafka-output broker <kafka-output>
|
A host port tuple. |
topic¶
The Kafka topic.
vsr running config# vrf <vrf> kpi telegraf kafka-output broker <kafka-output>
vsr running kafka-output broker <kafka-output># topic <string>
- Default value
telegraf
data-format¶
The data format to output.
vsr running config# vrf <vrf> kpi telegraf kafka-output broker <kafka-output>
vsr running kafka-output broker <kafka-output># data-format DATA-FORMAT
|
Description |
|---|---|
|
The Influx data format. |
|
The JSON data format. |
- Default value
json
tls-ca-certificate¶
The CA certificate to enable TLS.
vsr running config# vrf <vrf> kpi telegraf kafka-output broker <kafka-output>
vsr running kafka-output broker <kafka-output># tls-ca-certificate <string>
tls-certificate¶
The certificate to enable TLS.
vsr running config# vrf <vrf> kpi telegraf kafka-output broker <kafka-output>
vsr running kafka-output broker <kafka-output># tls-certificate <string>
insecure-skip-verify¶
Use SSL but skip chain and host verification.
vsr running config# vrf <vrf> kpi telegraf kafka-output broker <kafka-output>
vsr running kafka-output broker <kafka-output># insecure-skip-verify
prometheus-client-output¶
Configure a Prometheus Client.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
|
Description |
|---|---|
|
An IPv4 address. |
|
An IPv6 address. |
|
A 16-bit port number used by a transport protocol such as TCP or UDP. |
metric-version¶
The metric version that controls the mapping from Prometheus metrics into Telegraf metrics. Refer to https://github.com/influxdata/telegraf /tree/master/plugins/inputs/prometheus.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
vsr running prometheus-client-output address <address> port <port># metric-version <1-2>
basic-username¶
The username for HTTP Basic Authentication.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
vsr running prometheus-client-output address <address> port <port># basic-username <string>
expiration-interval¶
unit: seconds
Expiration interval for each metric. When set to 0, no expiration.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
vsr running prometheus-client-output address <address> port <port># expiration-interval EXPIRATION-INTERVAL
|
Description |
|---|---|
|
No description. |
|
The expiration interval is unset. There is no expiration. |
path¶
The path to publish the metrics on.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
vsr running prometheus-client-output address <address> port <port># path PATH
|
An endpoint path (ex: /<seq1>/<seq2>/…). |
string-as-label¶
Send string metrics as Prometheus labels.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
vsr running prometheus-client-output address <address> port <port># string-as-label true|false
tls-certificate-name¶
The certificate to enable TLS.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
vsr running prometheus-client-output address <address> port <port># tls-certificate-name <string>
tls-allowed-ca-certificate¶
The client CA certificates to enable mutually authenticated TLS connections.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
vsr running prometheus-client-output address <address> port <port># tls-allowed-ca-certificate <string>
export-timestamp¶
Export metric collection time.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
vsr running prometheus-client-output address <address> port <port># export-timestamp true|false
ip-range¶
IP ranges allowed to access metrics.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
vsr running prometheus-client-output address <address> port <port># ip-range IP-RANGE
|
Description |
|---|---|
|
An IPv4 prefix: address and CIDR mask. |
|
An IPv6 prefix: address and CIDR mask. |