Updating usage data collection preferences

To assist in the development of IBM Cloud Pak for AIOps, daily aggregated usage data is collected to analyse how IBM Cloud Pak for AIOps is used. The collection of usage data is enabled or disabled when you install or upgrade to IBM Cloud Pak for AIOps 4.8.0, but can be changed at any time.

This usage data is collected by the cp4waiops-metricsprocessor pod, and is sent to and stored in IBM controlled GDPR-compliant systems. The collection of usage data is enabled by default, but can be disabled. For transparency, the cp4waiops-metricsprocessor pod's logs will contain all of the information that is collected. The usage data that is collected is all numeric, or is about the deployment type and platform. It does not include email addresses, passwords, or specific details. Only the following data is collected:

  • Current number of applications
  • Current number of alerts (all severities aggregated)
  • Current number of incidents (all priorities aggregated)
  • Current number of policies (includes predefined and user created)
  • Current number of runbooks executed since install
  • Current number of integrations of each type (For example, ServiceNow, Instana, Falcon Logscale)
  • Secure tunnel enablement: whether connection (which controls whether you can create a secure tunnel) is enabled in the Installation custom resource
  • Deployment type: base deployment or extended deployment
  • Deployment platform: Red Hat® OpenShift® Container Platform or Linux®

Disabling the collection of usage data

  1. Set environment variables.

    export CUSTOMER_NAME=<your company name>
export CUSTOMER_ICN=<your IBM Customer Number>
export CUSTOMER_ENVIRONMENT=<Set to `trial`, `poc`, or `production`>
export PROJECT_CP4AIOPS=<the project where IBM Cloud Pak for AIOps is deployed, usually cp4aiops>

  2. Disable usage data collection.

    oc create secret generic aiops-metrics-processor -n ${PROJECT_CP4AIOPS} --from-literal=customerName=${CUSTOMER_NAME} --from-literal=customerICN=${CUSTOMER_ICN} --from-literal=environment=${CUSTOMER_ENVIRONMENT} --from-literal=enableCollection=false

  3. Find the name of the metricsprocessor pod by running the following command:

    oc get pods -n ${PROJECT_CP4AIOPS} | grep cp4waiops-metricsprocessor

    Example output:

    cp4waiops-metricsprocessor-f4dc776d-7pwlm                         1/1     Running     0                 19h

  4. Restart the metricsprocessor pod by running the following command:

    oc delete pod <metrics_processor_pod> -n ${PROJECT_CP4AIOPS}

    Where <metrics_processor_pod> is the pod returned by the previous step.

Enabling the collection of usage data

  1. Set environment variables.

    export CUSTOMER_NAME=<your company name>
export CUSTOMER_ICN=<your IBM Customer Number>
export CUSTOMER_ENVIRONMENT=<Set to `trial`, `poc`, or `production`>

  2. Configure the usage data with your customer details.

    oc create secret generic aiops-metrics-processor -n ${PROJECT_CP4AIOPS} --from-literal=customerName=${CUSTOMER_NAME} --from-literal=customerICN=${CUSTOMER_ICN} --from-literal=environment=${CUSTOMER_ENVIRONMENT}

  3. If you have a firewall enabled, ensure that outbound traffic to https://api.segment.io is allowed.

  4. Find the name of the metricsprocessor pod by running the following command:

    oc get pods -n ${PROJECT_CP4AIOPS} | grep cp4waiops-metricsprocessor

    Example output:

    cp4waiops-metricsprocessor-f4dc776d-7pwlm                         1/1     Running     0                 19h

  5. Restart the metricsprocessor pod by running the following command:

    oc delete pod <metricsprocessor_pod> -n ${PROJECT_CP4AIOPS}

    Where <metricsprocessor_pod> is the pod returned by the previous step.