close

keyboard_arrow_left

Table of Contents Expand all

list Table of Contents

English

Configurable Categories of Metrics Collection and Reporting (Tech Preview)

date_range 09-Jan-23

SUMMARY In Juniper® Cloud-Native Contrail Networking (CN2) Release 22.2, you can enable and disable selected metrics for exporting.

Overview: Configurable Categories of Metrics Collection and Reporting

To provide more flexibility in the telemetry export component, CN2 Release 22.2 introduces a new Kubernetes custom resource: MetricGroup. MetricGroup allows you to enable or disable selected metrics for exporting.

MetricGroup contains and manages a set of metrics for exporting.
Metrics are grouped by their category. You can choose to enable or disable the metric export function at the group level.
MetricGroup is implemented through a Kubernetes custom resource.

MetricGroup provides fine-grained control on which metrics the system collects and reports. You can turn on and off a subset of metrics reporting. At times, you may want to collect only a subset of metrics for efficiency and the lightest weight deployment possible.

Note:

This feature is classified as a Juniper CN2 Technology Preview feature. These features are "as is" and are for voluntary use. Juniper Support will attempt to resolve any issues that customers experience when using these features and create bug reports on behalf of support cases. However, Juniper may not provide comprehensive support services to Tech Preview features.

For additional information, see Juniper CN2 Technology Previews (Tech Previews) or contact Juniper Support.

Figure 1: Metrics Collection and Reporting Architecture

Telemetry Operator, see Figure 1, monitors any change of metric groups. Based on the enabled metric groups, a list of enabled metrics is created and sent in the form of ConfigMap to metric export agents. Metric export agents collect and export these enabled metrics, instead of all metrics on the system.

The MetricGroup reconciler builds a ConfigMap for each type of metric (vrouter or controller) from the enabled MetricGroup(s) and applies the ConfigMap to all clusters.
The kube-manager reconciler does the same for a new cluster.

Telemetry Exporter combines metric specifications with this ConfigMap to create enabled metric specifications. The metric export function only exports metrics from the enabled metric specifications, instead of all metrics.

The following items list the YAML values for ConfigMap and MetricGroup.

ConfigMap: vrouter-export-enabled-metrics

Revision number
Array of enabled metric names

Custom Resource: MetricGroup

Type: vrouter or controller
Name: String
Export: Boolean
Metrics: Array of strings (metric name)

Install and Upgrade

MetricGroup is included in the analytics component in CN2 Release 22.2. The predefined metric groups are automatically installed during the CN2 analytics deployment. See Install Contrail Analytics for Upstream Kubernetes or Install Contrail Analytics for OpenShift Container Platform.Install Contrail Analytics for Amazon EKS.

Example: Predefined Metric Group

content_copy zoom_out_map
Bgpaas​
Controller-bgp​
Controller-info​
Controller-peer​
Controller-xmpp​
Ermvpn​
Evpn​
Ipv4​
Ipv6​
Mvpn​
Vrouter-cpu​
Vrouter-info​
Vrotuer-inv6​
Vrouter-mem​
Vrouter-traffic​
Vrouter vmi

Example predefined MetricGroup: vrouter-cpu YAML file:

content_copy zoom_out_map
apiVersion: telemetry.juniper.net/v1alpha1
kind: MetricGroup
metadata:​
  name: vrouter-cpu​
  namespace: contrail-analytics​
spec:​
  export: true​
  metricType: VROUTER​
  metrics:​
  - virtual_router_cpu_1min_load_avg​
  - virtual_router_cpu_5min_load_avg​
  - virtual_router_cpu_15min_load_avg

Manage MetricGroup with Kubectl Commands

You (the administrator) can manage MetricGroup with kubectl commands. Examples follow.

To delete MetricGroup:

content_copy zoom_out_map
kubectl delete metricgroup ipv6 –n contrail-analytics

To apply MetricGroup:

content_copy zoom_out_map
kubectl apply –f <yaml file with metric group definition>

To view MetricGroup resource:

content_copy zoom_out_map
kubectl get metricgroup ipv4 –n contrail-analytics –oyaml

To verify the existence of ConfigMap(s) run the following command.

content_copy zoom_out_map
kubectl get cm –n contrail

Names of ConfigMap​
    controller-export-enabled-metrics
    vrouter-export-enabled-metrics

Each cluster has its own copy of the two ConfigMap(s); controller-export-enabled-metrics and vrouter-export-enabled-metrics.

Manage Metric Groups with UI

With this Tech Preview, you can manage MetricGroups using the CN2 Manager UI.

To manage Metric Groups in the UI:

Access the CN2 Manager UI from your browser:
https://<cluster-ip-address>/
Log in to CN2 Manager by either method:
- Browse and select a kubeconfig file to upload.
- Log in using a token.
From the left-navigation menu, select Configure > Metric Groups.
The Metric Groups window appears.
To add a Metric Group, click the "+" icon in the upper right.
Add the Name, select Type, and select the metrics to apply. Click Save.
Figure 2: Add a Metric Group
Click the detail icon to display the Metric Group you added.
Figure 3: Display Metric Group Detail

arrow_backward PREVIOUS Flow-Based Mirroring

NEXT arrow_forward Juniper CN2 Technology Previews (Tech Previews)

Cloud-Native Contrail Networking Feature Guide

ON THIS PAGE