How to Set Up OCI Monitoring

How to Set Up OCI Monitoring

Setup Guide

How to Set Up OCI Monitoring

Connect your Oracle Cloud Infrastructure (OCI) account to Cloudmon using a read-only API key. Once connected, Cloudmon auto-discovers your Compute Instances and begins collecting metrics in real time.

Overview

Oracle Cloud Infrastructure (OCI) is Oracle's cloud platform, providing hosted compute, storage, networking, and database services over the internet. Organisations use OCI to run workloads without managing physical hardware, with resources deployed across Oracle's global network of data centres.</p> <p>This guide walks you through connecting your OCI account to Cloudmon for the first time. The setup involves generating an API key for a user in the OCI console, followed by entering that user's credentials into Cloudmon. Once complete, Cloudmon will have read-only access to your OCI tenancy and will automatically discover your Compute Instances.

Prerequisites

Before you begin, ensure the following are in place:

RequirementDescription
OCI account accessYou must be able to sign in to the OCI console as the user whose API key will be used, or have an administrator generate one for you
Cloudmon accountAn active Cloudmon account with Cloud Monitoring enabled
Compartment accessKnow the OCID of the compartment containing the Compute Instances you want to monitor

How It Works

Cloudmon connects to your OCI tenancy using an API key associated with a specific OCI user. This key is used to authenticate read-only API calls to OCI on a recurring schedule, pulling Compute Instance metrics, resource lists, and configuration data. Nothing is installed inside your OCI environment, and no Cloudmon probe is required: the connection is made directly from the Cloudmon Controller using the credentials you provide.


Configuration Steps

Step 1: Identify the User and Compartment

Decide which OCI user's API key Cloudmon will use, and which compartment holds the Compute Instances to be monitored. Note down the following from the OCI console, you will need these in Step 3:

  • User OCID: found on the user's details page under Identity & Security → Users → [select user]
  • Compartment OCID: found on the compartment's details page under Identity & Security → Compartments → [select compartment]

Step 2: Generate an API Key

Follow the Oracle documentation to generate an API signing key pair for the user identified in Step 1 and upload the public key in the OCI console: How to Generate an API Signing Key, Oracle documentation

Once the key is added, note down the following, you will need these in Step 3:

  • Fingerprint: shown next to the API key once it is added under the user's API Keys section
  • Private key file (.pem): the private key file generated alongside the public key, downloaded to your machine during key creation
Notes

Important: The private key file is only available to download at the time it is generated. Store it securely; you will need to upload it into Cloudmon in Step 3.

Step 3: Add Your OCI Account in Cloudmon

  1. Log in to your Cloudmon dashboard
  2. Navigate to Cloud → OCI → Add OCI Account
  3. The Add OCI panel opens, organized into four sections: Monitor Details, Discovery Settings, Resource Management, and Configuration Details

Monitor Details: basic details and connection credentials.

FieldDescription
Display Name*A friendly name for this OCI account, e.g. "OCI Production"
Region*The OCI region this account's resources are deployed in
Compartment ID*The Compartment OCID identified in Step 1
User OCID*The User OCID identified in Step 1
Fingerprint*The fingerprint generated in Step 2
Private key file (.pem)*Click Choose PEM file and upload the private key file downloaded in Step 2

Discovery Settings: services and discovery settings.

FieldDescription
Services to be discovered*OCI Compute Instance is currently the only supported service
Enable auto-discoveryEnabled by default. Automatically discovers OCI VM resources on a recurring schedule
Rediscovery IntervalHow frequently Cloudmon re-scans the account for new or removed resources. Defaults to 6 Hours
Notify on DiscoveryToggle on to receive a notification once new resources are discovered

Resource Management: monitoring options.

FieldDescription
Mute Resource Termination AlertsToggle on to stop triggering alerts when a resource is deleted in OCI
Monitor terminated resourcesToggle on to keep terminated resources visible in monitoring
Automatically Remove Terminated ResourcesEnabled by default. Auto-deletes terminated VM monitors after the configured retention period
Remove Terminated Resources After*How long a terminated resource's monitor is retained before removal. Defaults to 7 Days. Only visible when automatic removal is enabled
Include/Exclude Resources based on TagsChoose whether OCI tags exclude matching resources from discovery or include only matching resources

Configuration Details: groups and tags.

FieldDescription
GroupsOptional groups to organise this account alongside others
TagsOptional tags to associate with this OCI account

Alert Settings: notification and alert configuration.

FieldDescription
User GroupsThe user groups to notify when an alert is raised on any resource discovered under this account
Third Party ServicesThird-party integrations to use for alert notifications on resources discovered under this account
  1. Click Save
  2. Cloudmon will validate the credentials and begin discovering OCI Compute Instances in the selected region and compartment

Step 4: Verify the Connection

After saving, navigate to Cloud → OCI → [Your Account]. If the connection is successful, your discovered OCI Compute Instances will begin populating within a few minutes. If resources do not appear, use the Rediscover button on the account page to trigger a manual scan.


Troubleshooting

IssueLikely CauseResolution
No resources discovered after savingIncorrect Compartment ID, User OCID, Fingerprint, or private key, or the API key is not registered for that user in OCIRe-check the credentials in the OCI console under the user's API Keys, and confirm the Region and Compartment ID are correct
Authentication error on saveThe Fingerprint does not match the uploaded private key, or the private key file is corruptedRe-generate the API key pair in OCI and re-upload the matching Fingerprint and private key in Cloudmon
Compute Instances in the compartment are not appearingWrong Compartment ID, or the instances are in a different region than the one configuredConfirm the Compartment OCID and Region match where the instances are actually deployed in the OCI console
Resources not updatingEnable auto-discovery is off, or the Rediscovery Interval has not elapsed yetNavigate to Cloud → OCI → [Account] and click Rediscover, or edit the account to enable auto-discovery

    • Related Articles

    • OCI Instances Monitoring

      OCI Monitoring OCI Instances Monitoring Monitor Oracle Cloud Infrastructure (OCI) Compute Instances using read-only API key credentials. Cloudmon auto-discovers your instances and begins collecting metrics in real time. Overview OCI (Oracle Cloud ...
    • Cloud Monitoring

      Cloud Monitoring Cloud Monitoring Monitor your AWS, Azure, GCP, and OCI infrastructure from a single platform. Track availability, performance, and cost across cloud providers without leaving Cloudmon. Cloudmon integrates with AWS, Microsoft Azure, ...
    • How to Set Up Azure Monitoring

      Setup Guide How to Set Up Azure Monitoring in Cloudmon Connect your Azure account to Cloudmon using a registered Azure AD application. Once connected, Cloudmon auto-discovers your resources and begins collecting metrics in real time. Overview ...
    • How to configure a Monitoring Profile for an agent in cloudmon?

      By default, the monitoring profile default is configured for every entity. The default profile includes all the metrics for monitoring and can be modified if required. Follow the steps to change the profile from default to the user-defined profile ...
    • Agent Vs Agentless Monitoring in cloudmon

      Attribute Agent-based Monitoring Agentless Monitoring – SNMP, WMI, TCP, ICMP Methodology Deploy the Cloudmon Agent on each server that requires monitoring. Cloudmon uses Probes to monitor IP network endpoints and devices in the network such as ...