MacsApmExtension

class oci.apm_config.models.MacsApmExtension(**kwargs)

Bases: Config

An object that represents APM Agent provisioning via a Management Agent.

Attributes:

CONFIG_TYPE_AGENT

A constant which can be used with the config_type property of a Config.

CONFIG_TYPE_APDEX

A constant which can be used with the config_type property of a Config.

CONFIG_TYPE_MACS_APM_EXTENSION

A constant which can be used with the config_type property of a Config.

CONFIG_TYPE_METRIC_GROUP

A constant which can be used with the config_type property of a Config.

CONFIG_TYPE_OPTIONS

A constant which can be used with the config_type property of a Config.

CONFIG_TYPE_SPAN_FILTER

A constant which can be used with the config_type property of a Config.

agent_version

Gets the agent_version of this MacsApmExtension.

attach_install_dir

Gets the attach_install_dir of this MacsApmExtension.

config_type

[Required] Gets the config_type of this Config.

created_by

Gets the created_by of this Config.

defined_tags

Gets the defined_tags of this Config.

display_name

Gets the display_name of this MacsApmExtension.

etag

Gets the etag of this Config.

freeform_tags

Gets the freeform_tags of this Config.

id

Gets the id of this Config.

management_agent_id

Gets the management_agent_id of this MacsApmExtension.

process_filter

Gets the process_filter of this MacsApmExtension.

run_as_user

Gets the run_as_user of this MacsApmExtension.

service_name

Gets the service_name of this MacsApmExtension.

time_created

Gets the time_created of this Config.

time_updated

Gets the time_updated of this Config.

updated_by

Gets the updated_by of this Config.

Methods:

__init__(**kwargs)

Initializes a new MacsApmExtension 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 Config. This constant has a value of “AGENT”

CONFIG_TYPE_APDEX = 'APDEX'

A constant which can be used with the config_type property of a Config. 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 Config. 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 Config. 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 Config. 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 Config. This constant has a value of “SPAN_FILTER”

__init__(**kwargs)

Initializes a new MacsApmExtension object with values from keyword arguments. The default value of the config_type attribute of this class is MACS_APM_EXTENSION 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 MacsApmExtension.

  • config_type (str) – The value to assign to the config_type property of this MacsApmExtension. 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 MacsApmExtension.

  • time_updated (datetime) – The value to assign to the time_updated property of this MacsApmExtension.

  • created_by (str) – The value to assign to the created_by property of this MacsApmExtension.

  • updated_by (str) – The value to assign to the updated_by property of this MacsApmExtension.

  • etag (str) – The value to assign to the etag property of this MacsApmExtension.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MacsApmExtension.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MacsApmExtension.

  • display_name (str) – The value to assign to the display_name property of this MacsApmExtension.

  • management_agent_id (str) – The value to assign to the management_agent_id property of this MacsApmExtension.

  • process_filter (list[str]) – The value to assign to the process_filter property of this MacsApmExtension.

  • run_as_user (str) – The value to assign to the run_as_user property of this MacsApmExtension.

  • service_name (str) – The value to assign to the service_name property of this MacsApmExtension.

  • agent_version (str) – The value to assign to the agent_version property of this MacsApmExtension.

  • attach_install_dir (str) – The value to assign to the attach_install_dir property of this MacsApmExtension.

property agent_version

Gets the agent_version of this MacsApmExtension. The version of the referenced agent bundle.

Returns

The agent_version of this MacsApmExtension.

Return type

str

property attach_install_dir

Gets the attach_install_dir of this MacsApmExtension. The directory owned by runAsUser.

Returns

The attach_install_dir of this MacsApmExtension.

Return type

str

property config_type

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

Return type

str

property created_by

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

Returns

The created_by of this Config.

Return type

str

property defined_tags

Gets the defined_tags of this Config. 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 Config.

Return type

dict(str, dict(str, object))

property display_name

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

Returns

The display_name of this MacsApmExtension.

Return type

str

property etag

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

Returns

The etag of this Config.

Return type

str

property freeform_tags

Gets the freeform_tags of this Config. 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 Config.

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 Config. The OCID of the configuration item. An OCID is generated when the item is created.

Returns

The id of this Config.

Return type

str

property management_agent_id

Gets the management_agent_id of this MacsApmExtension. The OCID of the Management Agent that will provision the APM Agent.

Returns

The management_agent_id of this MacsApmExtension.

Return type

str

property process_filter

Gets the process_filter of this MacsApmExtension. Filter patterns used to discover active Java processes for provisioning the APM Agent.

Returns

The process_filter of this MacsApmExtension.

Return type

list[str]

property run_as_user

Gets the run_as_user of this MacsApmExtension. The OS user that should be used to discover Java processes.

Returns

The run_as_user of this MacsApmExtension.

Return type

str

property service_name

Gets the service_name of this MacsApmExtension. The name of the service being monitored. This argument enables you to filter by service and view traces and other signals in the APM Explorer user interface.

Returns

The service_name of this MacsApmExtension.

Return type

str

property time_created

Gets the time_created of this Config. 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 Config.

Return type

datetime

property time_updated

Gets the time_updated of this Config. 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 Config.

Return type

datetime

property updated_by

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

Returns

The updated_by of this Config.

Return type

str