Help Docs

OCI Cache monitoring

OCI Cache is a managed in-memory caching service that supports Redis and Valkey. A cache cluster has one primary node that handles read and write operations and can have up to four replica nodes for read-only operations. Oracle recommends three or more nodes for high availability.

Site24x7 integrates with OCI Cache to help you monitor cluster health, resource utilization, client activity, network traffic, and replication performance.

Overview

Site24x7's OCI Cache integration provides monitoring at both the cluster and node levels. When you integrate OCI Cache with Site24x7, the following monitors are available:

  • Cache Cluster: Monitors cluster-level metrics, including CPU utilization, memory utilization, connected clients, keyspace activity, network traffic, replication lag, and cluster status.
  • Cache Node: Monitors individual cache nodes to provide visibility into resource utilization and node-level activity.

The integration supports Cache Cluster monitors. Cache Node monitors are associated with the cluster and are added as hidden monitors.

Use case

Applications use OCI Cache to store frequently accessed data and reduce response times. As application traffic increases, the cache may experience higher CPU and memory utilization, more connected clients, or an increase in evicted keys. Site24x7 helps you monitor these metrics and configure thresholds to identify resource constraints before they affect application performance.

For replicated deployments, you can monitor replication lag and cross-region replication metrics to identify synchronization issues. Cluster status metrics also help you detect failed states and ongoing configuration or resize operations.

Benefits of OCI Cache integration

Site24x7's OCI Cache integration provides the following benefits:

  • Cluster health monitoring: Track cluster status and identify failed or ongoing update operations.
  • Resource utilization monitoring: Monitor CPU, memory, and connected clients to identify increasing resource demand.
  • Cache activity monitoring: Track keyspace hits, keyspace misses, expired keys, and evicted keys to understand cache activity.
  • Replication monitoring: Monitor replication lag, primary replica offset, cross-region replication lag, and master link status.
  • Network monitoring: Track network traffic at the cluster and node levels.
  • Proactive alerting: Configure thresholds for supported metrics and receive alerts when values breach defined limits.
  • Centralized monitoring: View cache cluster and node performance from the Site24x7 console.

Setup and configuration

To get started with OCI Cache monitoring, complete the following setup steps:

  1. Site24x7 uses cross-tenancy access to monitor OCI resources using the Site24x7 tenancy user. Create the required OCI policy to allow Site24x7 to view your resources.
  2. Log in to your Site24x7 account and navigate to Cloud > OCI > Integrate OCI Monitor.
  3. On the Integrate OCI Monitor page, select Cache Cluster from the Services to be discovered list.

Permissions

Ensure that Site24x7 receives the following permissions to monitor OCI Cache clusters:

  • ListRedisClusters
  • GetRedisCluster
  • ListRedisClusterNodes

Learn more about the policies and permissions required for OCI monitoring.

Polling frequency

Site24x7 queries OCI service level APIs according to the configured polling frequency, which can range from once a minute to once a day, to collect performance data and metadata from OCI Cache monitors.

Supported metrics

The supported metrics for OCI Cache monitors are given below. You can also view the complete list of supported OCI metrics across all monitored services.

Cache Cluster

Metric name Description Statistics Unit
Connected Clients Number of clients connected to the cache cluster. Sum Count
CPU Utilization Percentage of CPU capacity used by the cache cluster. Mean Percentage
Memory Utilization Percentage of memory used by the cache cluster. Mean Percentage
Used Memory Amount of memory used by the cache cluster. Sum Bytes
Evicted Keys Number of keys evicted when the cache reaches its memory limit. Sum Count
Expired Keys Number of keys that have expired. Sum Count
Keyspace Hits Number of successful key lookups. Sum Count
Keyspace Misses Number of key lookups that did not find a key. Sum Count
Network Receive Bytes Number of bytes received by the cache cluster. Sum Bytes
Network Transmit Bytes Number of bytes transmitted by the cache cluster. Sum Bytes
Primary Replica Offset Replication offset reported for the primary replica. Maximum Bytes
Replication Lag Replication lag reported by the cache cluster. Maximum Seconds
Cross Region Replication Lag Replication lag between regions. Maximum Seconds
Cross Region Master Link Status Status of the cross-region master link. Minimum Count
Node Count Number of nodes in the cache cluster. Average Count
Shard Count Number of shards in the cache cluster. Average Count
Memory Per Node (GB) Memory capacity configured for each node. Average GB
Total Cluster Memory (GB) Total memory capacity configured for the cluster. Average GB
Keyspace Hit Ratio Ratio of keyspace hits to total keyspace lookups, expressed as a percentage. Average Percentage

Cache Node

Metric name Description Statistics Unit
Connected Clients Number of clients connected to the cache node. Mean Count
CPU Utilization Percentage of CPU capacity used by the cache node. Mean Percentage
Memory Utilization Percentage of memory used by the cache node. Mean Percentage
Used Memory Amount of memory used by the cache node. Mean Bytes
Evicted Keys Number of keys evicted by the cache node. Sum Count
Expired Keys Number of keys that have expired on the cache node. Sum Count
Keyspace Hits Number of successful key lookups on the cache node. Sum Count
Keyspace Misses Number of key lookups that did not find a key on the cache node. Sum Count
Network Receive Bytes Number of bytes received by the cache node. Sum Bytes
Network Transmit Bytes Number of bytes transmitted by the cache node. Sum Bytes
Primary Replica Offset Replication offset reported for the node. Maximum Bytes
Replication Lag Replication lag reported for the node. Maximum Seconds
Cross Region Replication Lag Replication lag between regions. Maximum Seconds
Cross Region Master Link Status Status of the cross-region master link for the node. Minimum Count

Threshold configuration

To configure thresholds for OCI Cache monitors:

  1. Log in to your Site24x7 account and navigate to Admin > Configuration Profiles > Threshold and Availability.
  2. Click Add Threshold Profile.
  3. Select the applicable monitor type from the Monitor Type drop-down menu. The applicable monitor types are Cache Cluster and Cache Node.
  4. Provide an appropriate name in the Display Name field.
  5. The supported metrics are displayed in the Threshold Configuration section. You can set threshold values for the supported metrics.
  6. Click Save.

Learn more about notifications and threshold profiles for OCI monitoring.

Custom metrics and status alerts

Custom metrics provide additional visibility into node count, shard count, memory capacity, and keyspace hit ratio.

Configure toggle-type thresholds for the following options to receive alerts when the corresponding state is reported:

  • Notify When Cache Cluster Is in Failed Status: Enable this option to identify when the cluster enters a failed state. This can occur when provisioning fails or an unsupported action is attempted.
  • Notify When Cache Cluster Is in Updating Status: Enable this option to identify when a configuration change, resize operation, or cluster update is being applied asynchronously.

Capacity planning

Capacity planning is available for Cache Cluster monitors and helps you understand how cache resources are being utilized over time. Use the CPU utilization, memory utilization, used memory, connected clients, and network traffic metrics to identify sustained increases in resource consumption. Reviewing these trends can help you identify cache clusters that are approaching their configured memory or compute limits and plan capacity changes before application performance is affected.

Capacity planning can also help you compare resource usage across monitored cache clusters and identify clusters that consistently operate at higher utilization. Combined with the evicted keys and keyspace hit ratio metrics, this gives you better visibility into whether the configured memory per node is sufficient for your workload and how your cache requirements may grow based on historical monitoring data.

You can also use metric forecasting to project future resource requirements for your cache clusters.

Monitor Groups

Monitor groups can also be used to view the overall status of related OCI Cache monitors and streamline day-to-day monitoring. You can add or remove monitors from groups as your cache environment changes.

For example, you can create separate monitor groups for production and development cache environments, or group the Cache Cluster and its associated Cache Node monitors for a particular application. This makes it easier to identify issues affecting a specific environment or application without reviewing individual monitors separately.

You can organize your OCI Cache monitors into monitor groups based on your application, environment, business unit, region, or other operational requirements. Grouping related monitors provides a consolidated view of their availability and performance from a single location. You can also use tag-based monitoring to automatically organize monitors into groups using native Oracle tags.

Licensing

  • Each OCI Cache Cluster monitor utilizes one basic monitor license.
  • Each OCI Cache Node monitor utilizes one basic monitor license.

Viewing OCI Cache data

To monitor your OCI Cache environment, log in to the Site24x7 console and navigate to Cloud > OCI > Cache Cluster. Select the required Cache Cluster monitor from the discovered monitors list.

Monitor data

The monitor data for each OCI Cache monitor is given below.

Cache Cluster

The monitor data for the Cache Cluster monitor is given below.

Summary

The Summary tab provides an overview of the monitor's availability, downtime, and events timeline. It also displays performance metrics in charts, including CPU utilization, memory utilization, keyspace hits, and keyspace misses. Use these charts to track resource usage and cache activity over the selected time period.

Nodes

The Nodes tab displays the cache nodes associated with the cluster, along with their status and key performance metrics. These include connected clients, CPU utilization, memory utilization, and used memory. You can use this tab to review individual node performance and identify nodes experiencing higher resource utilization.

Configuration

The Configuration tab displays the cluster's configuration details, including the region, display name, lifecycle state, compartment ID, creation and update times, software version, cluster mode, node count, shard count, total nodes, and memory per node. It also provides endpoint details, including the primary endpoint FQDN and IP address, replica endpoints, and discovery endpoint.

Outages

The Outages tab provides details on an outage's start time, end time, duration, and comments, if any.

Notes

The Notes tab provides details and notes associated with the monitor.

Log Report

The Log Report tab provides a consolidated report of the Cache Cluster monitor's log status, which can be downloaded as a CSV file.

Alert Logs

The Alert Logs tab displays a chronological list of all triggered alerts related to the Cache Cluster monitor.

Audit Logs

The Audit Logs tab provides audit information for actions and changes associated with the monitor.

Cache Node

The monitor data for the Cache Node monitor is given below.

Summary

The Summary tab provides an overview of the node's availability, downtime, and events timeline. It also displays performance metrics in charts, including connected clients, CPU utilization, memory utilization, and used memory. Use these charts to track resource utilization and client activity on the individual node over the selected time period.

Configuration

The Configuration tab displays the node's configuration details, including the region, display name, node name, private endpoint FQDN, private endpoint IP address, shard number, cluster ID, cluster name, lifecycle state, compartment ID, cluster mode, software version, memory per node, subnet ID, and creation time. Use these details to identify the node, understand its configuration, and locate the associated cache cluster and network endpoints.

Outages

The Outages tab provides details on an outage's start time, end time, duration, and comments, if any.

Notes

The Notes tab provides details and notes associated with the monitor.

Log Report

The Log Report tab provides a consolidated report of the monitor's log status, which can be downloaded as a CSV file.

Alert Logs

The Alert Logs tab displays a chronological list of all triggered alerts related to the node.

Audit Logs

The Audit Logs tab provides audit information for actions and changes associated with the monitor.

Related topics

Was this document helpful?

Would you like to help us improve our documents? Tell us what you think we could do better.


We're sorry to hear that you're not satisfied with the document. We'd love to learn what we could do to improve the experience.


Thanks for taking the time to share your feedback. We'll use your feedback to improve our online help resources.

Shortlink has been copied!