Apdex

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

Bases: object

An Apdex configuration rule. The Apdex score is computed based on how the response time of a span compares to two predefined threshold values. The first threshold defines the maximum response time that is considered satisfactory for the end user. The second one defines the maximum response time that is considered tolerable. All times larger than that will be considered frustrating for the end user. An Apdex configuration rule works by selecting a subset of spans based on a filter expression and applying the two threshold comparisons to compute a score for each of the selected spans. The rule has an “isApplyToErrorSpans” property that controls whether or not to compute the Apdex for spans that have been marked as errors. If this property is set to “true”, then the Apdex score for error spans is computed in the same way as for non-error ones. If set to “false”, then computation for error spans is skipped, and the score is set to “frustrating” regardless of the configured thresholds. The default is “false”. The “isEnabled” property controls whether or not an Apdex score is computed and can be used to disable Apdex score for certain spans. The default is “true”. The “priority” property specifies the importance of the rule within a rule set. Lower values indicate a higher priority. Rules with higher priorities are evaluated first in the rule set. The priority of the rules must be unique within a rule set.

Methods

__init__(**kwargs) Initializes a new Apdex object with values from keyword arguments.

Attributes

display_name Gets the display_name of this Apdex.
filter_text [Required] Gets the filter_text of this Apdex.
is_apply_to_error_spans Gets the is_apply_to_error_spans of this Apdex.
is_enabled Gets the is_enabled of this Apdex.
priority [Required] Gets the priority of this Apdex.
satisfied_response_time Gets the satisfied_response_time of this Apdex.
tolerating_response_time Gets the tolerating_response_time of this Apdex.
__init__(**kwargs)

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

Parameters:
  • filter_text (str) – The value to assign to the filter_text property of this Apdex.
  • priority (int) – The value to assign to the priority property of this Apdex.
  • is_enabled (bool) – The value to assign to the is_enabled property of this Apdex.
  • satisfied_response_time (int) – The value to assign to the satisfied_response_time property of this Apdex.
  • tolerating_response_time (int) – The value to assign to the tolerating_response_time property of this Apdex.
  • is_apply_to_error_spans (bool) – The value to assign to the is_apply_to_error_spans property of this Apdex.
  • display_name (str) – The value to assign to the display_name property of this Apdex.
display_name

Gets the display_name of this Apdex. A user-friendly name that provides a short description of this rule.

Returns:The display_name of this Apdex.
Return type:str
filter_text

[Required] Gets the filter_text of this Apdex. The string that defines the Span Filter expression.

Returns:The filter_text of this Apdex.
Return type:str
is_apply_to_error_spans

Gets the is_apply_to_error_spans of this Apdex. Specifies whether an Apdex score should be computed for error spans. Setting it to “true” means that the Apdex score is computed in the usual way. Setting it to “false” skips the Apdex computation and sets the Apdex score to “frustrating” regardless of the configured thresholds. The default is “false”.

Returns:The is_apply_to_error_spans of this Apdex.
Return type:bool
is_enabled

Gets the is_enabled of this Apdex. Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is “true”.

Returns:The is_enabled of this Apdex.
Return type:bool
priority

[Required] Gets the priority of this Apdex. The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.

Returns:The priority of this Apdex.
Return type:int
satisfied_response_time

Gets the satisfied_response_time of this Apdex. The maximum response time in milliseconds that is considered “satisfactory” for the end user.

Returns:The satisfied_response_time of this Apdex.
Return type:int
tolerating_response_time

Gets the tolerating_response_time of this Apdex. The maximum response time in milliseconds that is considered “tolerable” for the end user. A response time beyond this threshold is considered “frustrating”. This value cannot be lower than “satisfiedResponseTime”.

Returns:The tolerating_response_time of this Apdex.
Return type:int