apdex.go

// Copyright (c) 2016, 2018, 2024, Oracle and/or its affiliates.  All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.

// Application Performance Monitoring Configuration API
//
// Use the Application Performance Monitoring Configuration API to query and set Application Performance Monitoring
// configuration. For more information, see Application Performance Monitoring (https://docs.oracle.com/iaas/application-performance-monitoring/index.html).
//

package apmconfig

import (
	"fmt"
	"github.com/oracle/oci-go-sdk/v65/common"
	"strings"
)

// 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.
type Apdex struct {

	// The string that defines the Span Filter expression.
	FilterText *string `mandatory:"true" json:"filterText"`

	// 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.
	Priority *int `mandatory:"true" json:"priority"`

	// 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".
	IsEnabled *bool `mandatory:"false" json:"isEnabled"`

	// The maximum response time in milliseconds that is considered "satisfactory" for the end user.
	SatisfiedResponseTime *int `mandatory:"false" json:"satisfiedResponseTime"`

	// 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".
	ToleratingResponseTime *int `mandatory:"false" json:"toleratingResponseTime"`

	// 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".
	IsApplyToErrorSpans *bool `mandatory:"false" json:"isApplyToErrorSpans"`

	// The name by which a configuration entity is displayed to the end user.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

func (m Apdex) String() string {
	return common.PointerString(m)
}

// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m Apdex) ValidateEnumValue() (bool, error) {
	errMessage := []string{}

	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}