sampling

package

v1.1.134 Latest Latest Go to latest Published: Dec 11, 2025 License: Apache-2.0 Imports: 19 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Axway/agent-sdk

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func FilterEvents(events []publisher.Event) ([]publisher.Event, error)
func FormatApiAppKey(apiID, appID string) string
func GetApiAppErrorSampling() map[string]struct{}
func GetGlobalSampling() *sample
func GetGlobalSamplingPercentage() (float64, error)
func GetStatusFromCodeString(statusCode string) statusText
func RemoveApiAppKey(apiServiceName, managedAppName string)
func SetExternalAppKeyData(key definitions.ExternalAppData)
func SetupSampling(cfg Sampling, offlineMode bool, apicDeployment string, opts ...SamplingOption) error
func ShouldSampleTransaction(details TransactionDetails) (bool, error)
func WithCacheAccess(ca cacheAccess) func(*Sampling)
type Sampling
- func DefaultConfig() Sampling
type SamplingOption
type TransactionDetails

Constants ¶

View Source

const (
	Success   statusText = "Success"
	Failure   statusText = "Failure"
	Exception statusText = "Exception"
)

View Source

const (
	SampleKey = "sample"
)

SampleKey - the key used in the metadata when a transaction qualifies for sampling and should be sent to Observer defaultSamplingRate - the default sampling rate in percentage

Variables ¶

View Source

var (
	ErrGlobalSamplingCfg = errors.New(1520, "the global sampling config has not been initialized")
	ErrSamplingCfg       = errors.Newf(1521, "sampling percentage must be between 0 and %v. Setting sampling percentage to default value of %v percent")
)

Config errors

Functions ¶

func FilterEvents ¶

func FilterEvents(events []publisher.Event) ([]publisher.Event, error)

FilterEvents - returns an array of events that are part of the sample

func FormatApiAppKey ¶ added in v1.1.133

func FormatApiAppKey(apiID, appID string) string

func GetApiAppErrorSampling ¶ added in v1.1.133

func GetApiAppErrorSampling() map[string]struct{}

GetApiAppErrorSampling -

func GetGlobalSampling ¶ added in v1.1.86

func GetGlobalSampling() *sample

GetGlobalSampling -

func GetGlobalSamplingPercentage ¶

func GetGlobalSamplingPercentage() (float64, error)

GetGlobalSamplingPercentage -

func GetStatusFromCodeString ¶ added in v1.1.121

func GetStatusFromCodeString(statusCode string) statusText

func RemoveApiAppKey ¶ added in v1.1.133

func RemoveApiAppKey(apiServiceName, managedAppName string)

func SetExternalAppKeyData ¶ added in v1.1.133

func SetExternalAppKeyData(key definitions.ExternalAppData)

func SetupSampling ¶

func SetupSampling(cfg Sampling, offlineMode bool, apicDeployment string, opts ...SamplingOption) error

SetupSampling - set up the global sampling for use by traceability

func ShouldSampleTransaction ¶

func ShouldSampleTransaction(details TransactionDetails) (bool, error)

ShouldSampleTransaction - receives the transaction details and returns true to sample it false to not

func WithCacheAccess ¶ added in v1.1.134

func WithCacheAccess(ca cacheAccess) func(*Sampling)

Types ¶

type Sampling ¶

type Sampling struct {
	Percentage           float64 `config:"percentage"`
	PerAPI               bool    `config:"per_api"`
	PerSub               bool    `config:"per_subscription"`
	OnlyErrors           bool    `config:"onlyErrors" yaml:"onlyErrors"`
	ErrorSamplingEnabled bool
	// contains filtered or unexported fields
}

Sampling - configures the sampling of events the agent sends to Amplify

func DefaultConfig ¶

func DefaultConfig() Sampling

DefaultConfig - returns a default sampling config where all transactions are sent

type SamplingOption ¶ added in v1.1.134

type SamplingOption func(*Sampling)

type TransactionDetails ¶

type TransactionDetails struct {
	Status string
	APIID  string
	SubID  string
}

TransactionDetails - details about the transaction that are used for sampling

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL