Platform metrics for Activity Tracker Event Routing

You can use the IBM Cloud® Monitoring service to monitor platform metrics that are exposed by Activity Tracker Event Routing. For example, you can use it to monitor how Activity Tracker Event Routing is routing events in each region where you are collection auditing events.

IBM Cloud Monitoring is a cloud-native, and container-intelligence management system that you can include as part of your IBM Cloud architecture. You can 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.

Enabling platform metrics

Platform metrics are metrics that are exposed by enabled-monitoring services and the platform in IBM Cloud. You can use them to find and take action on configuration problems and possible outages.

To monitor platform metrics, you must provision a Monitoring instance in the same region where the metrics are exposed.

For example, you can use the IBM Cloud Monitoring service to monitor that events are forwarded to the configured destination.
You can configure 1 instance only of the IBM Cloud Monitoring service per region to collect platform metrics in that location.

In a region, before you configure a Monitoring instance to collect platform metrics, check with the account or service administrator if another Monitoring instance has already been configured. You may not have permissions to see all Monitoring instances in the region.
If you have configured Activity Tracker Event Routing in more than one region, you must enable platform metrics for each region.

For more information on how to enable platform metrics, select 1 of the following options:

Viewing metrics for Activity Tracker Event Routing

You monitor metrics in the Monitoring web UI.

To monitor Activity Tracker Event Routing metrics, you must launch the Monitoring UI for the instance that is enabled for platform metrics in the region where your target is defined. For example, if you have a target defined in US-South, you must launch the Monitoring instance in US-South that has the flag platform metrics. For more information, see Launching the Monitoring UI from the Observability page.

You can use the IBM Activity Tracker Event Routing Overview predefined dashboard template to monitor Activity Tracker Event Routing in IBM Cloud.

To open the predefined Activity Tracker Event Routing template, complete the following steps from the Monitoring UI:

In the Monitoring UI, go to Dashboards > Dashboard templates > IBM.
Select IBM Activity Tracker Event Routing Overview.

You cannot modify a dashboard template. However, you can copy the template and create a custom dashboard that you can then configure.

Next, choose any of the following tasks to learn more about how to manage and work with platform metrics:

Metrics

Activity Tracker Event Routing exposes the following metrics:

Total number of events successfully sent to the storage target

Total number of events that are successfully sent to the storage target.

Table 1. Total number of events successfully sent to the storage target
Metadata	Description
`Metric Name`	`ibm_atracker_successful_events_by_target`
`Metric Type`	`counter`
`Value Type`	`none`
`Segment By`	`target type`

Total number of events that failed to send to the storage target

Total number of events that failed to send to the storage target.

Table 2. Total number of events that failed to send to the storage target
Metadata	Description
`Metric Name`	`ibm_atracker_bad_config_discarded_events`
`Metric Type`	`counter`
`Value Type`	`none`
`Segment By`	`target type, reason`

Total number of events that are discarded

Total number of events that are discarded.

Table 3. Total number of events that are discarded
Metadata	Description
`Metric Name`	`ibm_atracker_failed_events_by_target`
`Metric Type`	`counter`
`Value Type`	`none`
`Segment By`	`target type, reason`

Target mode

The current mode for Activity Tracker Event Routing targets. There are two possible values for the metric:

1 indicates that valid targets are configured.
0 indicates that there are misconfigured or discarded targets.

You need to resolve misconfigured or discarded targets. One of the following needs to be fixed:

Make sure that your IAM token has the appropriate authorization, see IAM token authorization error.
Your target destination must be a CRN for a target instance that exists.

Table 4. Target modes
Metadata	Description
`Metric Name`	`ibm_atracker_target_mode`
`Metric Type`	`gauge`
`Value Type`	`none`
`Segment By`	`ibm_atracker_target_type`

Global Attributes

The following attributes are available for all metrics.

Table 5. Global atributes
Attribute	Attribute Name	Attribute Description
`Cloud Type`	`ibm_ctype`	The cloud type is `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, which is typically an identifying name or GUID.
`Resource Type`	`ibm_resource_type`	The type of the resource that is measured by the service.
`Scope`	`ibm_scope`	The scope is the account, organization, or space GUID associated with the metric.
`Service name`	`ibm_service_name`	The name of the service that is generating this metric.

More attributes

The following attributes are available for one or more attributes described in the previous tables. See the individual metrics for options.

Table 6. Other atributes
Attribute	Attribute Name	Attribute Description
`target type`	`ibm_atracker_target_type`	The target type destination of the event. Valid values are: `cloud_object_storage`, `logdna`, or `event_streams`.
`reason`	`ibm_atracker_reason_code`	The reason for the failure of an event delivery to its destination.