Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace MetricData

The set of aggregated data returned for a metric. For information about metrics, see Metrics Overview.

Limits information for returned data follows.

Data points: 100,000. * Metric streams* within data points: 2,000. * Time range returned for 1-day resolution: 90 days. * Time range returned for 1-hour resolution: 90 days. * Time range returned for 5-minute resolution: 30 days. * Time range returned for 1-minute resolution: 7 days.

A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. Metric streams cannot be aggregated across metric groups. A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. For more information about metric-related concepts, see [Monitoring Concepts](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).

Properties

aggregatedDatapoints

aggregatedDatapoints: Array<AggregatedDatapoint>

The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. For important limits information related to data points, see MetricData Reference at the top of this page.

compartmentId

compartmentId: string

The OCID of the compartment containing the resources that the aggregated data was returned from.

dimensions

dimensions: object

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

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

Type declaration

  • [key: string]: string

Optional metadata

metadata: undefined | object

The references provided in a metric definition to indicate extra information about the metric.

Example: {@code \"unit\": \"bytes\"}

name

name: string

The name of the metric.

Example: {@code CpuUtilization}

namespace

namespace: string

The reference provided in a metric definition to indicate the source service or application that emitted the metric.

Example: {@code oci_computeagent}

Optional resolution

resolution: undefined | string

The time between calculated aggregation windows. Use with the query interval to vary the frequency for returning aggregated data points. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: {@code 1m}-{@code 60m}, {@code 1h}-{@code 24h}, {@code 1d}.

Example: {@code 5m}

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

getJsonObj