Package com.oracle.bmc.apmconfig.model

Class Apdex

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210201")
public final class Apdex
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    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.
    Note: Objects should always be created or deserialized using the Apdex.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Apdex.Builder, which maintain a set of all explicitly set fields called Apdex.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • builder

        public static Apdex.Builder builder()
        Create a new builder.

      • getFilterText

        public String getFilterText()
        The string that defines the Span Filter expression.
        Returns:
        the value

      • getPriority

        public Integer getPriority()
        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 value

      • getIsEnabled

        public Boolean getIsEnabled()
        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 value

      • getSatisfiedResponseTime

        public Integer getSatisfiedResponseTime()
        The maximum response time in milliseconds that is considered “satisfactory” for the end user.
        Returns:
        the value

      • getToleratingResponseTime

        public Integer getToleratingResponseTime()
        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 value

      • getIsApplyToErrorSpans

        public Boolean getIsApplyToErrorSpans()
        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 value

      • getDisplayName

        public String getDisplayName()
        The name by which a configuration entity is displayed to the end user.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel