telemetry.zeek

Cluster::Telemetry

Namespace:: Cluster::Telemetry

Summary

Redefinable Options

`Cluster::Telemetry::core_metrics`: `set` `&redef`	The telemetry types to enable for the core backend.
`Cluster::Telemetry::message_size_bounds`: `vector` `&redef`	For the DEBUG metrics, the histogram buckets to use.
`Cluster::Telemetry::topic_normalizations`: `table` `&ordered` `&redef`	Table used for normalizing topic names that contain random parts.
`Cluster::Telemetry::websocket_metrics`: `set` `&redef`	The telemetry types to enable for WebSocket backends.

Types

Cluster::Telemetry::Type: enum

Module for cluster telemetry.

Detailed Interface

Redefinable Options

Cluster::Telemetry::core_metrics 

Type:

set [Cluster::Telemetry::Type]

Attributes:

&redef

Default:

{
   Cluster::Telemetry::INFO
}

The telemetry types to enable for the core backend.

Cluster::Telemetry::message_size_bounds 

Type:

vector of double

Attributes:

&redef

Default:

[10.0, 50.0, 100.0, 500.0, 1000.0, 5000.0, 10000.0, 50000.0]

For the DEBUG metrics, the histogram buckets to use.

Cluster::Telemetry::topic_normalizations 

Type:

table [pattern] of string

Attributes:

&ordered &redef

Default:

{
   [/^?(^zeek\/cluster\/nodeid\/.*)$?/] = "zeek/cluster/nodeid/__normalized__"
}

Redefinition:

from policy/frameworks/cluster/backend/zeromq/main.zeek

+=:

/^?(^zeek\.cluster\.nodeid\..*)$?/ = zeek.cluster.nodeid.__normalized__

Table used for normalizing topic names that contain random parts. Map to an empty string to skip recording a specific metric completely.

Cluster::Telemetry::websocket_metrics 

Type:

set [Cluster::Telemetry::Type]

Attributes:

&redef

Default:

{
   Cluster::Telemetry::INFO
}

The telemetry types to enable for WebSocket backends.

Types

Cluster::Telemetry::Type 

Type:

enum

Cluster::Telemetry::INFO: Creates counter metrics for incoming and for outgoing events without labels.

Cluster::Telemetry::VERBOSE: Creates counter metrics for incoming and outgoing events labeled with handler and normalized topic names.

Cluster::Telemetry::DEBUG: Creates histogram metrics using the serialized message size for events, labeled by topic, handler and script location (outgoing only).

Module for cluster telemetry.