Oracle Cloud Infrastructure Documentation

Management Agent Metrics

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

For more information, see Monitoring Overview and Notification Overview.

This topic describes the metrics emitted by the Management Agent service in the oci_managementagent metric namespace.

Overview of the Management Agent Service Metrics

Management Agent provides a unidirectional pipe that allows Oracle Cloud Infrastructure native services to interact with the customer VM securely. The agent operates in the simplest of network topologies without requiring any special configuration on the VMs. The agent provides an extensible model for Oracle Cloud Infrastructure native services to collect performance metrics and execute work.

Service metrics for the Management Agent resource allow the users to visualize the resource consumption of the agent in terms of CPU, memory and disk.

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 on user authorizations for monitoring, see the Authentication and Authorization section for the related service: Monitoring or Notifications. For information on policies for management agents, see Set Up Oracle Cloud Infrastructure for Management Agents.

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

Available Metrics: oci_managementagent

The Management Agent service emits metrics to oci_managementagent metric namespace in Monitoring service.

The metrics listed in the following tables are automatically available for management agents that you install. You do not need to enable monitoring to get these metrics. You also can use the Monitoring service to create custom queries.

Dimensions

Management Agent metrics include the following dimensions:

  • AGENTHOSTNAME: The hostname in which the management agent is installed.

  • RESOURCEID: The OCID of the management agent resource.

Metrics

Metric Name Metric Display Name Unit Frequency Description Dimensions
agentHealthStatus Agent Health Status Not Applicable 1 minute

Agent is alive and it's communicating with the Monitoring service.

The status value is a constant number (1) to represent that the agent is alive and is able to upload to Monitoring service. The absence of data points in Monitoring service implies that the agent cannot communicate with Monitoring service. It should not imply that the agent is down.

agentHostName

resourceId
diskUsageUsed Agent Disk Usage Megabytes 1 hour Total amount of disk used under "agent_inst".

agentHostName

resourceId
diskUsageFree Agent Disk Space Available Megabytes 1 hour Amount of disk space available on the volume.

agentHostName

resourceId
diskUsageInstallSize Disk Usage for Install Megabytes 1 hour Total amount of disk used under agentBaseDir.

agentHostName

resourceId
uploadBufferPctusedofmaxbuffer Percentage of Temporary Storage Used Percent 15 minutes Amount of disk space used by the agent to temporarily store content while waiting for Monitoring service to be available. This number is expressed as a percentage of the maximum limit at the agent (Default limit: 100 MB).

agentHostName

resourceId
usageCpu Agent CPU Utilization Percent 1 minute Percentage CPU usage of the agent.

agentHostName

resourceId
usageRss Agent Memory Usage Megabytes 1 minute Amount of memory consumed by the agent's JVM. This number represents the resident set size in main memory.

agentHostName

resourceId
Note

The alarm interval must be greater than the frequency at which the metrics are emitted. Be sure to set alarm intervals greater than the frequency at which the metrics are emitted.

Using the Console

To view the default metrics for a single Management Agent, you can use Service Metrics.

  1. Open the navigation menu. Under Observability & Management, go to Monitoring and click Service Metrics.

  2. For Metric Namespace, select oci_managementagent.

  3. For Dimensions, specify resourceId and select the OCID of the management agent for which you want to display service metrics.

The page displays charts for the metrics that are emitted by the Management Agent.

Using the API

For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.

Use the following APIs for monitoring: