MetricGroupSummary¶

class oci.apm_config.models.MetricGroupSummary(**kwargs)¶

Bases: ConfigSummary

A metric group defines a set of metrics to collect from a span. It uses a span filter to specify which spans to process. The set is then published to a namespace, which is a product level subdivision of metrics.

Attributes:

`CONFIG_TYPE_AGENT`	A constant which can be used with the config_type property of a ConfigSummary.
`CONFIG_TYPE_APDEX`	A constant which can be used with the config_type property of a ConfigSummary.
`CONFIG_TYPE_MACS_APM_EXTENSION`	A constant which can be used with the config_type property of a ConfigSummary.
`CONFIG_TYPE_METRIC_GROUP`	A constant which can be used with the config_type property of a ConfigSummary.
`CONFIG_TYPE_OPTIONS`	A constant which can be used with the config_type property of a ConfigSummary.
`CONFIG_TYPE_SPAN_FILTER`	A constant which can be used with the config_type property of a ConfigSummary.
`config_type`	[Required] Gets the config_type of this ConfigSummary.
`created_by`	Gets the created_by of this ConfigSummary.
`defined_tags`	Gets the defined_tags of this ConfigSummary.
`dimensions`	Gets the dimensions of this MetricGroupSummary.
`display_name`	Gets the display_name of this MetricGroupSummary.
`etag`	Gets the etag of this ConfigSummary.
`filter_id`	Gets the filter_id of this MetricGroupSummary.
`freeform_tags`	Gets the freeform_tags of this ConfigSummary.
`id`	Gets the id of this ConfigSummary.
`metrics`	Gets the metrics of this MetricGroupSummary.
`namespace`	Gets the namespace of this MetricGroupSummary.
`system_tags`	Gets the system_tags of this ConfigSummary.
`time_created`	Gets the time_created of this ConfigSummary.
`time_updated`	Gets the time_updated of this ConfigSummary.
`updated_by`	Gets the updated_by of this ConfigSummary.

Methods:

`__init__`(**kwargs)	Initializes a new MetricGroupSummary object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

CONFIG_TYPE_AGENT = 'AGENT'¶: A constant which can be used with the config_type property of a ConfigSummary. This constant has a value of “AGENT”

CONFIG_TYPE_APDEX = 'APDEX'¶: A constant which can be used with the config_type property of a ConfigSummary. This constant has a value of “APDEX”

CONFIG_TYPE_MACS_APM_EXTENSION = 'MACS_APM_EXTENSION'¶: A constant which can be used with the config_type property of a ConfigSummary. This constant has a value of “MACS_APM_EXTENSION”

CONFIG_TYPE_METRIC_GROUP = 'METRIC_GROUP'¶: A constant which can be used with the config_type property of a ConfigSummary. This constant has a value of “METRIC_GROUP”

CONFIG_TYPE_OPTIONS = 'OPTIONS'¶: A constant which can be used with the config_type property of a ConfigSummary. This constant has a value of “OPTIONS”

CONFIG_TYPE_SPAN_FILTER = 'SPAN_FILTER'¶: A constant which can be used with the config_type property of a ConfigSummary. This constant has a value of “SPAN_FILTER”

__init__(**kwargs)¶

Initializes a new MetricGroupSummary object with values from keyword arguments. The default value of the config_type attribute of this class is METRIC_GROUP and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

id (str) – The value to assign to the id property of this MetricGroupSummary.
config_type (str) – The value to assign to the config_type property of this MetricGroupSummary. Allowed values for this property are: “SPAN_FILTER”, “METRIC_GROUP”, “APDEX”, “OPTIONS”, “AGENT”, “MACS_APM_EXTENSION”
time_created (datetime) – The value to assign to the time_created property of this MetricGroupSummary.
time_updated (datetime) – The value to assign to the time_updated property of this MetricGroupSummary.
created_by (str) – The value to assign to the created_by property of this MetricGroupSummary.
updated_by (str) – The value to assign to the updated_by property of this MetricGroupSummary.
etag (str) – The value to assign to the etag property of this MetricGroupSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MetricGroupSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MetricGroupSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this MetricGroupSummary.
display_name (str) – The value to assign to the display_name property of this MetricGroupSummary.
filter_id (str) – The value to assign to the filter_id property of this MetricGroupSummary.
namespace (str) – The value to assign to the namespace property of this MetricGroupSummary.
dimensions (list[oci.apm_config.models.Dimension]) – The value to assign to the dimensions property of this MetricGroupSummary.
metrics (list[oci.apm_config.models.Metric]) – The value to assign to the metrics property of this MetricGroupSummary.

property config_type¶

[Required] Gets the config_type of this ConfigSummary. The type of configuration item.

Allowed values for this property are: “SPAN_FILTER”, “METRIC_GROUP”, “APDEX”, “OPTIONS”, “AGENT”, “MACS_APM_EXTENSION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The config_type of this ConfigSummary.
Return type: str

property created_by¶

Gets the created_by of this ConfigSummary. The OCID of a user.

Returns: The created_by of this ConfigSummary.
Return type: str

property defined_tags¶

Gets the defined_tags of this ConfigSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns: The defined_tags of this ConfigSummary.
Return type: dict(str, dict(str, object))

property dimensions¶

Gets the dimensions of this MetricGroupSummary. A list of dimensions for the metric. This variable should not be used.

Returns: The dimensions of this MetricGroupSummary.
Return type: list[oci.apm_config.models.Dimension]

property display_name¶

Gets the display_name of this MetricGroupSummary. The name by which a configuration entity is displayed to the end user.

Returns: The display_name of this MetricGroupSummary.
Return type: str

property etag¶

Gets the etag of this ConfigSummary. For optimistic concurrency control. See if-match.

Returns: The etag of this ConfigSummary.
Return type: str

property filter_id¶

Gets the filter_id of this MetricGroupSummary. The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.

Returns: The filter_id of this MetricGroupSummary.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this ConfigSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns: The freeform_tags of this ConfigSummary.
Return type: dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property id¶

Gets the id of this ConfigSummary. The OCID of the configuration item. An OCID is generated when the item is created.

Returns: The id of this ConfigSummary.
Return type: str

property metrics¶

Gets the metrics of this MetricGroupSummary. The list of metrics in this group.

Returns: The metrics of this MetricGroupSummary.
Return type: list[oci.apm_config.models.Metric]

property namespace¶

Gets the namespace of this MetricGroupSummary. The namespace to which the metrics are published. It must be one of several predefined namespaces.

Returns: The namespace of this MetricGroupSummary.
Return type: str

property system_tags¶

Gets the system_tags of this ConfigSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns: The system_tags of this ConfigSummary.
Return type: dict(str, dict(str, object))

property time_created¶

Gets the time_created of this ConfigSummary. The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

Returns: The time_created of this ConfigSummary.
Return type: datetime

property time_updated¶

Gets the time_updated of this ConfigSummary. The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

Returns: The time_updated of this ConfigSummary.
Return type: datetime

property updated_by¶

Gets the updated_by of this ConfigSummary. The OCID of a user.

Returns: The updated_by of this ConfigSummary.
Return type: str