Oracle Cloud Infrastructure Documentation

Notifications Metrics

You can monitor the health, capacity, and performance of your messages by using A measurement related to health, capacity, or performance of a given resource. (Monitoring service). Example: CpuUtilization, The trigger rule and query to evaluate and related configuration, such as notification details to use when the trigger is breached. Alarms passively monitor your cloud resources using metrics in Monitoring., 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 An IAM document that specifies who has what type of access to your resources. It is used in different ways: to mean an individual statement written in the policy language; to mean a collection of statements in a single, named "policy" document (which has an Oracle Cloud ID (OCID) assigned to it); and to mean the overall body of policies your organization uses to control access to resources. 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 A collection of related resources that can be accessed only by certain groups that have been given permission by an administrator in your organization. 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

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 A qualifier provided in a metric definition. (Monitoring service.) Example: Resource identifier (resourceId), provided in the definitions of oci_computeagent metrics.:

availabilityDomain
The One or more isolated, fault-tolerant Oracle data centers that host cloud resources such as instances, volumes, and subnets. A region contains one or more availability domains. in which the associated A communication channel for sending messages to the subscriptions in the topic. (Notifications service.) resides.
endpointType
The subscription protocol of the endpoint used for the delivery attempt.
region
The A collection of availability domains located in a single geographic location. in which the associated A communication channel for sending messages to the subscriptions in the topic. (Notifications service.) resides.
resourceId
The An Oracle-assigned unique ID called an Oracle Cloud Identifier (OCID). This ID is included as part of the resource's information in both the Console and API. of the resource to which the metric applies.
topicDisplayName
The friendly name of the associated A communication channel for sending messages to the subscriptions in the topic. (Notifications service.).
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: