Metrics

You monitor the health, capacity, and performance of OpenSearch clusters by using metrics, alarms, and notifications.

See Available Metrics for a list of OCI Search with OpenSearch metrics.

Metrics Terminology

Namespace
A namespace is a container for metrics. The namespace identifies the service sending the metrics. The namespace for OCI Cache is oci_redis.
Metrics
Metrics are the fundamental concept in telemetry and monitoring. Metrics define a time-series set of datapoints. Each metric has a namespace, metric name, compartment identifier, one or more dimensions, and a unit of measure. Each datapoint has a timestamp, value, and count associated with it.
Dimensions
A dimension is a key-value pair that defines the characteristics associated with the metric. For example, resourceId is the OCID of the resource that was scanned.
Statistics
Statistics are metric data aggregations over specified periods of time. Aggregations are done using the namespace, metric name, dimensions, and the data point unit of measure within the time period specified.
Alarms
Alarms are used to automate operations monitoring and performance. An alarm tracks changes that occur over a specific time period and performs one or more defined actions, based on the rules defined for the metric.

IAM Policy for Metrics

To monitor resources in Oracle Cloud Infrastructure, you must be given the required type of access in a policy (IAM)  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 and 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 were granted and which compartment  you're supposed to 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 any cluster that you create. You don't need to enable monitoring on the resource to get these metrics. Metrics are per cluster node, unless otherwise specified.

Metric Metric Display Name Unit Description Resource Type
CPUUtilization CPU Utilization Percentage CPU Percentage used for the cluster. Cluster
JVMMemoryPressure JVM Memory Pressure Percentage Percent of heap space in use over time for the cluster. Cluster
CurrentClusterStorage Current Cluster Storage GB Total storage of the cluster. Cluster
IndexingRate Indexing Rate Operations/Min Total indexing operations per minute Cluster
SearchRate Search Rate Operations/Min Total search operations per minute. Cluster
IndexingLatency Indexing Latency Milliseconds Indexing latency over time. The amount of time it takes for new information to become available in the index. Cluster
SearchLatency Search Latency Milliseconds Search latency over time. Cluster