MetricDataDetails

class oci.monitoring.models.MetricDataDetails(**kwargs)

Bases: object

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

__init__(**kwargs)

Initializes a new MetricDataDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • namespace (str) -- The value to assign to the namespace property of this MetricDataDetails.
  • resource_group (str) -- The value to assign to the resource_group property of this MetricDataDetails.
  • compartment_id (str) -- The value to assign to the compartment_id property of this MetricDataDetails.
  • name (str) -- The value to assign to the name property of this MetricDataDetails.
  • dimensions (dict(str, str)) -- The value to assign to the dimensions property of this MetricDataDetails.
  • metadata (dict(str, str)) -- The value to assign to the metadata property of this MetricDataDetails.
  • datapoints (list[Datapoint]) -- The value to assign to the datapoints property of this MetricDataDetails.
compartment_id

[Required] Gets the compartment_id of this MetricDataDetails. The OCID of the compartment to use for metrics.

Returns:The compartment_id of this MetricDataDetails.
Return type:str
datapoints

[Required] Gets the datapoints of this MetricDataDetails. A list of metric values with timestamps. At least one data point is required per call.

Returns:The datapoints of this MetricDataDetails.
Return type:list[Datapoint]
dimensions

[Required] Gets the dimensions of this MetricDataDetails. 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"

Returns:The dimensions of this MetricDataDetails.
Return type:dict(str, str)
metadata

Gets the metadata of this MetricDataDetails. 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"

Returns:The metadata of this MetricDataDetails.
Return type:dict(str, str)
name

[Required] Gets the name of this MetricDataDetails. 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

Returns:The name of this MetricDataDetails.
Return type:str
namespace

[Required] Gets the namespace of this MetricDataDetails. 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

Returns:The namespace of this MetricDataDetails.
Return type:str
resource_group

Gets the resource_group of this MetricDataDetails. 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

Returns:The resource_group of this MetricDataDetails.
Return type:str