Monitoring the API Connect cluster on Cloud Pak for Integration

Monitor the status of the API Connect cluster on Cloud Pak for Integration using either the command line or the IBM Cloud Pak Platform UI.

In Cloud Pak for Integration, the API Management capability is provide by API Connect. You deploy the API Connect subsystems on Cloud Pak for Integration with the APIConnect operator and the apiconnectcluster CR. The CR contains a status section that is regularly updated by the operator to display the current status of the all the API Connect subsystems.

When you finish deploying API Connect, you can monitor the status of apiconnectcluster using the command line or the OpenShift web console.

Note: You can also monitor the disk usage of Postgres microservices. The APIConnect operator continuously tracks the disk usage of postgres microservices and provides useful information in the ManagementCluster custom resource. For information on viewing the postgres disk status, see Monitoring Postgres disk usage on Cloud Pak for Integration.

Monitoring the API Connect cluster using the command line

Run the following command to display the status of the API Connect cluster:

oc get apiconnectcluster -n <APIC_namespace>

The response looks like the following example:

NAME         READY   STATUS   VERSION        RECONCILED VERSION   AGE
production   7/7     Ready    10.0.8.0      10.0.8.0-3323    24h

The following list explains the values in the response:

  • NAME: Name of the API Connect instance (in the example, the instance name is "production").
  • READY: Current number of subsystems and components that are running / Expected number of subsystems and components that should be running.
  • STATUS: Current status of API Connect.

    If the status says Warning, then run oc describe apiconnectcluster -n <namespace> and check for more details in the Status sections.

  • VERSION: API Connect version specified in the CR's spec.version setting.
  • RECONCILED VERSION: Current API Connect version.
  • AGE: Age of the apiconnectcluster CR.

Monitoring the API Connect cluster using the Platform UI

  1. Start the Platform UI.
  2. Click the Integration instances tab.
  3. Locate the "API Connect" capability that uses the instance name that you specified as the Name during installation.

    A healthy API Connect deployment displays "Ready" in the Status column

    Instances list on the Platform UI page
  4. Click the status value to display information about the current conditions, as in the following image:
    Conditions for the API Connect Cluster

    A healthy deployment displays "True" for the "Ready" status.

    During a fresh install, an upgrade or a day-2 operation (such as a Management backup S3 configuration change), the apiconnectcluster CR status might change to a different state depending on the action, but ultimately it should always reach the Ready status.