Installing service monitors

Service monitors help you monitor the health of specific services that are installed on top of IBM Software Hub. Service monitors are not installed by default when you install IBM Software Hub.

Who needs to complete this task?

To complete this task, you must have one of the following roles:

  • Cluster administrator
  • Instance administrator
When do you need to complete this task?

Complete this task if you want to add service monitors to your IBM Software Hub deployment.

Repeat as needed Repeat this task for each instance of IBM Software Hub where you want to use service monitors.

Repeat as needed Repeat this task after you upgrade an instance of IBM Software Hub to get any new service monitors.

Before you begin

Best practice: You can run the commands in this task exactly as written if you set up environment variables. For instructions, see Setting up installation environment variables.

Ensure that you source the environment variables before you run the commands in this task.

About this task

Run the apply-service-monitor command to install the service monitors for an instance of IBM Software Hub.

The following table specifies which services provide monitors:

Service Monitors
AI Factsheets The AI Factsheets service provides a health check monitor.
Analytics Engine powered by Apache Spark The Analytics Engine powered by Apache Spark service provides a health check monitor.
The monitor includes additional checks to ensure:
  • The service can connect to the Spark database
  • Spark instances are created as expected
  • Spark instances are deleted as expected
  • Spark kernels are created as expected
  • Spark kernels are deleted as expected
  • The Spark history server was started as expected
  • The Spark history server was stopped as expected
Cognos Analytics The Cognos Analytics service provides a health check monitor.
Cognos Dashboards The Cognos Dashboards service provides a health check monitor.
Data Gate The Data Gate service provides a health check monitor.
Data Privacy The Data Privacy service provides a health check monitor.

The monitor includes an additional check to ensure that the dataprivacy pods started successfully.
Data Product Hub No service monitors are available.
Data Refinery The Data Refinery service provides a health check monitor.

The monitor includes an additional check to ensure that the datarefinery pods started successfully.
Data Replication The Data Replication service provides a health check monitor.

The monitor includes an additional check to ensure the health and availability of the Replication API.
DataStage The DataStage service provides a health check monitor.
Data Virtualization

You do not need to run the apply-service-monitor command to install the health check monitor.

The health check monitor for Data Virtualization is automatically installed when you install the service.

The monitor includes additional checks to ensure:
  • The Db2 Big SQL components are running.
  • The data virtualization engine is running.
  • The file system in the pod that manages the caching storage is healthy.
  • The persistent volume that is used by the head pod has sufficient capacity.
Db2 No service monitors are available.
Db2 Big SQL

You do not need to run the apply-service-monitor command to install the monitors.

The health check monitor for Db2 Big SQL is automatically installed when you install the service.

The monitor includes additional checks to ensure:
  • The Db2 Big SQL components are running.
  • The persistent volume that is used by the head pod has sufficient capacity.
Db2 Data Management Console The Db2 Data Management Console service provides a health check monitor.

The monitor includes an additional check to ensure the health and availability of the embedded Redis data store.
Db2 Warehouse No service monitors are available.
Decision Optimization The Decision Optimization service provides a health check monitor.
The monitor includes additional checks to ensure the health and availability of:
  • The Decision Optimization user interface
  • The Decision Optimization API
  • The Decision Optimization Modeling Assistant API
EDB Postgres The EDB Postgres service provides a health check monitor.
Execution Engine for Apache Hadoop The Execution Engine for Apache Hadoop service provides a health check monitor.
IBM Knowledge Catalog No service monitors are available.
IBM Knowledge Catalog Premium The IBM Knowledge Catalog Premium service provides a health check monitor. The monitor includes additional checks to ensure that the inner AI models are running successfully.
IBM Knowledge Catalog Standard The IBM Knowledge Catalog Standard service provides a health check monitor. The monitor includes additional checks to ensure that the inner AI models are running successfully.
IBM Manta Data Lineage
  • 5.1.0 No service monitors are available.
  • 5.1.1 and later The IBM Manta Data Lineage service provides a health check monitor.
IBM Match 360 The IBM Match 360 service provides a health check monitor.
The monitor includes additional checks to ensure the health and availability of the following IBM Match 360 microservice components:
  • Configuration
  • Configuration user interface
  • Data
  • Entity maintenance user interface
  • Job
  • Matching
  • Model
IBM StreamSets No service monitors are available.
Informix

You do not need to run the apply-service-monitor command to install the health check monitor.

The health check monitor for Informix is automatically installed when you install the service.

The monitor includes additional checks for:
  • Database checkpoint statistics
  • Database sessions
  • Database memory use
  • Database disk space use (Dbspace)
MANTA Automated Data Lineage The MANTA Automated Data Lineage service provides a health check monitor.
The monitor includes additional checks to ensure the health and availability of:
  • The admin UI
  • The Artemis service
  • The Configuration service
  • The Dataflow service
  • The Flow Agent service
MongoDB The MongoDB service provides a health check monitor.
OpenPages The OpenPages service provides a health check monitor.
The monitor uses the OpenPages REST API to check:
  • The availability of the OpenPages service
  • The status of the database connection for internal and external databases
Orchestration Pipelines The Orchestration Pipelines service provides a health check monitor.
The monitor includes additional checks to ensure the health and availability of:
  • The orchestration platform API service.
  • The Pipelines UI
  • The translation service
Planning Analytics The Planning Analytics service provides a health check monitor.
Product Master The Product Master service provides a health check monitor.
RStudio® Server Runtimes The RStudio Server Runtimes service provides a health check monitor.

The monitor includes an additional check to ensure the health and availability of interactive RStudio runtimes.
SPSS Modeler The SPSS Modeler service provides a health check monitor.
The monitor includes additional checks to ensure that the following pods started successfully:
  • SPSS Modeler runtime pod
  • SPSS Modeler flow API pod
Synthetic Data Generator The Synthetic Data Generator service provides a health check monitor.

The monitor includes an additional check to ensure that the runtime pod started successfully.
Voice Gateway No service monitors are available.
Watson Discovery The Watson Discovery service provides a health check monitor.
Watson Machine Learning The Watson Machine Learning service provides a health check monitor.
The monitor includes additional checks to ensure the health and availability of the following services:
  • Deployment service
  • Repository service
  • Training service
Watson OpenScale The Watson OpenScale service provides a health check monitor.
Watson Speech services The Watson Speech services provide two service health check monitors:
  • A service health check monitor for Watson Speech to Text
  • A service health check monitor for Watson Text to Speech
Watson Studio The Watson Studio monitor checks the health and availability of the following components:
  • Machine learning user interface tools
  • Machine learning model visualization
  • Notebook user interface
  • Notebook user interface for rendering static HTML
  • Notebook management API
  • Notebook and script job execution API
Watson Studio Runtimes The Watson Studio Runtimes monitors are integrated with the Watson Studio monitor.

The monitor includes an additional check to ensure the health and availability of Jupyter Notebook and JupyterLab runtimes.
watsonx.ai™ The watsonx.ai service provides two service health check monitors:
  • A service health check for watsonx.ai.
    The monitor includes additional checks to ensure the health and availability of:
    • The UI and API for Prompt Lab
    • The UI and API for Tuning Studio
  • A service health check for inferencing.
    The monitor includes additional checks to ensure the health and availability of:
    • The router that connects Prompt Lab and Tuning Studio to the inference servers
    • The inference server for each installed large language model
watsonx Assistant The watsonx Assistant service provides a health check monitor.

The monitor includes additional checks to ensure the health and availability of:

  • The UI and API for watsonx Assistant
  • The watsonx Assistant installation infrastructure, specifically the availability of the required microservices and data stores
watsonx Code Assistant™ The watsonx Code Assistant service provides a health check monitor.

The monitor includes an additional check to ensure the health and availability of the code generation service.
watsonx Code Assistant for Red Hat® Ansible® Lightspeed The watsonx Code Assistant for Red Hat Ansible Lightspeed service provides a health check monitor.
The monitor includes additional checks to ensure the health and availability of the following services:
  • Code generation service
  • Code matching service
watsonx Code Assistant for Z The watsonx Code Assistant for Z service provides a health check monitor.

The monitor includes an additional check to ensure the health and availability of the code generation service.
watsonx Code Assistant for Z Code Explanation The watsonx Code Assistant for Z Code Explanation service provides a health check monitor.

The monitor includes an additional check to ensure the health and availability of the code explanation service.
watsonx.data™ The watsonx.data service provides a health check monitor.

The monitor includes additional checks to ensure the health and availability of:

  • The Presto engine
  • The EDB Postgres storage cluster
  • The Milvus database
watsonx.governance™ No service monitors are available.
watsonx™ Orchestrate
  • 5.1.0 No service monitors are available.
  • 5.1.1 and later The watsonx Orchestrate service provides a health check monitor.

    The monitor includes additional checks to ensure the health and availability of:

    • The watsonx Orchestrate custom resource
    • The watsonx Orchestrate service instance

The following table specifies the monitors that are provided by automatically installed dependencies:

Dependency Monitors
Canvas The Canvas component provides a health check monitor.
The monitor includes additional checks to ensure that the following pods started successfully:
  • Canvas flow user interface pod
  • Canvas flow API pod
Common core services The Common core services component provides monitor checks the health and availability of the following APIs:
  • Catalog Asset Management service API
  • Data source connection API
  • File operations and storage API
  • Global Search API
  • Job scheduler API
  • Platform notifications API
  • Project events tracking API
  • Project metadata API
  • Spaces API
  • User profile and entitlements API
Db2 as a service No service monitors are available.
Db2U No service monitors are available.
Redis The Redis component provides a health check monitor.

The monitor includes an additional check to ensure the health and availability of Redis deployments.

Procedure

  1. Log the cpd-cli in to the Red Hat OpenShift® Container Platform cluster: 
    ${CPDM_OC_LOGIN}
    Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
  2. Run the cpd-cli manage apply-service-monitor command to install the service monitors.
    IBM Entitled Registry
    x86-64 clusters
    cpd-cli manage apply-service-monitor \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--image_name=olm-utils-v3:${VERSION}
    ppc64le clusters
    cpd-cli manage apply-service-monitor \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--image_name=olm-utils-v3:${VERSION}.ppc64le
    s390x clusters
    cpd-cli manage apply-service-monitor \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--image_name=olm-utils-v3:${VERSION}.s390x
    Private container registry
    x86-64 clusters
    cpd-cli manage apply-service-monitor \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--image_prefix=${PRIVATE_REGISTRY_LOCATION}/cpopen/cpd \
--image_name=olm-utils-v3:${VERSION}
    ppc64le clusters
    cpd-cli manage apply-service-monitor \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--image_prefix=${PRIVATE_REGISTRY_LOCATION}/cpopen/cpd \
--image_name=olm-utils-v3:${VERSION}.ppc64le
    s390x clusters
    cpd-cli manage apply-service-monitor \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--image_prefix=${PRIVATE_REGISTRY_LOCATION}/cpopen/cpd \
--image_name=olm-utils-v3:${VERSION}.s390x

Results

The service monitors that you see on the Monitoring page depend on:
  • The services that are installed on IBM Software Hub
  • Whether the services that are installed provide monitors

For example, OpenPages provides a service monitor. However, if the OpenPages service is not installed, you will not see any events related to the OpenPages service health check monitor.

The service monitors run every 10 minutes. For example, the monitors will run at 10:00, 10:10, 10:20, and so on.