Monitoring Cloud Pak for Data objects by using labels

Administrators can use labels to set up alerts and monitor an OpenShift® cluster with the Red Hat® OpenShift monitoring stack.

For more information, see Understanding the monitoring stack in the Red Hat OpenShift documentation.

Labels

Labels contain identifying information and are used by selector queries or within selector sections in object definitions. The structure of keys and values is constrained in selectors. When a selector is used to match objects, it must satisfy all of the specified label constraints. Using labels, queries can be evaluated quickly, with optimized data structures and algorithms.

Learn more about Cloud Pak for Data labels:

Service level labels
Service instance labels
Environment labels
Job run labels
Space or project labels
User or owner labels

For more information, see Labels and Selectors in the Kubernetes documentation.

Mandatory labels

The following annotation strategy is used in Cloud Pak for Data:

Base Cloud Pak for Data and Cloud Pak for Data extensions appear as extensions that enclose other services.
Services appear as details under the top-level extensions.

Service level labels

The following service-specific labels are used by Platform Management, Resource Scheduling, and Serviceability to correlate and quantify Kubernetes resources.

icpdsupport/addOnId: Used to identify the owning service and corresponding resource quota.
icpdsupport/app: The service application, component, category, or function of the pod. Used to add pod identification or grouping and eventually extra resource quota granularity.

Service instance labels

To identify pods that are related to a service instance, this label is assigned to all deployments that are spun up as part of the service instance provisioning and the subsequent workloads in the service instance context.

icpdsupport/serviceInstanceId: The ID of the provisioned service instance.

Environment labels

To identify pods that are related to a common core services environment, these labels are assigned to the environment deployment.

icpdsupport/runtimeEnvId: The ID of the deployed environment.
icpdsupport/environmentType: The type of the deployed environment.

Job run labels

To identify pods that are related to a common core services job definition run, this label is assigned to all deployments spun up as part of the job run.

icpdsupport/jobRunId: The ID of the job definition run from /v2/jobs.

Space or project labels

To identify all pods that run in the context of a space or project, these labels are assigned to all deployments spun up in a space or project context.

icpdsupport/spaceId: The ID of the associated space.
icpdsupport/projectId: The ID of the associated project.

User or owner labels

In the context of service instance, environment, and job dynamic workloads, this label identifies the Cloud Pak for Data user that is associated with or created by the workload. This label allows pods to be correlated to a specific UserId.

icpdsupport/createdBy: ID of the associated Cloud Pak for Data owner of the dynamic workload in the context of service instance, environment, or job. Value is the Cloud Pak for Data user ID. For example, 1000331001.

Cloud Pak for Data labels

The following labels are assigned in Cloud Pak for Data.

Labels

icpdsupport/addOnId: ID of the service entry in the Cloud Pak for Data add_ons.json extension. Used to identify the owning service and corresponding resource quota.; Example: icpdsupport/addOnId=streams
icpdsupport/app: Service application, component, category, or function of the pod. Used to add pod identification or grouping and also extra resource quota granularity.; Example: icpdsupport/app=Jupyter
icpdsupport/serviceInstanceId: ID of the provisioned service instance.; Example: icpdsuppt/serviceInstanceId=1596846138338411
icpdsupport/runtimeEnvId: ID of the deployed environment.; Example: icpdsupport/runtimeEnvId=1234567-abde-1234-abcde-123456789012
icpdsupport/environmentType: Type of deployed environment.; Example: icpdsupport/environmentType=Python
icpdsupport/jobRunId: ID of the job definition run from /v2/jobs. Replaces icpdsupport/jobId.; Example: icpdsupport/jobRunId=1234567-abde-1234-abcde-123456789012
icpdsupport/spaceId: ID of the associated space.; Example: icpdsupport/projectId=1234567-abde-1234-abcde-123456789012
icpdsupport/projectId: ID of the associated project.; Example: icpdsupport/spaceId=1234567-abde-1234-abcde-123456789012
icpdsupport/createdBy: ID of the associated Cloud Pak for Data owner of the dynamic workload in the context of Service Instance, Environment, or Job. Value should be the Cloud Pak for Data User ID. For example, 1000331001. For platform jobs, the value should be the owner_id from POST /v2/jobs/.; Example: icpdsupport/createdBy=1000331001

Base Cloud Pak for Data assemblies

The following labels are assigned for Cloud Pak for Data base assemblies.

IBM Cloud Pak® for Data control plane

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "IBM Cloud Pak for Data Control Plane" 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

IBM Cloud Pak for Data Common core services

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "IBM Cloud Pak for Data Common Core Services" 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

IBM Cloud Pak for Data Scheduling service

cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2"
cloudpakName: "IBM Cloud Pak for Data" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2"
productName: "IBM Cloud Pak for Data Scheduling"
productMetric: "GENERAL_PURPOSE_GRAPHICS_PROCESSING_UNIT"
productChargedContainers: "All"

AI Factsheets

serviceName: "IBM AI Factsheets"
serviceId: "8f02c429b26c4a1e93d6cd39f2991696"
cloudpakId: "ca7963422a064869abf2e46477d9eb38"
cloudpakName: "IBM Cloud Pak for Data Enterprise Edition" 
productCloudpakRatio: "1:1"
productID: "b6a4fa8fe48d4e978624e5b529d241a6"
productName: "IBM Cloud Pak for Data Base"
productMetric: "VIRTUAL_PROCESSOR_CORE"
productChargedContainers: "All"

Analytics Engine powered by Apache Spark

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "Analytics Engine powered by Apache Spark" 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

Cognos® Dashboards

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "IBM Cognos Dashboard Embedded" 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

Db2® Big SQL

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "Big SQL" 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

Db2 Data Gate

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "Db2 Data Gate" 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

Db2 Data Management Console

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "Data Management Console" 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

Db2 Warehouse

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "IBM Db2 Warehouse" 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

IBM® Match 360

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "Match 360" 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

IBM Watson® Knowledge Catalog for Cloud Pak for Data

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "IBM Watson Knowledge Catalog for IBM Cloud Pak for Data" 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

cloudpakName: IBM Cloud Pak for Data
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2"
productCloudpakRatio: "1:1"
productID: "9b576d16a52d448eac0f62f2fd016702"
productName: "MANTA Automated Data Lineage for IBM Cloud Pak for Data"
productMetric: "RESOURCE_UNIT"
productChargedContainers: "All"

Watson™ Machine Learning

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "IBM Watson Machine Learning 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

Watson Machine Learning Accelerator

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "IBM Watson Machine Learning Accelerator" 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

Watson OpenScale

cloudpakName: "IBM Cloud Pak for Data" 
cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productCloudpakRatio: "1:1"
productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
productName: "IBM Watson OpenScale" 
productMetric: "VIRTUAL_PROCESSOR_CORE" 
productChargedContainers: "All"

Watson Pipelines

cloudpakId: ca7963422a064869abf2e46477d9eb38
cloudpakName: IBM Cloud Pak for Data Enterprise Edition
productID: b6a4fa8fe48d4e978624e5b529d241a6
productName: IBM Cloud Pak for Data Base
productMetric: VIRTUAL_PROCESSOR_CORE
productChargedContainers: All
productCloudpakRatio: "1:1"
serviceName: IBM Watson Pipelines
serviceId: 1117853d69524f8a914ca639ddae200a
sproductVersion: 4.6.0

 Watson Query

cloudpakName: "IBM Cloud Pak for Data" 
 cloudpakId: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
 productCloudpakRatio: "1:1" 
 productID: "eb9998dcc5d24e3eb5b6fb488f750fe2" 
 productName: "Watson Query" 
 productMetric: "VIRTUAL_PROCESSOR_CORE" 
 productChargedContainers: "All"

Premium Cloud Pak for Data extensions

The following labels are assigned for Cloud Pak for Data premium extensions.

Anaconda Repository for IBM Cloud Pak for Data

cloudpakName: "Anaconda Repository for IBM Cloud Pak for Data"
cloudpakId: "3da7cc81ca64450d9145e18231a273e1"
productID: "3da7cc81ca64450d9145e18231a273e1"

IBM Cognos Analytics extension for IBM Cloud Pak for Data

cloudpakName: "IBM Cognos Analytics Extension for IBM Cloud Pak for Data"
cloudpakId: "5c92123b253a492780e6c6d4fe151d57"
productID: "5c92123b253a492780e6c6d4fe151d57"

IBM Data Management Platform for MongoDB Enterprise Advanced for IBM Cloud Pak for Data

cloudpakName: "IBM Data Management Platform for MongoDB Enterprise Advanced for IBM Cloud Pak for Data"
cloudpakId: "628fa31a63e849e391eb9e5184be8fa5"
productID: "628fa31a63e849e391eb9e5184be8fa5"

IBM DataStage® extension for IBM Cloud Pak for Data

cloudpakName: "IBM DataStage Extension for IBM Cloud Pak for Data"
cloudpakId: "d8a97b146d6f4bf18f033db9105f87f1"
productID: "d8a97b146d6f4bf18f033db9105f87f1"

IBM Db2 extension for IBM Cloud Pak for Data

cloudpakName: "IBM Db2 Extension for IBM Cloud Pak for Data"
cloudpakId: "c520bfe3b42a4e20a9ead3c0ad1654b7"
productID: "c520bfe3b42a4e20a9ead3c0ad1654b7"

IBM Financial Services Workbench forIBM Cloud Pak for Data

cloudpakName: "IBM Financial Services Workbench for IBM Cloud Pak for Data"
cloudpakId: "a93748d001604cf9aa811cea221bbddd"
productID: "a93748d001604cf9aa811cea221bbddd"

IBM Informix® extension for IBM Cloud Pak for Data

cloudpakName: "IBM Informix Extension for IBM Cloud Pak for Data"
cloudpakId: "d011858856ec417a8428588912a634e8"
productID: "d011858856ec417a8428588912a634e8"

IBM InfoSphere® Information Server extension for IBM Cloud Pak for Data

cloudpakName: "IBM Information Server Extension for IBM Cloud Pak for Data"
cloudpakId: "a5945d1ee97a4977baad1819107497c3"
productID: "a5945d1ee97a4977baad1819107497c3"

IBM OpenPages® for IBM Cloud Pak for Data

cloudpakName: "IBM OpenPages for IBM Cloud Pak for Data"
cloudpakId: "eae2d462346e4d088cf6015560492317"
productID: "eae2d462346e4d088cf6015560492317"

IBM Planning Analytics extension for IBM Cloud Pak for Data

cloudpakName: "IBM Planning Analytics Extension for IBM Cloud Pak for Data"
cloudpakId: "27646a3a52bb43408a3156180def3775"
productID: "27646a3a52bb43408a3156180def3775"

IBM Product Master for IBM Cloud Pak for Data

cloudpakName: "IBM Product Master Cartridge for IBM Cloud Pak for Data"
cloudpakId: "824293a6b9dc40f2ba040f4f2a6e64cb"
productID: "824293a6b9dc40f2ba040f4f2a6e64cb"

IBM Test Data Management for IBM Cloud Pak for Data

cloudpakName: "IBM Test Data Management for IBM Cloud Pak for Data"
cloudpakId: "58166cce7f71444cba68fcf8aa998c21"
productID: "58166cce7f71444cba68fcf8aa998c21"

IBM Virtual Data Pipeline for IBM Cloud Pak for Data

cloudpakName: "BM Virtual Data Pipeline for IBM Cloud Pak for Data"
cloudpakId: "9f3d28d63f694b169fcdf26a2ea68244"
productID: "9f3d28d63f694b169fcdf26a2ea68244"

IBM Watson AIOps for IBM Cloud Pak for Data

cloudpakName: "IBM Watson AIOps for IBM Cloud Pak for Data"
cloudpakId: "d41251cb161c412180d0e11c5f73ef00"
productID: "d41251cb161c412180d0e11c5f73ef00"

IBM Watson API Kit for IBM Cloud Pak for Data

cloudpakName: "IBM Watson API Kit for IBM Cloud Pak for Data"
cloudpakId: "df0b9c8451114e2d86d27ecb96afb37a"
productID: "df0b9c8451114e2d86d27ecb96afb37a"

IBM Watson Assistant for IBM Cloud Pak for Data

cloudpakName: "IBM Watson Assistant for IBM Cloud Pak for Data"
cloudpakId: "2eb0774c8a3841f09b7b75c9fb1fbdd7"
productID: "2eb0774c8a3841f09b7b75c9fb1fbdd7"

IBM Watson Discovery forIBM Cloud Pak for Data

cloudpakName: "IBM Watson Discovery for IBM Cloud Pak for Data"
cloudpakId: "0c8746533b134a0ba5cde9b3b516b65c"
productID: "0c8746533b134a0ba5cde9b3b516b65c"

IBM Watson Studio Premium extension for IBM Cloud Pak for Data

cloudpakName: "IBM Watson Studio Premium Extension for IBM Cloud Pak for Data"
cloudpakId: "497aaae00a3f402dbcbb6ee00d1b924b"
productID: "497aaae00a3f402dbcbb6ee00d1b924b"