Oracle Cloud Infrastructure Documentation

Queue Metrics

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

This topic describes the metrics emitted by the Queue service in the oci_queue metric namespace.

Resources: queues.

Overview

The Queue service metrics help you measure the size and health of a queue. You can use metrics data to diagnose and troubleshoot queue issues.

Note

In addition to metrics, you can also get queue statistics.

To view a default set of metrics charts in the Console, navigate to the queue you're interested in, and then click Metrics. You also can use the Monitoring service to create custom queries.

Prerequisites

  • IAM policies: To monitor resources, you must be given the required type of access in a policy (IAM)  written by an administrator. Policies are required for using the Console or the REST API with an SDK, CLI, or other tool. The policy must give you access to the monitoring services and the resources being monitored. When you try to perform an action, you might 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.

  • The metrics listed on this page are automatically available for any queue you create. You do not need to enable monitoring on the resource to get these metrics.

Available Metrics

Queue metrics include the following dimensions:

  • region: The region that the metrics apply to
  • resourceId: The OCID of the queue for which the metric applies
  • queueName: The name of queue that the metrics apply to
  • operation: The type of operation (PUT, GET, UPDATE, DELETE) that the metrics apply to
  • isVisible: Whether or not the metrics apply to a visible message
Metric Metric Display Name Unit Description Dimensions
QueueSize Total bytes in the queue bytes Bytes in the queue

region

resourceId

queueName
MessagesInQueueCount Total messages in the queue count Count of messages in the queue

region

resourceId

queueName

isVisible
MessagesCount Messages transmitted/sec count Count of messages sent and received per queue

region

resourceId

queueName

operation
RequestSuccess Requests success rate/sec boolean Indicates the success of the requests sent and received per queue

region

resourceId

queueName

operation
RequestsLatency Requests latency time (ms) Latency of the requests to the queue

region

resourceId

queueName

operation
RequestsThroughput Requests throughput bytes Bytes sent and received per queue

region

resourceId

queueName

operation
ConsumerLag Consumer lag time (minutes) Difference in time between the oldest message in the queue and the current time

region

resourceId

queueName

Using the Console

To view default metric charts for a single queue

  1. On the Queues list page, select the queue that you want to work with. If you need help finding the list page or the queue, see Listing Queues.
  2. Select Metrics.

    The Metrics page displays a default set of charts for the current queue.

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

To view default metric charts for multiple queues

Here's how you view the metric charts:

  1. Open the navigation menu  and select Observability & Management. Under Monitoring, select Service Metrics.
  2. For Compartment, select the compartment that contains the queues that you're interested in.
  3. For Metric namespace, select oci_queue.

    The Service Metrics page displays a default set of charts for the selected metric namespace. For more information about the emitted metrics, see Available Metrics. You can also use the Monitoring service to create custom queries.

The Service Metrics page dynamically updates the page to show charts for each metric that is emitted by the selected metric namespace.