IBM Cloud Platform Metrics

Integration with Instana

The following IBM Cloud Platform Metrics are integrated with Instana.

  • IBM Cloudant
  • IBM Cloud Container Registry
  • IBM Cloud Databases for Elasticsearch
  • IBM Cloud Databases for etcd
  • IBM Cloud Databases for MongoDB
  • IBM Cloud Databases for PostgreSQL
  • IBM Cloud Databases for RabbitMQ
  • IBM Cloud Databases for Redis
  • IBM Cloud Foundry
  • IBM Cloud Functions
  • IBM Cloud Hyper Protect DBaaS for MongoDB
  • IBM Cloud Hyper Protect DBaaS for PostgreSQL
  • IBM Cloud Object Storage
  • IBM Cloud Schematics
  • IBM Cloud SQL Query
  • IBM Event Streams
  • IBM Load Balancer (classic)
  • IBM Load Balancer for VPC
  • IBM VPC virtual server instances
  • IBM VPN for VPC

Activating IBM Cloud Platform Metrics support

Retrieve API KEY

  1. Enable collection of IBM Cloud Platform Metrics.
  2. From IBM Cloud dashboard, select the Navigation menu icon on top left corner of the page.
  3. In the dropdown list, select Observability.
  4. Select Monitoring from the Observability page, then select the Open dashboard link.
  5. On the dashboard, select the circle icon with your user initials.
  6. Select settings then copy the API Token on the settings page. This is your API KEY.

Configuration

  1. Install Instana agent on a system that has network access to both IBM Cloud and your Instana server.

  2. Search for IBM Cloud Platform Services section in the agent's configuration.yaml. This file can be found at <agent_install_dir>/etc/instana/configuration.yaml

  3. Configure IBM Cloud Monitoring endpoint and API KEY for each IBM Cloud location that requires monitoring. Multiple locations can be configured.

    # IBM Cloud Platform Services
#com.instana.plugin.ibmcloud:
#  enabled: true
#  locations: # Support multiple IBM Cloud locations. Add location configuration as follows.
#    - location_endpoint: '<INSERT_ENDPOINT_HERE>' # IBM Cloud Monitoring endpoint. For example, https://us-south.monitoring.cloud.ibm.com
#      apikey: '<INSERT_APIKEY_HERE>' # IBM Cloud Monitoring API Key for this location.
#    - location_endpoint: '<INSERT_ENDPOINT_HERE>' # IBM Cloud Monitoring endpoint. For example, https://us-east.monitoring.cloud.ibm.com
#      apikey: '<INSERT_APIKEY_HERE>' # IBM Cloud Monitoring API Key for this location.

Available metrics

Navigate to IBM Cloud Platform Services Monitoring to see the supported service metrics.

Health Signatures

For each sensor, there is a curated knowledgebase of health signatures that are evaluated continuously against the incoming metrics and are used to raise issues or incidents depending on user impact.

Built-in events trigger issues or incidents based on failing health signatures on entities, and custom events trigger issues or incidents based on the thresholds of an individual metric of any given entity.

Events may be raised by the agent sending IBM Cloud Platform Metrics to the Instana server. See the possible events. Built-in events reference.

Monitoring Issues

Connection Error

Monitoring issue type: ibmcloud_invalid_apikey

IBM Cloud Platform Metrics Sensor could not connect to IBM Cloud due to invalid API Key. Make sure that a valid API Key is configured correctly in the configuration.yaml.

Monitoring issue type: ibmcloud_unknown_host

IBM Cloud Platform Metrics Sensor could not connect to IBM Cloud due to unknown host. Make sure that the host is configured correctly in the configuration.yaml.

Monitoring issue type: ibmcloud_connection_error

IBM Cloud Platform Metrics Sensor could not connect to IBM Cloud for reasons other than invalid API Key or unknown host. Look at agent log for additional information.