policy/frameworks/management/controller/config.zeek
- Management::Controller
Configuration settings for the cluster controller.
- Namespace:
Management::Controller
- Imports:
Summary
Redefinable Options
|
Whether the controller should auto-assign Broker listening ports to cluster nodes that need them and don’t have them explicitly specified in cluster configurations. |
|
The TCP start port to use for auto-assigning cluster node listening
ports, if |
|
Whether the controller should auto-assign metrics ports for Prometheus to nodes that need them and don’t have them explicitly specified in their cluster configurations. |
|
The TCP start port to use for auto-assigning metrics exposition ports
for Prometheus, if |
The fallback listen port if |
|
The fallback listen port if |
|
An optional custom output directory for stdout/stderr. |
|
The network address the controller listens on for Broker clients. |
|
|
The network address the controller listens on for websocket clients. |
The network port the controller listens on for Broker clients. |
|
|
The network port the controller listens on for websocket clients. |
The name of this controller. |
|
The controller’s stderr log name. |
|
The controller’s stdout log name. |
|
The controller’s Broker topic. |
Constants
The name of the Broker store the controller uses to persist internal state to disk. |
Functions
Returns a |
|
Returns a |
|
Returns the effective name of the controller. |
|
Returns a |
|
Returns a |
Detailed Interface
Redefinable Options
- Management::Controller::auto_assign_broker_ports
-
Whether the controller should auto-assign Broker listening ports to cluster nodes that need them and don’t have them explicitly specified in cluster configurations.
- Management::Controller::auto_assign_broker_start_port
-
The TCP start port to use for auto-assigning cluster node listening ports, if
Management::Controller::auto_assign_broker_portsis enabled (the default) and nodes don’t come with those ports assigned.
- Management::Controller::auto_assign_metrics_ports
-
Whether the controller should auto-assign metrics ports for Prometheus to nodes that need them and don’t have them explicitly specified in their cluster configurations.
- Management::Controller::auto_assign_metrics_start_port
-
The TCP start port to use for auto-assigning metrics exposition ports for Prometheus, if
Management::Controller::auto_assign_metrics_portsis enabled (the default).
- Management::Controller::default_port
-
The fallback listen port if
Management::Controller::listen_portremains empty. When set to 0/unknown, the controller won’t listen for Broker connections. Don’t do this if your management agents connect to the controller (instead of the default other way around), as they require Broker connectivity.
- Management::Controller::default_port_websocket
-
The fallback listen port if
Management::Controller::listen_port_websocketremains empty. When set to 0/unknown, the controller won’t listen for websocket clients.
- Management::Controller::directory
-
An optional custom output directory for stdout/stderr. Agent and controller currently only log locally, not via the Zeek cluster’s logger node. This means that if both write to the same log file, output gets garbled.
- Management::Controller::listen_address
-
The network address the controller listens on for Broker clients. By default this uses the ZEEK_CONTROLLER_ADDR environment variable, but you may also redef to a specific value. When empty, the implementation falls back to
Management::default_address.
- Management::Controller::listen_address_websocket
-
The network address the controller listens on for websocket clients. By default this uses the ZEEK_CONTROLLER_WEBSOCKET_ADDR environment variable, but you may also redef to a specific value. When empty, the implementation falls back to
Management::default_address.
- Management::Controller::listen_port
-
The network port the controller listens on for Broker clients. Defaults to the ZEEK_CONTROLLER_PORT environment variable. When that is not set, the implementation falls back to
Management::Controller::default_port.
- Management::Controller::listen_port_websocket
-
The network port the controller listens on for websocket clients. Defaults to the ZEEK_CONTROLLER_WEBSOCKET_PORT environment variable. When that is not set, the implementation falls back to
Management::Controller::default_port_websocket.
- Management::Controller::name
-
The name of this controller. Defaults to the value of the ZEEK_CONTROLLER_NAME environment variable. When that is unset and the user doesn’t redef the value, the implementation defaults to “controller-<hostname>”.
- Management::Controller::stderr_file
-
The controller’s stderr log name. Like
Management::Controller::stdout_file, but for the stderr stream.
- Management::Controller::stdout_file
-
The controller’s stdout log name. If the string is non-empty, Zeek will produce a free-form log (i.e., not one governed by Zeek’s logging framework) in the controller’s working directory. If left empty, no such log results.
Note that the controller also establishes a “proper” Zeek log via the
Management::Logmodule.
- Management::Controller::topic
-
The controller’s Broker topic. Clients send requests to this topic.
Constants
- Management::Controller::store_name
- Type:
- Default:
"controller"
The name of the Broker store the controller uses to persist internal state to disk.
Functions
- Management::Controller::endpoint_info
- Type:
Returns a
Broker::EndpointInforecord describing the controller’s Broker connectivity.
- Management::Controller::endpoint_info_websocket
- Type:
Returns a
Broker::EndpointInforecord describing the controller’s websocket connectivity.
- Management::Controller::get_name
-
Returns the effective name of the controller.
- Management::Controller::network_info
- Type:
Returns a
Broker::NetworkInforecord describing the controller’s Broker connectivity.
- Management::Controller::network_info_websocket
- Type:
Returns a
Broker::NetworkInforecord describing the controller’s websocket connectivity.