Chapter 4. Monitoring and logging with Azure Kubernetes Services (AKS) in Red Hat Developer Hub

Helm deployment

To annotate the backstage pod for monitoring, update your values.yaml file as follows:

upstream:
  backstage:
    # --- TRUNCATED ---
    podAnnotations:
      prometheus.io/scrape: 'true'
      prometheus.io/path: '/metrics'
      prometheus.io/port: '9464'
      prometheus.io/scheme: 'http'

Copy to Clipboard Toggle word wrap

Operator-backed deployment

Procedure

1. As an administrator of the operator, edit the default configuration to add Prometheus annotations as follows:

   # Update OPERATOR_NS accordingly
   OPERATOR_NS=rhdh-operator
   kubectl edit configmap backstage-default-config -n "${OPERATOR_NS}"

   Copy to Clipboard Toggle word wrap

2. Find the deployment.yaml key in the ConfigMap and add the annotations to the spec.template.metadata.annotations field as follows:

   deployment.yaml: |-
     apiVersion: apps/v1
     kind: Deployment
     # --- truncated ---
     spec:
       template:
         # --- truncated ---
         metadata:
           labels:
            rhdh.redhat.com/app:  # placeholder for 'backstage-<cr-name>'
           # --- truncated ---
           annotations:
             prometheus.io/scrape: 'true'
             prometheus.io/path: '/metrics'
             prometheus.io/port: '9464'
             prometheus.io/scheme: 'http'
     # --- truncated ---

   Copy to Clipboard Toggle word wrap
3. Save your changes.

Procedure

View live logs from your Developer Hub instance

1. Navigate to the Azure Portal.
2. Search for the resource group <your-ResourceGroup> and locate your AKS cluster <your-Cluster>.
3. Select Kubernetes resources Workloads from the menu.
4. Select the <your-rhdh-cr>-developer-hub (in case of Helm Chart installation) or <your-rhdh-cr>-backstage (in case of Operator-backed installation) deployment.
5. Click Live Logs in the left menu.

6. Select the pod.

   Note

   There must be only single pod.

Live log data is collected and displayed.

View real-time log data from the Container Engine

1. Navigate to the Azure Portal.
2. Search for the resource group <your-ResourceGroup> and locate your AKS cluster <your-Cluster>.
3. Select Monitoring Insights from the menu.
4. Go to the Containers tab.
5. Find the backend-backstage container and click it to view real-time log data as it’s generated by the Container Engine.