Notifications Metrics Reference
Review information about metrics emitted by the metric namespace oci_notification (the Notifications service).
Resources: Not applicable. Measures data for messages, which aren't resources.
Before You Begin
IAM policies: To monitor resources, you must be granted 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, contact the administrator to determine the type of access you were granted and which compartment you need to work in. For more information about user authorizations for monitoring, see IAM Policies (Monitoring).
The metrics in the oci_notification metric namespace are automatically available for messages you publish to topics. You don't need to enable monitoring on any resources to get these metrics.
Available Metrics: oci_notification
Availability of service metrics (including dimensions) is governed by Monitoring storage limits. For a successful query of a metric or dimension to occur, that metric or dimension must be stored in Monitoring.
Dimensions
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.
- resultCode
-
The code of the result for a failed message, if the result code exists. The only value is
4702, which indicates that the message was dropped because the email recipient was suppressed. To remove a recipient from the suppression list, open a support request.Note
This dimension exists only when a message failed and a valid value is emitted. - resultMessage
-
The explanation of the result for a failed message, if the result explanation exists. The only value is
Email subscription is suppressed, which indicates that the message was dropped because the email recipient was suppressed. To remove a recipient from the suppression list, open a support request.Note
This dimension exists only when a message failed and a valid value is emitted. - subscriptionId
-
The OCID of the subscription.
Note
This dimension exists only when a message failed and a valid value is emitted. - topicDisplayName
- The friendly name of the associated topic .
Descriptions
Following are descriptions of the Notifications service metrics:
| Metric | Metric Display Name | Unit | Description | Dimensions |
|---|---|---|---|---|
DeliveredMessagesCount
|
Delivered Messages Count | count | Count of messages that Notifications successfully transmitted to endpoints (subscriptions in topics). See Flow of Message Publication and Delivery. |
|
DeliveredMessagesSize
|
Delivered Messages Size (Bytes) | bytes | Size of messages that Notifications successfully transmitted to endpoints (subscriptions in topics). See Flow of Message Publication and Delivery. |
|
FailedMessagesCount
|
Failed Messages Count | count |
Count of messages that Notifications could not transmit to endpoints (subscriptions in topics). See Flow of Message Publication and Delivery. Note: This metric exists only when a message failed. |
|
FailedMessagesSize
|
Failed Messages Sizes (Bytes) | bytes |
Size of messages that Notifications could not transmit to endpoints (subscriptions in topics). See Flow of Message Publication and Delivery. Note: This metric exists only when a message failed. |
|
PublishedMessagesCount
|
Published Messages Count | count | Count of messages in requests that Notifications received from the service or customer. See Flow of Message Publication and Delivery. |
|
PublishedMessagesSize
|
Published Messages Size (Bytes) |
bytes |
Size of messages in requests that Notifications received from the service or customer. See Flow of Message Publication and Delivery. |
|