CustomMetric

class oci.apm_traces.models.CustomMetric(**kwargs)

Bases: object

Definition of the Custom Metric.

Methods:

__init__(**kwargs)

Initializes a new CustomMetric object with values from keyword arguments.

Attributes:

compartment

Gets the compartment of this CustomMetric.

description

Gets the description of this CustomMetric.

is_anomaly_detection_enabled

Gets the is_anomaly_detection_enabled of this CustomMetric.

is_metric_published

Gets the is_metric_published of this CustomMetric.

name

[Required] Gets the name of this CustomMetric.

namespace

Gets the namespace of this CustomMetric.

resource_group

Gets the resource_group of this CustomMetric.

unit

Gets the unit of this CustomMetric.

__init__(**kwargs)

Initializes a new CustomMetric 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 CustomMetric.

  • name (str) – The value to assign to the name property of this CustomMetric.

  • description (str) – The value to assign to the description property of this CustomMetric.

  • resource_group (str) – The value to assign to the resource_group property of this CustomMetric.

  • is_anomaly_detection_enabled (bool) – The value to assign to the is_anomaly_detection_enabled property of this CustomMetric.

  • compartment (str) – The value to assign to the compartment property of this CustomMetric.

  • unit (str) – The value to assign to the unit property of this CustomMetric.

  • is_metric_published (bool) – The value to assign to the is_metric_published property of this CustomMetric.

property compartment

Gets the compartment of this CustomMetric. Compartment of the Monitoring Service. It defaults to the APM domain’s compartment if not specified. If specified, the necessary OCI policies should be set to allow APM to write to that compartment.

Returns

The compartment of this CustomMetric.

Return type

str

property description

Gets the description of this CustomMetric. Description of the Custom Metric.

Returns

The description of this CustomMetric.

Return type

str

property is_anomaly_detection_enabled

Gets the is_anomaly_detection_enabled of this CustomMetric. Indicates whether anomaly Detection should be performed on the generated metric.

Returns

The is_anomaly_detection_enabled of this CustomMetric.

Return type

bool

property is_metric_published

Gets the is_metric_published of this CustomMetric. Used in conjunction with the dry run header. When the dry run header is set and the isPublishMetric flag is set to true, the scheduled query is not created, but validations happen to check if the right OCI policies have been set to write to the specified namespace/compartment.

Returns

The is_metric_published of this CustomMetric.

Return type

bool

property name

[Required] Gets the name of this CustomMetric. Name of the Custom Metric.

Returns

The name of this CustomMetric.

Return type

str

property namespace

Gets the namespace of this CustomMetric. Namespace in the Custom Metric. It defaults to oracle_apm_custom if not specified. If specified, the necessary OCI policies should be set to allow APM to write to that namespace.

Returns

The namespace of this CustomMetric.

Return type

str

property resource_group

Gets the resource_group of this CustomMetric. Resource Group of the Custom Metric.

Returns

The resource_group of this CustomMetric.

Return type

str

property unit

Gets the unit of this CustomMetric. Unit in which the metric value is reported. For example ‘ms’.

Returns

The unit of this CustomMetric.

Return type

str