2.15. telegraf¶
Note
requires a Product License.
Telegraf configuration.
vsr running config# vrf <vrf> kpi telegraf
2.15.1. enabled (pushed)¶
Enable or disable telegraf.
vsr running config# vrf <vrf> kpi telegraf
vsr running telegraf# enabled true|false
- Default value
true
2.15.2. interval¶
Default data collection interval in seconds.
vsr running config# vrf <vrf> kpi telegraf
vsr running telegraf# interval <uint16>
- Default value
10
2.15.3. influxdb-output¶
Configure an InfluxDB v1.x server.
vsr running config# vrf <vrf> kpi telegraf
vsr running telegraf# influxdb-output url <influxdb-output> database <string> \
... username <string> password <string> insecure-skip-verify
|
Description |
|---|---|
<udp-url> |
An UDP URL. |
<http-url> |
An HTTP(S) URL. |
database (mandatory)¶
The target database for metrics (telegraf will create it if not exists).
database <string>
username¶
The username to connect to InfluxDB.
username <string>
password¶
The password to connect to InfluxDB.
password <string>
insecure-skip-verify¶
Use SSL but skip chain and host verification.
insecure-skip-verify
2.15.4. influxdbv2-output¶
Configure an InfluxDB v2 server.
vsr running config# vrf <vrf> kpi telegraf
vsr running telegraf# influxdbv2-output url <influxdbv2-output> token <string> \
... organization <string> bucket <string> insecure-skip-verify
|
Description |
|---|---|
<udp-url> |
An UDP URL. |
<http-url> |
An HTTP(S) URL. |
token (mandatory)¶
The InfluxDB v2 token. See https://docs.influxdata.com/influxdb/v2.0/security/tokens/view-tokens.
token <string>
organization (mandatory)¶
The name of the organization that owns the target bucket.
organization <string>
bucket (mandatory)¶
The name of the bucket to write data to.
bucket <string>
insecure-skip-verify¶
Use SSL but skip chain and host verification.
insecure-skip-verify
2.15.5. kafka-output¶
Configure a Kafka server.
vsr running config# vrf <vrf> kpi telegraf
vsr running telegraf# kafka-output broker <kafka-output> topic <string>
<kafka-output> |
A host port tuple. |
topic¶
The Kafka topic.
topic <string>
- Default value
telegraf
2.15.6. prometheus-client-output¶
Configure a Prometheus Client.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
<address> |
An IPv4 or IPv6 address. |
<port> |
A 16-bit port number used by a transport protocol such as TCP or UDP. |
metric-version¶
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 <uint8>
basic-username¶
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>
basic-password¶
Password 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-password <string>
expiration-interval¶
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 |
|---|---|
<uint32> |
No description. |
none |
The expiration interval is unset. There is no expiration. |
path¶
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
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¶
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¶
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 |
|---|---|
<ipv4-prefix> |
An IPv4 prefix: address and CIDR mask. |
<ipv6-prefix> |
An IPv6 prefix: address and CIDR mask. |