Class MetricDataDetails

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

Inheritance

object

MetricDataDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MonitoringService.Models

Assembly: OCI.DotNetSDK.Monitoring.dll

Syntax

public class MetricDataDetails

Properties

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 to use for metrics.

Remarks

Required

Datapoints

Declaration

[Required(ErrorMessage = "Datapoints is required.")]
[JsonProperty(PropertyName = "datapoints")]
public List<Datapoint> Datapoints { get; set; }

Property Value

Type	Description
List<Datapoint>	A list of metric values with timestamps. At least one data point is required per call. For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future).

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 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 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 512. Empty strings are not allowed for keys or values. Avoid entering confidential information. Example: {"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}

Type

Description

Dictionary<string, string>

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 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 512. Empty strings are not allowed for keys or values. Avoid entering confidential information.
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>	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

Declaration

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

Property Value

Type	Description
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. Avoid entering confidential information. Example: my_app.success_rate

Remarks

Required

Namespace

Declaration

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

Property Value

Type	Description
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. Custom metrics can't use the following reserved prefixes: `oci_` and `oracle_` Avoid entering confidential information. Example: my_namespace

Remarks

Required

ResourceGroup

Declaration

[JsonProperty(PropertyName = "resourceGroup")]
public string ResourceGroup { get; set; }

Property Value

Type	Description
string	Resource group to assign to the 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 ($). Avoid entering confidential information. Example: frontend-fleet

Type

Description

string

Resource group to assign to the 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 ($). Avoid entering confidential information.
Example: frontend-fleet