base/frameworks/telemetry/options.zeek

Telemetry
Namespace

Telemetry

Summary

Redefinable Options

Telemetry::metrics_address: string &redef

Address used to make metric data available to Prometheus scrapers via HTTP.

Telemetry::metrics_endpoint_name: string &redef

ID for the metrics exporter.

Telemetry::metrics_port: port &redef

Port used to make metric data available to Prometheus scrapers via HTTP.

Detailed Interface

Redefinable Options

Telemetry::metrics_address
Type

string

Attributes

&redef

Default

""

Address used to make metric data available to Prometheus scrapers via HTTP.

Telemetry::metrics_endpoint_name
Type

string

Attributes

&redef

Default

""

ID for the metrics exporter. This is used as the ‘endpoint’ label value when exporting data to Prometheus. In a cluster setup, this defaults to the name of the node in the cluster configuration.

Telemetry::metrics_port
Type

port

Attributes

&redef

Default

0/unknown

Port used to make metric data available to Prometheus scrapers via HTTP.