Chapter 2. Enabling observability for Red Hat Developer Hub on OpenShift Container Platform

1. Create the ServiceMonitor CR as a YAML file:

   apiVersion: monitoring.coreos.com/v1
   kind: ServiceMonitor
   metadata:
     name: <developer_hub_service_monitor_name> 

   1

   
     namespace: <rhdh_namespace_name> 

   2

   
     labels:
       app.kubernetes.io/instance: <rhdh_cr_name> 

   3

   
       app.kubernetes.io/name: Backstage
   spec:
     namespaceSelector:
       matchNames:
         - <rhdh_namespace_name> 

   4

   
     selector:
       matchLabels:
         app.kubernetes.io/instance: <deployment_name> 

   5

   
         app.kubernetes.io/name: <rhdh_cr_type> 

   6

   
     endpoints:
     - port: http-metrics
       path: '/metrics'

   Copy to Clipboard Toggle word wrap

   1

   The name of your ServiceMonitor resource, for example, developer_hub_service_monitor.

   2

   The namespace where your ServiceMonitor will live, for example, my-rhdh-project.

   3

   The label name identifying the ServiceMonitor CR instance, for example, my-rhdh-custom-resource.

   4

   The namespace where your RHDH instance is installed, for example, my-rhdh-project.

   5

   The name of your RHDH deployment, for example, developer-hub.

   6

   The name of your RHDH application, for example, backstage.

   Note

   spec.selector.matchLabels configuration must match the labels of your RHDH installation.

2. Apply the ServiceMonitor CR by running the following command:

   oc apply -f <filename>

   Copy to Clipboard Toggle word wrap

Verification

1. From the Developer perspective in the OpenShift Container Platform web console, select the Observe view.
2. Click the Metrics tab to view metrics for Red Hat Developer Hub pods.
3. From the Developer perspective in the OpenShift Container Platform web console, click Project > Services and verify the labels for backstage-developer-hub.

Procedure

1. From the Developer perspective in the OpenShift Container Platform web console, select the Topology view.

2. Click the overflow menu of the Red Hat Developer Hub Helm chart, and select Upgrade.

   

   View larger image

   

3. On the Upgrade Helm Release page, select the YAML view option in Configure via, then configure the metrics section in the YAML, as shown in the following example:

   upstream:
   # ...
     metrics:
       serviceMonitor:
         enabled: true
         path: /metrics
         port: http-metrics
   # ...

   Copy to Clipboard Toggle word wrap
   

   View larger image

   
4. Click Upgrade.

Verification

1. From the Developer perspective in the OpenShift Container Platform web console, select the Observe view.
2. Click the Metrics tab to view metrics for Red Hat Developer Hub pods.