IBM Cloud Monitoring integration

IBM Cloud® Monitoring is a third-party, cloud-native, and container-intelligent management system that you can include as part of your IBM Cloud® architecture. Use it to gain operational visibility into the performance and health of your applications, services, and platforms. It offers administrators, DevOps teams, and developers full-stack telemetry with advanced features to monitor and troubleshoot, define alerts, and design custom dashboards.

Currently, IBM Cloud Monitoring integration is available for IBM Cloudant deployments according to the following table:

Table 1. IBM Cloud Monitoring regions
Deployment Region	IBM Cloud Monitoring Region
`Chennai`	`Tokyo`
`Dallas`	`Dallas`
`Frankfurt`	`Frankfurt`
`London`	`London`
`Osaka`	`Osaka`
`São Paulo`	`São Paulo`
`Seoul`	`Tokyo`
`Sydney`	`Sydney`
`Tokyo`	`Tokyo`
`Toronto`	`Toronto`
`Washington DC`	`Washington DC`

Platform metrics overview

You can configure only one instance of the IBM Cloud® Monitoring service per region to collect platform metrics.

To configure the Monitoring instance, you must turn on the platform metrics configuration setting.
If a Monitoring instance in a region is already enabled to collect platform metrics, metrics from enabled-monitoring services are collected automatically and available for monitoring through this instance. For more information about enabled-monitoring services, see IBM Cloud® services.

To monitor platform metrics, check that the Monitoring instance is provisioned in the same region where the IBM Cloud instance is provisioned.

Enabling platform metrics from the IBM Cloud Dashboard

Complete the following steps to configure platform metrics:

Log in to IBM Cloud.

The IBM Cloud Dashboard opens.
Click View all in the Resource summary section of the dashboard.
In the Services section, click the IBM Cloud instance that you plan to monitor.

The IBM Cloud UI Manage page opens.
Click Actions > Add monitoring to configure platform metrics in the region of your IBM Cloud instance.

If the menu choices include the Monitoring option, then your instance is already configured for platform metrics.

Figure 1. Monitoring menu
Provision an instance of the IBM Cloud Monitoring service.

After you provision the Monitoring instance, the Observability page opens. To continue working with IBM Cloud, go back to the IBM Cloud UI.

Viewing metrics

To monitor IBM Cloudant metrics, you must launch the IBM Cloud Monitoring web UI instance that is enabled for platform metrics in the region where your IBM Cloud instance is available.

You can use different options to launch the IBM Cloud Monitoring web UI and monitor metrics that are described in the following section.

Launching IBM Cloud Monitoring web UI from the IBM Cloudant Dashboard

Complete the following steps to launch the IBM Cloud Monitoring web UI from the IBM Cloud Dashboard:

Log in to IBM Cloud.

The IBM Cloud Dashboard opens.
Click View all in the Resource summary section of the dashboard.
In the Services section, click the IBM Cloudant instance that you plan to monitor.

The IBM Cloudant Manage page opens.
Click Actions, and select Monitoring.

Figure 2. Monitoring menu

A new tab opens in your browser and shows the Default dashboard that is named IBM Cloudant within the context of your IBM Cloudant instance.

Launching IBM Cloud Monitoring web UI from the Observability page

Complete the following steps to launch the IBM Cloud Monitoring web UI from the Observability page:

Launch the IBM Cloud Monitoring web UI.
Click DASHBOARDS.
In the Default Dashboards section, expand IBM.
Choose the IBM Cloudant Dashboard from the list.

To access your deployment's IBM Cloud Monitoring Dashboard from IBM Cloud Monitoring, it's in the sidebar, under IBM.

Figure 3. IBM Cloudant Dashboard

Next, change the scope or make a copy of the Default dashboard to monitor an IBM Cloudant instance.

IBM Cloudant metrics dictionary

HTTP request count

The number of HTTP requests made against an IBM Cloudant instance:

Table 2. HTTP request count metric metadata
Metadata	Description
`Metric Name`	`ibm_cloudant_http_requests_total`
`Metric Type`	`counter`
`Value Type`	`none`
`Segment By`	`Service instance, Service instance name`

Rate-limited operations

The number of operations that were rate-limited:

Table 3. Rate-limited operations metric metadata
Metadata	Description
`Metric Name`	`ibm_cloudant_rate_limited_operations`
`Metric Type`	`counter`
`Value Type`	`none`
`Segment By`	`Service instance, Service instance name, Cloudant operation type`

Attributes for segmentation

Global Attributes

The following attributes are available for segmenting all the metrics that are listed previously:

Table 4. Global attributes
Attribute	Name	Description
`Cloud Type`	`ibm_ctype`	The cloud type is a value of public, dedicated, or local.
`Location`	`ibm_location`	The location of the monitored resource, which can be a region, data center, or global.
`Resource`	`ibm_resource`	The resource that is measured by the service, typically an identifying name, or GUID.
`Scope`	`ibm_scope`	The scope is the account, organization, or space GUID associated with this metric.
`Service name`	`ibm_service_name`	Name of the service that generates this metric.

More Attributes

The following attributes are available for segmenting one or more attributes as described in the previous reference. See the individual metrics for segmentation options in the following table:

Table 5. More attributes
Attribute	Name	Description
`Cloudant operation type`	`ibm_cloudant_operation_type`	The Cloudant billable operation type.
`Service instance`	`ibm_service_instance`	The service instance segment identifies the instance that the metric is associated with.
`Service instance name`	`ibm_service_instance_name`	The service instance name provides the user-provided name of the service instance, which isn't necessarily a unique value that depends on the name that is provided by the user.
`Resource group name`	`ibm_resource_group_name`	The resource group name provides the user-provided name of the resource group where the service instance was created.
`Resource group`	`ibm_resource_group_id`	The unique ID of the resource group where the service instance was created.

IBM Cloudant Dashboard's dictionary

The following table outlines the pre-defined dashboards that you can use to monitor IBM Cloudant metrics:

Table 6. Pre-defined dashboard
Dashboard name	Description
`IBM Cloudant`	The default dashboard that opens when you launch IBM Cloud Monitoring web UI from your service instance UI.

The Default dashboard cannot be changed.