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

TEMPLATE values

Description

none

Disable all metrics.

default

Enable recommended metrics.

all

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>

<string>

The interface vrf.

<string>

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>

<identityref>

The metric name.

enabled

Enabled if true, else disabled.

enabled true|false

period

The period for this metric.

period <uint16>

amazon-cloudwatch-output

Amazon CloudWatch connection options.

vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region>

<string>

The namespace for CloudWatch metrics.

<region> values

Description

af-south-1

Africa (Cape Town).

ap-east-1

Asia Pacific (Hong Kong).

ap-south-2

Asia Pacific (Hyderabad).

ap-southeast-3

Asia Pacific (Jakarta).

ap-southeast-4

Asia Pacific (Melbourne).

eu-south-1

Europe (Milan).

eu-south-2

Europe (Spain).

eu-central-2

Europe (Zurich).

me-south-1

Middle East (Bahrain).

me-central-1

Middle East (UAE).

us-east-2

US East (Ohio).

us-east-1

US East (North Virginia).

us-west-1

US West (North California).

us-west-2

US West (Oregon).

ap-south-1

Asia Pacific (Mumbai).

ap-northeast-3

Asia Pacific (Osaka).

ap-northeast-2

Asia Pacific (Seoul).

ap-southeast-1

Asia Pacific (Singapore).

ap-southeast-2

Asia Pacific (Sydney).

ap-northeast-1

Asia Pacific (Tokyo).

ca-central-1

Canada (Central).

eu-central-1

Europe (Frankfurt).

eu-west-1

Europe (Ireland).

eu-west-2

Europe (London).

eu-west-3

Europe (Paris).

eu-north-1

Europe (Stockholm).

sa-east-1

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>
secret-key (mandatory) (hidden)

The AWS secret access key.

vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region> authentication explicit-credentials
vsr running explicit-credentials# secret-key <string>
security-token (hidden)

The security token for temporary credentials.

vsr running config# vrf <vrf> kpi telegraf amazon-cloudwatch-output namespace <string> region <region> authentication explicit-credentials
vsr running explicit-credentials# security-token <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>

<elasticsearch-output> values

Description

<udp4-url>

An UDP URL.

<udp6-url>

An IPv6 UDP URL.

<http4-url>

An HTTP(S) URL.

<http6-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

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

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>

<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

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

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>

<influxdb-output> values

Description

<udp4-url>

An UDP URL.

<udp6-url>

An IPv6 UDP URL.

<http4-url>

An HTTP(S) URL.

<http6-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>

password (hidden)

The password to connect to InfluxDB.

vsr running config# vrf <vrf> kpi telegraf influxdb-output url <influxdb-output>
vsr running influxdb-output url <influxdb-output># password <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

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

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>

<influxdbv2-output> values

Description

<udp4-url>

An UDP URL.

<udp6-url>

An IPv6 UDP URL.

<http4-url>

An HTTP(S) URL.

<http6-url>

An IPv6 HTTP(S) URL.

token (mandatory) (hidden)

The InfluxDB v2 token. See https://docs.influxdata.com/influxdb/v2.0/security/tokens/view-tokens.

vsr running config# vrf <vrf> kpi telegraf influxdbv2-output url <influxdbv2-output>
vsr running influxdbv2-output url <influxdbv2-output># token <string>

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

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

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>

<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

DATA-FORMAT values

Description

influx

The Influx data format.

json

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

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

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>

<address> values

Description

<ipv4-address>

An IPv4 address.

<ipv6-address>

An IPv6 address.

<port>

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>

basic-password (hidden)

The 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

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

EXPIRATION-INTERVAL values

Description

<uint32>

No description.

none

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

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

IP-RANGE values

Description

<ipv4-prefix>

An IPv4 prefix: address and CIDR mask.

<ipv6-prefix>

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

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

METRIC-DROP-FILTER

A glob pattern for metric filtering.