Chapter 2. Metrics and Service Mesh

Procedure

1. Create a ServiceMonitor resource that monitors the Istio control plane, similar to the following example:

   apiVersion: monitoring.coreos.com/v1
   kind: ServiceMonitor
   metadata:
     name: istiod-monitor
     namespace: istio-system
   spec:
     targetLabels:
     - app
     selector:
       matchLabels:
         istio: pilot
     endpoints:
     - port: http-monitoring
       interval: 30s

   Copy to Clipboard Toggle word wrap

2. To validate that the ServiceMonitor resource is monitoring the Istio control plane, go to the OpenShift Console, navigate to Observe Metrics, and run the query istio_requests_total. Confirm that the metrics for the Istio request are displayed.

   Note

   The Metrics implementation can take a few minutes for the query to return results.

Procedure

1. Create a Service resource to define a port that uses the metrics exposed by the ztunnel, similar to the following example:

   apiVersion: v1
   kind: Service
   metadata:
     name: ztunnel
     namespace: ztunnel
     labels:
       app: ztunnel
       service: ztunnel
   spec:
     selector:
       app: ztunnel
     ports:
       - name: http-monitoring
         protocol: TCP
         port: 15020
         targetPort: 15020

   Copy to Clipboard Toggle word wrap

2. Create a ServiceMonitor resource that monitors the Istio control plane, similar to the following example:

   apiVersion: monitoring.coreos.com/v1
   kind: ServiceMonitor
   metadata:
     name: istiod-monitor
     namespace: istio-system
   spec:
     targetLabels:
     - app
     selector:
       matchLabels:
         istio: pilot
     endpoints:
     - port: http-monitoring
       interval: 30s

   Copy to Clipboard Toggle word wrap

3. Create a ServiceMonitor resource that collects the ztunnel metrics, similar to the following example:

   apiVersion: monitoring.coreos.com/v1
   kind: ServiceMonitor
   metadata:
     name: ztunnel-monitor
     namespace: ztunnel
   spec:
     targetLabels:
     - app
     selector:
       matchLabels:
         service: ztunnel
     endpoints:
     - port: http-monitoring
       interval: 30s

   Copy to Clipboard Toggle word wrap

4. Optional: Deploy a waypoint proxy to enable the Layer 7 (L7) OpenShift Service Mesh features in ambient mode:

   1. Deploy a custom waypoint proxy with additional labels and ports for the bookinfo namespace, similar to the following example:

       apiVersion: gateway.networking.k8s.io/v1
      kind: Gateway
      metadata:
        labels:
          istio.io/waypoint-for: service
          app: waypoint
          service: waypoint
        name: waypoint
        namespace: bookinfo
      spec:
        gatewayClassName: istio-waypoint
        listeners:
        - name: mesh
          port: 15008
          protocol: HBONE
        - name: http-monitoring
          protocol: TCP
          port: 15020

      Copy to Clipboard Toggle word wrap

      <http-monitoring>

      Specifies an additional port that exposes the metrics used by the waypoint proxy.

   2. Enroll the namespace to use the waypoint by running the following command:

      $ oc label namespace bookinfo istio.io/use-waypoint=waypoint

      Copy to Clipboard Toggle word wrap

   3. Create a ServiceMonitor resource that collects the waypoint proxy metrics for the bookinfo namespace, similar to the following example:

      apiVersion: monitoring.coreos.com/v1
      kind: ServiceMonitor
      metadata:
        name: waypoint-monitor
        namespace: bookinfo
      spec:
        targetLabels:
        - app
        selector:
          matchLabels:
            service: waypoint
        endpoints:
        - port: http-monitoring
          interval: 30s

      Copy to Clipboard Toggle word wrap
      Note

      A waypoint proxy generates Layer 4 (L4) and L7 metrics. It scopes these statistics by Envoy proxy functions. The Envoy statistic functions are described in Envoy proxy documentation, for example, Upstream connection, Listener, HTTP Connection Manager, TCP proxy, and Router.