Collecting Service Interconnect edge gateway metrics

Edit online

Flow collectors gather network traffic metrics for Red Hat® Service Interconnect® gateways within a network segment. To gather metrics for a network segment, only one flow collector must be installed for the segment.

Installing a flow collector for a network segment

The flow collector is automatically installed with the first Service Interconnect edge gateway that is deployed in the network segment. To avoid duplication of metrics, only one flow collector is installed for each network segment.

When subsequent gateways are deployed, the Mesh Manager checks whether a flow collector is already installed for a gateway in the network segment. If a flow collector is already installed, the collector is not installed for the new gateway.

Checking whether metrics collection is enabled for a network segment

You can check whether metrics collection is enabled by using the Mesh console or the CLI.

Checking by using the Mesh console

To check whether metrics collection is enabled for a network segment, view the Metric collection field on the Network segments page in the Mesh console.

To check which gateway in the network segment has the active flow collector, click a network segment to go to the Network Segment details page. Then view the Metric collection field on the Gateways tab.

Checking by using the CLI

To check whether metrics collection is enabled for a network segment, run the following command:

palmctl get networksegment --name <network-segment-name>

If metrics collection is enabled, the following information is shown in the command output:

flow_collector: true

To check whether a flow collector is installed for a specific gateway, run the following command:

palmctl get gateway --name <gateway-name>

If the flow collector is installed, "flow_collector":true is shown in the site_configuration field. For example:

...
site_configuration: '{"ingress":"","ingress_host":"","router_ingress_host":"","controller_ingress_host":"","ingress_annotations":"",
                      "flow_collector":true,"console":false,"router_console":false,...'

Deleting the gateway with the flow collector

If you delete the gateway with the active flow collector, metrics collection is disabled for the network segment. An event message like the following example is shown on the Events page in the Mesh console:

FlowCollectorDeletedEvent - A Skupper GW with the Flow Collector enabled was uninstalled for tenant <tenant_name> in <network_segment_name>. 
Devops need to check if any of the gateways in the network segment have Flow Collector running and if not 
they need to undeploy and redeploy a skupper GW gateway in this network segment to recreate a new Flow Collector.

Enabling metrics collection

If metrics collection is disabled for a network segment, you can enable collection again by deploying a gateway in the network segment. You can delete an existing gateway and deploy it again or deploy a new gateway.

When the gateway is deployed, the Mesh Manager detects that none of the gateways in the network segment have an active flow collector. The Mesh Manager automatically installs the flow collector for the new gateway and enables the collection of metrics for the network segment. The FlowCollectorDeletedEvent event is cleared from the Events page.

For more information about deploying gateways, see Connecting applications with the Mesh console and Connecting applications with the Mesh CLI.