3.2.20. 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
metrics¶
Telemetry exported metrics configuration.
vsr running config# vrf <vrf> kpi telegraf metrics
enabled¶
Enable or disable the metrics daemon.
vsr running config# vrf <vrf> kpi telegraf metrics
vsr running metrics# enabled true|false
- Default value
true
template¶
A template telling which metrics should be enabled by default.
vsr running config# vrf <vrf> kpi telegraf metrics
vsr running metrics# template TEMPLATE
|
Description |
---|---|
|
Disable all metrics. |
|
Enable recommended metrics. |
|
Enable all metrics. |
- Default value
default
monitored-interface¶
The list of interface that are monitored by network-nic-hw-info and network-nic-traffic-stats. If unset, the fast path ports are monitored.
vsr running config# vrf <vrf> kpi telegraf metrics
vsr running metrics# monitored-interface vrf <string> name <string>
|
The interface vrf. |
|
The interface name. |
metric¶
The configured metrics, overriding the template.
vsr running config# vrf <vrf> kpi telegraf metrics
vsr running metrics# metric <identityref> enabled true|false period <uint16>
|
The metric name. |
amazon-cloudwatch-output¶
Amazon CloudWatch connection options.
vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region>
|
The namespace for CloudWatch metrics. |
|
Description |
---|---|
|
Africa (Cape Town). |
|
Asia Pacific (Hong Kong). |
|
Asia Pacific (Hyderabad). |
|
Asia Pacific (Jakarta). |
|
Asia Pacific (Melbourne). |
|
Europe (Milan). |
|
Europe (Spain). |
|
Europe (Zurich). |
|
Middle East (Bahrain). |
|
Middle East (UAE). |
|
US East (Ohio). |
|
US East (North Virginia). |
|
US West (North California). |
|
US West (Oregon). |
|
Asia Pacific (Mumbai). |
|
Asia Pacific (Osaka). |
|
Asia Pacific (Seoul). |
|
Asia Pacific (Singapore). |
|
Asia Pacific (Sydney). |
|
Asia Pacific (Tokyo). |
|
Canada (Central). |
|
Europe (Frankfurt). |
|
Europe (Ireland). |
|
Europe (London). |
|
Europe (Paris). |
|
Europe (Stockholm). |
|
South America (São Paulo). |
write-statistics¶
Send statistic values instead of raw metrics.
vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region>
vsr running amazon-cloudwatch-output namespace <string> region <region># write-statistics true|false
high-resolution-metrics¶
Enable high resolution metrics of 1 second. If not enabled, standard resolution are of 60 seconds precision.
vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region>
vsr running amazon-cloudwatch-output namespace <string> region <region># high-resolution-metrics true|false
authentication¶
Amazon Cloudwatch authentication strategies.
vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region> authentication
ec2-authorized¶
The EC2 instance on which the product is running is is assigned an appropriate IAM role out of the product.
vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region> authentication
vsr running authentication# ec2-authorized
explicit-credentials¶
Explicit Credentials.
vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region> authentication explicit-credentials
access-key (mandatory)¶
The AWS access key identifier.
vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region> authentication explicit-credentials
vsr running explicit-credentials# access-key <string>
sts-credentials¶
Security Token Service credentials.
vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region> authentication sts-credentials
arn-role (mandatory)¶
The IAM (Identity and Access Management role assigned to an ARN (Amazon Resource Name).
vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region> authentication sts-credentials
vsr running sts-credentials# arn-role <string>
session-name¶
STS (Security Token Service) session name useful to identify the source of the request.
vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region> authentication sts-credentials
vsr running sts-credentials# session-name <string>
web-identity-token¶
A web identity token content in JSON format.
vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region> authentication sts-credentials
vsr running sts-credentials# web-identity-token <string>
elasticsearch-output¶
Elasticsearch connection options.
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
metric-pass-filter¶
KPI services with names matching this filter are passed. For example, fp-* will make all fast-path related metrics pass.
vsr running config# vrf <vrf> kpi telegraf elasticsearch-output url <elasticsearch-output>
vsr running elasticsearch-output url <elasticsearch-output># metric-pass-filter METRIC-PASS-FILTER
|
A glob pattern for metric filtering. |
metric-drop-filter¶
KPI services with names matching this filter are dropped. For example, fp-* will make all fast-path related metrics drop.
vsr running config# vrf <vrf> kpi telegraf elasticsearch-output url <elasticsearch-output>
vsr running elasticsearch-output url <elasticsearch-output># metric-drop-filter METRIC-DROP-FILTER
|
A glob pattern for metric filtering. |
graphite-output¶
Graphite connection options.
vsr running config# vrf <vrf> kpi telegraf graphite-output server <graphite-output>
|
A host port tuple. |
prefix¶
The prefix metrics name.
vsr running config# vrf <vrf> kpi telegraf graphite-output server <graphite-output>
vsr running graphite-output server <graphite-output># prefix <string>
metric-pass-filter¶
KPI services with names matching this filter are passed. For example, fp-* will make all fast-path related metrics pass.
vsr running config# vrf <vrf> kpi telegraf graphite-output server <graphite-output>
vsr running graphite-output server <graphite-output># metric-pass-filter METRIC-PASS-FILTER
|
A glob pattern for metric filtering. |
metric-drop-filter¶
KPI services with names matching this filter are dropped. For example, fp-* will make all fast-path related metrics drop.
vsr running config# vrf <vrf> kpi telegraf graphite-output server <graphite-output>
vsr running graphite-output server <graphite-output># metric-drop-filter METRIC-DROP-FILTER
|
A glob pattern for metric filtering. |
influxdb-output¶
InfluxDB v1.x connection options.
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
metric-pass-filter¶
KPI services with names matching this filter are passed. For example, fp-* will make all fast-path related metrics pass.
vsr running config# vrf <vrf> kpi telegraf influxdb-output url <influxdb-output>
vsr running influxdb-output url <influxdb-output># metric-pass-filter METRIC-PASS-FILTER
|
A glob pattern for metric filtering. |
metric-drop-filter¶
KPI services with names matching this filter are dropped. For example, fp-* will make all fast-path related metrics drop.
vsr running config# vrf <vrf> kpi telegraf influxdb-output url <influxdb-output>
vsr running influxdb-output url <influxdb-output># metric-drop-filter METRIC-DROP-FILTER
|
A glob pattern for metric filtering. |
influxdbv2-output¶
InfluxDB v2 connection options.
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
metric-pass-filter¶
KPI services with names matching this filter are passed. For example, fp-* will make all fast-path related metrics pass.
vsr running config# vrf <vrf> kpi telegraf influxdbv2-output url <influxdbv2-output>
vsr running influxdbv2-output url <influxdbv2-output># metric-pass-filter METRIC-PASS-FILTER
|
A glob pattern for metric filtering. |
metric-drop-filter¶
KPI services with names matching this filter are dropped. For example, fp-* will make all fast-path related metrics drop.
vsr running config# vrf <vrf> kpi telegraf influxdbv2-output url <influxdbv2-output>
vsr running influxdbv2-output url <influxdbv2-output># metric-drop-filter METRIC-DROP-FILTER
|
A glob pattern for metric filtering. |
kafka-output¶
Kafka connection options.
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
metric-pass-filter¶
KPI services with names matching this filter are passed. For example, fp-* will make all fast-path related metrics pass.
vsr running config# vrf <vrf> kpi telegraf kafka-output broker <kafka-output>
vsr running kafka-output broker <kafka-output># metric-pass-filter METRIC-PASS-FILTER
|
A glob pattern for metric filtering. |
metric-drop-filter¶
KPI services with names matching this filter are dropped. For example, fp-* will make all fast-path related metrics drop.
vsr running config# vrf <vrf> kpi telegraf kafka-output broker <kafka-output>
vsr running kafka-output broker <kafka-output># metric-drop-filter METRIC-DROP-FILTER
|
A glob pattern for metric filtering. |
prometheus-client-output¶
Prometheus client connection options.
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. |
metric-pass-filter¶
KPI services with names matching this filter are passed. For example, fp-* will make all fast-path related metrics pass.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
vsr running prometheus-client-output address <address> port <port># metric-pass-filter METRIC-PASS-FILTER
|
A glob pattern for metric filtering. |
metric-drop-filter¶
KPI services with names matching this filter are dropped. For example, fp-* will make all fast-path related metrics drop.
vsr running config# vrf <vrf> kpi telegraf prometheus-client-output address <address> port <port>
vsr running prometheus-client-output address <address> port <port># metric-drop-filter METRIC-DROP-FILTER
|
A glob pattern for metric filtering. |