Oracle Cloud Infrastructure Documentation

Notifications Metrics

You can monitor the health, capacity, and performance of your messages by using metrics , alarms , and notifications.

This topic describes the metrics emitted by the metric namespace oci_notification (the Notifications service).

Resources: Not applicable. Measures data for messages, which are not resources.

Overview of the Notifications Service Metrics

The Notifications service metrics help you measure the number and size of messages that are in initial requests, are delivered, and are not delivered.

Prerequisites

  • IAM policies: To monitor resources, you must be given the required type of access in a policy  written by an administrator, whether you're using the Console or the REST API with an SDK, CLI, or other tool. The policy must give you access to the monitoring services as well as the resources being monitored. If you try to perform an action and get a message that you don’t have permission or are unauthorized, confirm with your administrator the type of access you've been granted and which compartment  you should work in. For more information on user authorizations for monitoring, see the Authentication and Authorization section for the related service: Monitoring or Notifications.

Available Metrics: oci_notification

The metrics listed in the following table are automatically available for messages you publish to topics. You do not need to enable monitoring on any resources to get these metrics.

Each metric includes a subset of the following dimensions :

availabilityDomain
The availability domain  in which the associated topic  resides.
endpointType
The subscription protocol of the endpoint used for the delivery attempt.
region
The region  in which the associated topic  resides.
resourceId
The OCID  of the resource to which the metric applies.
topicDisplayName
The friendly name of the associated topic .
Metric Metric Display Name Unit Description Dimensions

PublishedMessagesSize

Published Messages Size (Bytes)

bytes

Size of messages in request.

availabilityDomain

region

resourceId

topicDisplayName

PublishedMessagesCount Published Messages Count count Count of messages in request.
DeliveredMessagesSize Delivered Messages Size (Bytes) bytes Size of messages successfully delivered to endpoints.

availabilityDomain

endpointType

region

resourceId

topicDisplayName

FailedMessagesSize Failed Messages Sizes (Bytes) bytes Size of messages that did not get delivered to endpoints.
DeliveredMessagesCount Delivered Messages Count count Count of messages successfully delivered to endpoints.
FailedMessagesCount Failed Messages Count count Count of messages that did not get delivered to endpoints.

Using the Console

To view default metric charts for a single topic
To view default metric charts for multiple topics

Using the API

Use the following APIs for monitoring: