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

Procedure

1. Use the OpenShift CLI (oc) to edit your existing Red Hat Developer Hub CR.

   $ oc edit Backstage <instance-name>

   Copy to Clipboard Toggle word wrap

2. In the CR, locate the spec field and add the monitoring configuration block.

   spec:
     monitoring:
       enabled: true

   Copy to Clipboard Toggle word wrap

3. Save the RHDH CR. The RHDH Operator detects the configuration and automatically creates the corresponding ServiceMonitor custom resource (CR).

   Note

   The Operator automatically configures the ServiceMonitor with the correct labels (app.kubernetes.io/instance and app.kubernetes.io/name) that match your Backstage CR. The ServiceMonitor will be named metrics-<cr-name>. No additional label configuration is required.

Verification

1. From 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 OpenShift Container Platform web console, click Project > Services and verify the labels for backstage-developer-hub.

Procedure

1. From 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.

   

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
   
4. Click Upgrade.

Verification

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