Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Metric

The properties that define a metric. For information about metrics, see Metrics Overview.

Properties

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment containing the resources monitored by the metric.

Optional dimensions

dimensions: undefined | object

Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.

Example: {@code {\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"}}

Optional name

name: undefined | string

The name of the metric.

Example: {@code CpuUtilization}

Optional namespace

namespace: undefined | string

The source service or application emitting the metric.

Example: {@code oci_computeagent}

Optional resourceGroup

resourceGroup: undefined | string

Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).

Example: {@code frontend-fleet}

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Metric): object

getJsonObj

  • getJsonObj(obj: Metric): object