Oracle Cloud Infrastructure Documentation

Managing Agent Configurations

Use agent configurations to ingest metric data into custom metrics. For example, expose metrics from a virtual machine (VM) using an HTTP endpoint in Prometheus format. An agent configuration uses the agent, or Unified Monitoring Agent, also known as the Oracle Cloud Agent plugin that is called "Custom Logs Monitoring".

Note

The Monitoring API is another way to publish custom metrics.
This image shows agent configurations with metric destinations.

Before You Begin

To publish custom metrics using an agent configuration, an instance must be in a dynamic group, and that dynamic group must be allowed to manage agent configurations and to use metrics.

  1. Install the agent.

  2. Verify that the agent is installed.

  3. Define a dynamic group for the resource or resources.

    Example matching rules:

    To specify an instance by ID:

    All {instance.id = 'ocid1.instance.<region>.<location>.<unique_ID>'}

    To specify all instances in a compartment:

    All {instance.compartmentid = 'ocid1.compartment.<region>..<unique_ID>'}

  4. Grant permissions to the dynamic group to manage agent configurations, and to use agent configurations to publish custom metrics to a metric namespace.

    Example policy:

    Allow dynamic group <group_name> to use metrics in tenancy 
Allow dynamic group <group_name> to manage unified-configuration in tenancy

  5. Set up an input for the agent configuration.

    For example, expose metrics from a virtual machine (VM) using an HTTP endpoint in Prometheus format:

    http://1.2.3.4:9100/metrics

Supported Operating Systems

Following are the operating systems (OSs) supported by agent configurations:

OS non-FIPS FIPS ARM
Oracle Linux 7 Yes Yes Yes
Oracle Linux 8 Yes Yes No
CentOS 7 Yes Yes No
Windows Server 2012 R2 Yes Yes No
Windows Server 2016 Yes Yes No
Windows Server 2019 Yes Yes No
Ubuntu 16.04 Yes No No
Ubuntu 18.04 Yes No No
Ubuntu 20.04 Yes No No