Enabling Monitoring for Compute Instances

Compute instance metrics are supported on current platform images and on custom images that are based on current platform images.

If you use an older platform image, you must manually install the Oracle Cloud Agent software before you can use the Compute Instance Monitoring plugin. Select an image dated after November 15, 2018 (except Ubuntu, which must be dated after February 28, 2019).

You might have success enabling compute instance metrics on other images that support the Oracle Cloud Agent software, though the Compute Instance Monitoring plugin has not been tested on other operating systems and there is no guarantee that it will work.

For administrators: For more information about the IAM policies that are needed to create and update a compute instance, see Creating an Instance.

• Service gateways or public IP addresses: The compute instance must have either a public IP address or a service gateway to be able to send compute instance metrics to the Monitoring service.

  If the instance does not have a public IP address, set up a service gateway on the virtual cloud network (VCN). The service gateway lets the instance send compute instance metrics to the Monitoring service without the traffic going over the internet. Here are special notes for setting up the service gateway to access the Monitoring service:

  • When creating the service gateway, enable the service label called All <region> Services in Oracle Services Network. It includes the Monitoring service.
  • When setting up routing for the subnet that contains the instance, set up a route rule with Target Type set to Service Gateway, and the Destination Service set to All <region> Services in Oracle Services Network.

  For detailed instructions, see Access to Oracle Services: Service Gateway.

• Oracle Cloud Agent: The Oracle Cloud Agent software must be installed on the instance. Oracle Cloud Agent is installed by default on current platform images. For steps to manually install Oracle Cloud Agent on older images, see Installing the Oracle Cloud Agent Software.
• Compute Instance Monitoring plugin: For the instance to emit the compute instance metrics, the Compute Instance Monitoring plugin must be enabled on the instance and plugins must be running. For more information about how to enable and run plugins, see Oracle Cloud Agent.

To configure a new compute instance to emit the compute instance metrics, use the following steps.

{
  "agentConfig": {
    "isMonitoringDisabled": false,
    "areAllPluginsDisabled": false,
    "pluginsConfig": [
      {
        "name": "Compute Instance Monitoring",
        "desiredState": "ENABLED"
      }
    ]
  }
}

For an instance to emit the compute instance metrics, the Compute Instance Monitoring plugin must be enabled on the instance and plugins must be running.

If you want to temporarily prevent the instance from emitting compute instance metrics, you can disable the Compute Instance Monitoring plugin. You can also stop all of the plugins that run on the instance, including the Compute Instance Monitoring plugin.

For more information about how to enable and run plugins, see Oracle Cloud Agent.

To determine whether Monitoring is receiving the compute instance metrics, you can either query the instance metrics, or view the instance properties to confirm that the Compute Instance Monitoring plugin is enabled and running.

{
  "agentConfig": {
    "isMonitoringDisabled": false,
    "areAllPluginsDisabled": false,
    "pluginsConfig": [
      {
        "name": "Compute Instance Monitoring",
        "desiredState": "ENABLED"
      }
    ]
  }
}