Class 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.
Inheritance
object
MetricData
Inherited Members
Namespace: Oci.MonitoringService.Models
Assembly: OCI.DotNetSDK.Monitoring.dll
Syntax
public class MetricData

Properties

AggregatedDatapoints

Declaration
[Required(ErrorMessage = "AggregatedDatapoints is required.")]
[JsonProperty(PropertyName = "aggregatedDatapoints")]
public List<AggregatedDatapoint> AggregatedDatapoints { get; set; }
Property Value
Type Description
List<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.
Remarks

Required

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

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

Required

Dimensions

Declaration
[Required(ErrorMessage = "Dimensions is required.")]
[JsonProperty(PropertyName = "dimensions")]
public Dictionary<string, string> Dimensions { get; set; }
Property Value
Type Description
Dictionary<string, string>

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: {"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}
Remarks

Required

Metadata

Declaration
[JsonProperty(PropertyName = "metadata")]
public Dictionary<string, string> Metadata { get; set; }
Property Value
Type Description
Dictionary<string, string>

The references provided in a metric definition to indicate extra information about the metric.
Example: "unit": "bytes"

Name

Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

The name of the metric.
Example: CpuUtilization
Remarks

Required

Namespace

Declaration
[Required(ErrorMessage = "Namespace is required.")]
[JsonProperty(PropertyName = "namespace")]
public string Namespace { get; set; }
Property Value
Type Description
string

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

Required

Resolution

Declaration
[JsonProperty(PropertyName = "resolution")]
public string Resolution { get; set; }
Property Value
Type Description
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: 1m-60m, 1h-24h, 1d.
Example: 5m

ResourceGroup

Declaration
[JsonProperty(PropertyName = "resourceGroup")]
public string ResourceGroup { get; set; }
Property Value
Type Description
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: frontend-fleet