Class Apdex

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.

Inheritance

object

Apdex

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ApmconfigService.Models

Assembly: OCI.DotNetSDK.Apmconfig.dll

Syntax

public class Apdex

Properties

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The name by which a configuration entity is displayed to the end user.

FilterText

Declaration

[Required(ErrorMessage = "FilterText is required.")]
[JsonProperty(PropertyName = "filterText")]
public string FilterText { get; set; }

Property Value

Type	Description
string	The string that defines the Span Filter expression.

Remarks

Required

IsApplyToErrorSpans

Declaration

[JsonProperty(PropertyName = "isApplyToErrorSpans")]
public bool? IsApplyToErrorSpans { get; set; }

Property Value

Type	Description
bool?	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".

IsEnabled

Declaration

[JsonProperty(PropertyName = "isEnabled")]
public bool? IsEnabled { get; set; }

Property Value

Type	Description
bool?	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".

Priority

Declaration

[Required(ErrorMessage = "Priority is required.")]
[JsonProperty(PropertyName = "priority")]
public int? Priority { get; set; }

Property Value

Type	Description
int?	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.

Remarks

Required

SatisfiedResponseTime

Declaration

[JsonProperty(PropertyName = "satisfiedResponseTime")]
public int? SatisfiedResponseTime { get; set; }

Property Value

Type	Description
int?	The maximum response time in milliseconds that is considered "satisfactory" for the end user.

ToleratingResponseTime

Declaration

[JsonProperty(PropertyName = "toleratingResponseTime")]
public int? ToleratingResponseTime { get; set; }

Property Value

Type	Description
int?	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".