base/frameworks/telemetry/options.zeek

Telemetry

Configurable settings for the Telemetry framework.

These reside separately from the main framework so that they can be loaded in bare mode without all of the framework. This allows things like the plugins.hooks test to see the options without needing the rest.

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. The default value means Zeek won’t expose the port.