Enabling OpenShift Container Platform monitoring

Monitoring in IBM Cloud Pak® for Integration can be done using the OpenShift monitoring stack. To enable monitoring of user-defined projects, you must configure OpenShift Container Platform monitoring. To learn more about the OCP monitoring stack, see Monitoring Overview in the OpenShift documentation.

If you want to implement Grafana, install the community operator. You can then configure and upload your custom dashboard by using the example JSON in Dashboard examples. For more information, see Grafana Operator.

Enabling the OpenShift monitoring stack

To enable OpenShift to monitor your applications, follow these steps. When enabled, developers can run PromQL queries on application metrics in the OpenShift web console by switching to the Developer perspective and clicking Monitoring in the navigation menu.

To enable the OpenShift monitoring stack:

  1. Create the following ConfigMap, with enableUserWorkload: true:

    apiVersion: v1
kind: ConfigMap
metadata:
  name: cluster-monitoring-config
  namespace: openshift-monitoring
data:
  config.yaml: |
    enableUserWorkload: true

This ensures that OpenShift is configured for user-defined project monitoring. For more information, see the OpenShift documentation: Enabling monitoring for user-defined projects.

Dashboard samples

After you install the Grafana community operator and create a Grafana instance, you can manually import a JSON file to deploy your custom dashboard. The following sample configuration is intended to help you get started.

To configure a monitoring dashboard:

  1. Open the Grafana UI.

  2. Click the dashboard icon in the navigation panel.

  3. Click New and select + Import.

  4. Import a JSON file, using one of the dashboard examples.

Grafana dashboard samples are available on IBM GitHub, for the following instance types:

  • API management

  • Integration runtime

  • Kafka cluster

  • Enterprise gateway

  • High speed transfer server

  • Queue manager

The dashboards provide a monitoring view similar to the following Event Streams example:

Grafana dashboard example