policy/frameworks/cluster/experimental.zeek

Cluster::Experimental

Experimental features of the Cluster framework.

Namespace:

Cluster::Experimental

Imports:

base/frameworks/cluster

Summary

Redefinable Options

Cluster::Experimental::cluster_started_topic: string &redef

The topic to which the cluster_started() event is published.

Events

Cluster::Experimental::cluster_started: event

When using broker-enabled cluster framework, this event will be broadcasted from the manager once all nodes reported that they have set up all their outgoing connections to other cluster nodes based on the given cluster layout.

Cluster::Experimental::node_fully_connected: event

When using broker-enabled cluster framework, this event will be sent to the manager and raised locally, once a cluster node has successfully conducted cluster-level handshakes for all its outgoing connections to other cluster nodes based on the given cluster layout.

Detailed Interface

Redefinable Options

Cluster::Experimental::cluster_started_topic
Type:

string

Attributes:

&redef

Default:

"zeek/cluster/experimental/started"

The topic to which the cluster_started() event is published.

Events

Cluster::Experimental::cluster_started
Type:

event ()

When using broker-enabled cluster framework, this event will be broadcasted from the manager once all nodes reported that they have set up all their outgoing connections to other cluster nodes based on the given cluster layout.

For non-Broker cluster backends, this event is published when all nodes in a cluster have sent node_fully_connected() to the manager.

Warning

There is no tracking of cluster node connectivity. Thus, there is no guarantee that all peerings still exist at the time of this event being raised.

Cluster::Experimental::node_fully_connected
Type:

event (name: string, id: string, resending: bool)

When using broker-enabled cluster framework, this event will be sent to the manager and raised locally, once a cluster node has successfully conducted cluster-level handshakes for all its outgoing connections to other cluster nodes based on the given cluster layout.

For non-Broker cluster backends, this event is published by a node once it has received Cluster::node_up() from all other nodes in a cluster.

Parameters:
  • name – The name of the now fully connected node.

  • id – The identifier of the now fully connected node.

  • resending – If true, the node has previously signaled that it is fully connected. This may happen in case the manager restarts.

Warning

There is no tracking of cluster node connectivity. Thus, there is no guarantee that all peerings still exist at the time of this event being raised.