Monitoring configuration
Monitoring is installed in the management-monitoring
namespace.
Note: If you must uninstall and reinstall Monitoring for some reason, if you are using local storage, you must delete all data from the created folders/volumes manually. For dynamically provisioned storage, no action is required. The data is automatically deleted.
ibm-management-monitoring
The following procedure describes how to customize the configuration parameters for Monitoring using the installation YAML. Customize your out of the box Monitoring installation using the installation YAML. For more information, see the Monitoring parameters table.
Important: The following important settings for Monitoring cannot be customized using the installation YAML, and these must be customized separately:
-
Data retention and metric summarization parameters are not configured as part of the Monitoring operator, they are not customized using the installation YAML. They must be configured in the observability service in Red Hat Advanced Cluster Management, for more information, see the Enabling the observability service in Red Hat Advanced Cluster Management topic.
-
The Monitoring DataProvider Management configuration parameters are not included in the installation YAML. See Installing and uninstalling IBM Monitoring DataProvider Management for more information about these parameters.
Note: If at any time, before or after monitoring configuration, you access Monitoring menus from the console and a 401 self-signed error message is returned, refer to 401 self-signed certificate error returned when accessing Monitoring menus to troubleshoot.
To update the configuration parameters using the installation YAML after you install Monitoring, complete the following steps:
- Run the following command to edit the Installation custom resource:
Where <installation_name> is the name for your installation instance, for example,oc edit installations.orchestrator.management.ibm.com <installation_name> -n <IBM Cloud Pak for Multicloud Management_namespace> -o yaml
cp4mcm-install
. <IBM Cloud Pak® for Multicloud Management_namespace> is your IBM Cloud Pak for Multicloud Management namespace, for example,cp4mcm
. -
Add or update the parameters for the specific feature or function that you are configuring in the
monitoringDeploy
section. Refer to the Monitoring parameters and the following example yaml snippet for help updating these parameters.monitoringDeploy: global: monitoring: analytics: true ha: false metric: summary enabled: false environmentSize: size0 minReplicasHPAs: 1 agentmgmt: provider: autoRemove: true ttl: 24 persistence: storageClassOption: cassandrabak: none cassandradata: icam-local-storage-cassandra couchdbdata: icam-local-storage-couchdb datalayerjobs: icam-local-storage-datalayer elasticdata: icam-local-storage-elasticsearch kafkadata: icam-local-storage-kafka zookeeperdata: icam-local-storage-zookeeper storageSize: cassandrabak: 50Gi cassandradata: 50Gi couchdbdata: 5Gi datalayerjobs: 5Gi elasticdata: 5Gi kafkadata: 25Gi zookeeperdata: 1Gi autoconfig: testActive: "true" testInterval: "5" disableAlerts: "true" useAllLocations: "false"
- Wait until the CR status is success. It might take a substantial amount of time. You can run the following command to check MonitoringDeploy CR status:
oc get monitoringdeploy $(oc get monitoringdeploy -n management-monitoring --no-headers | awk '{print $1}') -n management-monitoring -o yaml
Monitoring parameters
Parameter name | Description | Default |
---|---|---|
Functions | ||
monitoringDeploy.global.monitoring.analytics | Enables dynamic baselines. Set it to true or false. You can change this parameter after the installation is complete. (See Managing baselines.) | true |
monitoringDeploy.global.metric.summary.enabled | Allows more than 2 weeks of metric data to be selected for display in the IBM Cloud Pak console. Due to known issues in rendering this data, it is recommended to NOT use this option at this time. | false |
monitoringDeploy.global.agentmgmt.provider.autoRemove | Indicates whether or not the offline UA providers and the related resources should be removed automatically. | true |
monitoringDeploy.global.agentmgmt.provider.ttl | The number of hours to keep the offline UA providers and the related resources. | 24 |
monitoringDeploy.autoconfig.testActive | Configuration conditions for auto-configured synthetic tests - run auto-configured synthetic tests. Set it to true or false. You can change this parameter after the installation is complete. | true |
monitoringDeploy.autoconfig.testInterval | Configuration conditions for auto-configured synthetic tests - auto-configured synthetic test run interval in minutes. You can change this parameter after the installation is complete. | "5" |
monitoringDeploy.autoconfig.disableAlerts | Configuration conditions for auto-configured synthetic tests - disable alerts on auto-configured synthetic tests. Set it to true or false. You can change this parameter after the installation is complete. | true |
monitoringDeploy.autoconfig.useAllLocations | Configuration conditions for auto-configured synthetic tests - use all PoP locations for auto-configured synthetic tests. Set it to true or false. You can change this parameter after the installation is complete. | false |
High availability | ||
monitoringDeploy.global.monitoring.ha | Can be set to true or false. Enables a minimal high availability monitoring installation. You cannot change this parameter after the installation is complete. | false |
monitoringDeploy.global.environmentSize | Can be set to size0, size0_ppc64le, size1, or size1_ppc64le. This parameter controls the cpu (memory) requirements also. It must be set to size1 or size1_ppc64le for high availability. You cannot change this parameter after the installation is complete. | size0 |
monitoringDeploy.global.minReplicasHPAs | Controls the minimum replicas for all stateless services in a high availability installation. Set it to 2 or 3 based on availability requirements. You can change this parameter after the installation is complete. | 2 |
Storage class | ||
monitoringDeploy.global.persistence.storageClassName | Must be set to a valid storage class. The value set here overrides the default storage class. You cannot change this parameter after the installation is complete. | Defaults to the storage class set for the IBM Cloud Pak® for Multicloud Management installation. |
monitoringDeploy.persistence.storageClassOption.cassandrabak | The storage class name that is used by Cassandra backups. It defaults to none, which means the backup volume is disabled. If it is set to default, the storage class name that is set in the global.persistence.storageClassName parameter is used. You cannot change this parameter after the installation is complete. For more information on backing up Cassandra, see Back up and restore Cassandra. | none |
monitoringDeploy.global.persistence.storageClassOption.cassandradata | Use this storage class to store Cassandra data. It defaults to default, which means, it tries to use the configured default storage class that is set in the global.persistence.storageClassName parameter. You cannot change this parameter after the installation is complete. | default |
monitoringDeploy.global.persistence.storageClassOption.couchdbdata | Use this storage class name to store CouchDB data. It defaults to default, which means, it tries to use the configured default storage class that is set in the global.persistence.storageClassName parameter. You cannot change this parameter after the installation is complete. | default |
monitoringDeploy.global.persistence.storageClassOption.datalayerjobs | Use this storage class to store data layer (event) data. It defaults to default, which means, it tries to use the configured default storage class that is set in the global.persistence.storageClassName parameter. You cannot change this parameter after the installation is complete. | default |
monitoringDeploy.global.persistence.storageClassOption.elasticdata | Use this storage class to store Elasticsearch data. It defaults to default, which means, it tries to use the configured default storage class that is set in the global.persistence.storageClassName parameter. You cannot change this parameter after the installation is complete. | default |
monitoringDeploy.global.persistence.storageClassOption.kafkadata | Use this storage class to store Kafka data. It defaults to default, which means, it tries to use the configured default storage class that is set in the global.persistence.storageClassName parameter. You cannot change this parameter after the installation is complete. | default |
monitoringDeploy.global.persistence.storageClassOption.zookeeperdata | Use this storage class to store zookeeper data. It defaults to default, which means, it tries to use the configured default storage class that is set in the global.persistence.storageClassName parameter. For a stable installation, it is critical that zookeeper is installed on high-performance storage. You cannot change this parameter after the installation is complete. | |
Storage size | ||
monitoringDeploy.global.persistence.storageSize.cassandrabak | The amount of storage to allocate for cassandra backups. If it is required, increase the storage for your installation. You cannot change this parameter after the installation is complete. | 50Gi |
monitoringDeploy.global.persistence.storageSize.cassandradata | The amount of storage to allocate for Cassandra. If it is required, increase the storage for your installation. You cannot change this parameter after the installation is complete. | 50Gi |
monitoringDeploy.global.persistence.storageSize.couchdbdata | The amount of storage to allocate for couchdb data. If it is required, increase the storage for your installation. You cannot change this parameter after the installation is complete. | 5Gi |
monitoringDeploy.global.persistence.storageSize.datalayerjobs | The amount of storage to allocate for data layer data. If it is required, increase the storage for your installation. You cannot change this parameter after the installation is complete. | 5Gi |
monitoringDeploy.global.persistence.storageSize.elasticdata | The amount of storage to allocate for Elasticsearch data. If it is required, increase the storage for your installation. You cannot change this parameter after the installation is complete. | 5Gi |
monitoringDeploy.global.persistence.storageSize.kafkadata | The amount of storage to allocate for Kafka data. If it is required, increase the storage for your installation. You cannot change this parameter after the installation is complete. | 25Gi |
monitoringDeploy.global.persistence.storageSize.zookeeperdata | The amount of storage to allocate for zookeeper data. If it is required, increase the storage for your installation. You cannot change this parameter after the installation is complete. | 1Gi |