Monitoring metrics for Event Notifications
IBM Cloud services, such as IBM Cloud® Event Notifications, generate platform metrics that you can use to gain operational visibility into the performance and health of the service in your account.
IBM Cloud Monitoring is a third-party cloud-native, and container-intelligence management system that can be included as part of your IBM Cloud architecture. It offers administrators, DevOps teams, and developers full-stack telemetry with advanced features to monitor and troubleshoot, define alerts, and design custom dashboards. For more information, see Monitoring in IBM Cloud.
You can use IBM Cloud Metrics Routing, a platform service, to route platform metrics in your account to a destination of your choice by configuring targets and routes that define where platform metrics are sent. For more information, see About IBM Cloud Metrics Routing in IBM Cloud.
You can use IBM Cloud Monitoring to visualize and alert on metrics that are generated in your account and routed by IBM Cloud Metrics Routing to an IBM Cloud Monitoring instance.
Locations where metrics are generated
IBM Cloud® Event Notifications sends metrics in the regions that are indicated in the following table.
Dallas (us-south ) |
Washington (us-east ) |
Toronto (ca-tor ) |
Sao Paulo (br-sao ) |
---|---|---|---|
Yes | No | Yes | No |
Tokyo (jp-tok ) |
Sydney (au-syd ) |
Osaka (jp-osa ) |
Chennai (in-che ) |
---|---|---|---|
Yes | Yes | Yes | No |
Frankfurt (eu-de ) |
London (eu-gb ) |
Madrid (eu-es ) |
---|---|---|
Yes | Yes | Yes |
Enabling platform metrics for Event Notifications
Before you can start with Event Notifications monitoring metrics, you must first opt in and enable platform metrics.
You can configure only one instance of the IBM Cloud Monitoring service per region to collect platform metrics.
- To configure the IBM Cloud 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 IBM Cloud Monitoring instance is created in the same region where the IBM Cloud instance is created.
Viewing metrics
To monitor Event Notifications metrics, you must launch the IBM Cloud Monitoring web UI for the instance that is enabled for platform metrics in the region where your service instance is created.
Launching IBM Cloud® Monitoring from the Observability page
For more information about launching the IBM Cloud Monitoring UI, see Launching the UI in the IBM Cloud Monitoring documentation.
Monitoring Event Notifications
- Start the IBM Cloud Monitoring web UI from the Observability page.
- Click DASHBOARDS.
- In the Default Dashboards section, expand IBM.
- Select the Event Notifications dashboard from the list.
- Access your deployment's monitoring dashboard from IBM Cloud Monitoring located in the sidebar under IBM.
- Change the scope or make a copy of the default dashboard to monitor a service instance.
Metrics available by service plan
Name | Description |
---|---|
ibm_eventnotifications_total_ingested_notifications | The total number of notifications that are ingested. Ingested notifications are events from a source that has at least one condition that is defined on them for filtering. |
ibm_eventnotifications_total | The total number of notifications for a particular type includes successful and failed notifications. |
ibm_eventnotifications_failed | The total number of failed notifications of a particular type. |
ibm_eventnotifications_devices | The total number of push notification devices registered. |
Attributes for segmentation
Global attributes
The following attributes are available for segmenting all of the metrics previously listed.
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. |
Scope |
ibm_scope |
The scope is the account, organization, or space GUID associated with this metric. |
Service instance |
ibm_service_instance |
The service instance segment identifies the instance that the metric is associated with. |
Additional attributes
The following attributes are available for segmenting one or more attributes as described in the previous tables. See the individual metrics for segmentation options.
Attribute | Name | Description |
---|---|---|
Name of the destination |
ibm_eventnotifications_destination |
A destination name with its associated ID. |
Name of the source |
ibm_eventnotifications_source |
A source name with its associated ID. |
Type of event notification |
ibm_eventnotifications_type |
The type of supported destination types. (email, SMS, or webhook) |
Type of push notification device |
ibm_eventnotifications_device_type |
The type of supported push notification device.(push_android, push_ios) |