sampling

Documentation

Index

• Constants
• Variables
• func FilterEvents(events []publisher.Event) ([]publisher.Event, error)
• func GetGlobalSamplingPercentage() (int, error)
• func SetupSampling(cfg Sampling, offlineMode bool) error
• func ShouldSampleTransaction(details TransactionDetails) (bool, error)
• type Sampling
  • func DefaultConfig() Sampling
• type TransactionDetails

Constants

const (
	SampleKey = "sample"
)

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

Variables

var (
	ErrGlobalSamplingCfg = errors.New(1520, "the global sampling config has not been initialized")
	ErrSamplingCfg       = errors.New(1521, "sampling percentage must be between 0 and 100")
)

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 GetGlobalSamplingPercentage

func GetGlobalSamplingPercentage() (int, error)

GetGlobalSamplingPercentage -

func SetupSampling

func SetupSampling(cfg Sampling, offlineMode bool) 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

Types

type Sampling

type Sampling struct {
	Percentage      int  `config:"percentage"    validate:"min=0, max=100"`
	PerAPI          bool `config:"per_api"`
	PerSub          bool `config:"per_subscription"`
	ReportAllErrors bool `config:"reportAllErrors" yaml:"reportAllErrors"`
}

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 TransactionDetails

type TransactionDetails struct {
	Status string
	APIID  string
	SubID  string
}

TransactionDetails - details about the transaction that are used for sampling