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

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

For more information about monitoring metrics and using alarms, see Monitoring. For information about notifications for alarms, see Notifications.

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 about user authorizations for monitoring, see IAM Policies (Monitoring).

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.

Viewing Default Metric Charts for a Single Topic

  1. Open the navigation menu and click Developer Services. Under Application Integration, click Notifications.
    The Topics page opens.
  2. Select a Compartment that you have permissions to work with.
    The page lists topics in the selected compartment.
  3. Click the name of the topic that you want.
    The Topic Details page opens.
  4. Under Resources, click Metrics.

Viewing Default Metric Charts for Multiple Topics

  1. Open the navigation menu and click Observability & Management. Under Monitoring, click Service Metrics.
    The Service Metrics page opens.
  2. Choose a Compartment that you have permission to work in.
  3. For Metric namespace, select oci_notification.
    The Service Metrics page displays the default charts (graphs) for resources in the Notifications service. For more information about the emitted metrics, see the foregoing table (Available Metrics: oci_notification).

Building a Query for Multiple Topics

  1. Open the navigation menu and click Observability & Management. Under Monitoring, click Metrics Explorer.
    The Metrics Explorer page opens with an empty chart (graph) and query.
  2. To change the time range for the query, select the range you want from Quick Selects.
    Alternatively, you can define a custom range by specifying the Start time and End time.
  3. In the query editor, fill in the minimum required fields.
    FieldDescription
    Compartment Select the compartment containing the health checks that you want to view metrics for.
    Metric namespace Select oci_notification.
    Metric name

    Select the metric that you want.

    For example, select DeliveredMessagesCount.

  4. To filter returned data by dimension, select a Dimension value and Dimension value.
    For example, to filter by region, select region from Dimension value and then select the region that you want from Dimension value.
  5. Click Update Chart.
    The chart shows the results of your query.

For more information about building queries in Metrics Explorer, see Building Metric Queries.

For more information about monitoring metrics and using alarms, see Monitoring. For information about notifications for alarms, see Notifications.