Options
All
  • Public
  • Public/Protected
  • All
Menu

Module MetricDataDetails

A metric object containing raw metric data points to be posted to the Monitoring service.

Properties

compartmentId

compartmentId: string

The OCID of the compartment to use for metrics.

datapoints

datapoints: Array<Datapoint>

A list of metric values with timestamps. At least one data point is required per call.

dimensions

dimensions: object

Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. A valid dimension key includes only printable ASCII, excluding periods (.) and spaces. The character limit for a dimension key is 256. A valid dimension value includes only Unicode characters. The character limit for a dimension value is 256. Empty strings are not allowed for keys or values. Avoid entering confidential information.

Example: `\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"`

Type declaration

  • [key: string]: string

Optional metadata

metadata: undefined | object

Properties describing metrics. These are not part of the unique fields identifying the metric. Each metadata item takes the form of a key-value pair. The character limit for a metadata key is 256. The character limit for a metadata value is 256.

Example: `\"unit\": \"bytes\"`

name

name: string

The name of the metric.

A valid name value starts with an alphabetical character and includes only alphanumeric characters, dots, underscores, hyphens, and dollar signs. The `oci_` prefix is reserved. Avoid entering confidential information.

Example: `my_app.success_rate`

namespace

namespace: string

The source service or application emitting the metric.

A valid namespace value starts with an alphabetical character and includes only alphanumeric characters and underscores. The \"oci_\" prefix is reserved. Avoid entering confidential information.

Example: `my_namespace`

Optional resourceGroup

resourceGroup: undefined | string

Resource group to assign to the metric. A resource group is a custom string that can be used as a filter. 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 ($). Avoid entering confidential information.

Example: `frontend-fleet`

Functions

getJsonObj