xray

package

Go to main page

Versions in this module

v1

v1.3.0

Aug 3, 2026

v1.2.0

Aug 3, 2026

Changes in this version

+ var ErrPolicySizeLimitExceeded = awserr.New("PolicySizeLimitExceededException", awserr.ErrInvalidParameter)

+ var ErrResourceNotFound = awserr.New("ResourceNotFoundException", awserr.ErrNotFound)

+ var ErrRuleLimitExceeded = awserr.New("RuleLimitExceededException", awserr.ErrInvalidParameter)

+ var ErrTooManyTags = awserr.New("TooManyTagsException", awserr.ErrInvalidParameter)

+ var ErrTraceRetrievalNotFound = awserr.New("ResourceNotFoundException", awserr.ErrNotFound)

type IndexingRule

+ Rule *ProbabilisticRuleValue

type Insight

+ LastUpdateTime time.Time

+ type ProbabilisticRuleValue struct

+ ActualSamplingPercentage float64

+ DesiredSamplingPercentage float64

type ResourcePolicy

+ LastUpdatedTime time.Time

+ type SamplingRateBoost struct

+ CooldownWindowMinutes int32

+ MaxRate float64

type SamplingRule

+ SamplingRateBoost *SamplingRateBoost

type SamplingRuleUpdate

+ SamplingRateBoost *SamplingRateBoost

v1.1.4

Jul 20, 2026

v1.1.3

Jul 20, 2026

v1.1.2

Jul 20, 2026

v1.1.1

Jul 20, 2026

v1.1.0

Jul 19, 2026

Changes in this version

+ var ErrBatchGetTracesLimit = awserr.New("InvalidRequestException", awserr.ErrInvalidParameter)

+ var ErrDefaultRuleUndeletable = awserr.New("InvalidRequestException", awserr.ErrInvalidParameter)

+ var ErrGroupAlreadyExists = awserr.New("GroupAlreadyExistsException", awserr.ErrConflict)

+ var ErrGroupNotFound = awserr.New("InvalidRequestException", awserr.ErrNotFound)

+ var ErrIndexingRuleNotFound = awserr.New("InvalidRequestException", awserr.ErrNotFound)

+ var ErrInsightNotFound = awserr.New("InvalidRequestException", awserr.ErrNotFound)

+ var ErrInvalidPolicyRevisionID = awserr.New("InvalidPolicyRevisionIdException", awserr.ErrConflict)

+ var ErrInvalidSamplingRule = awserr.New("InvalidSamplingRuleException", awserr.ErrInvalidParameter)

+ var ErrMalformedPolicyDocument = awserr.New("MalformedPolicyDocumentException", awserr.ErrInvalidParameter)

+ var ErrNilAppContext = errors.New("xray: nil app context")

+ var ErrResourcePolicyNotFound = awserr.New("InvalidRequestException", awserr.ErrNotFound)

+ var ErrSamplingRuleAlreadyExists = awserr.New("RuleAlreadyExistsException", awserr.ErrConflict)

+ var ErrSamplingRuleNotFound = awserr.New("InvalidRequestException", awserr.ErrNotFound)

+ var ErrTooManyPolicies = awserr.New("InvalidRequestException", awserr.ErrInvalidParameter)

+ var ErrValidation = awserr.New("InvalidRequestException", awserr.ErrInvalidParameter)

+ func EvaluateFilter(expr string, summary TraceSummaryData) bool

+ func ValidateSamplingRule(rule SamplingRule) error

+ type ConfigProvider interface

+ GetXRaySettings func() Settings

+ type EncryptionConfig struct

+ KeyID string

+ Status string

+ Type string

+ type Group struct

+ CreatedAt time.Time

+ FilterExpression string

+ GroupARN string

+ GroupName string

+ InsightsConfiguration InsightsConfiguration

+ type Handler struct

+ Backend StorageBackend

+ func NewHandler(backend StorageBackend) *Handler

+ func (h *Handler) ChaosOperations() []string

+ func (h *Handler) ChaosRegions() []string

+ func (h *Handler) ChaosServiceName() string

+ func (h *Handler) ExtractOperation(c *echo.Context) string

+ func (h *Handler) ExtractResource(c *echo.Context) string

+ func (h *Handler) GetSupportedOperations() []string

+ func (h *Handler) Handler() echo.HandlerFunc

+ func (h *Handler) MatchPriority() int

+ func (h *Handler) Name() string

+ func (h *Handler) Reset()

+ func (h *Handler) Restore(ctx context.Context, data []byte) error

+ func (h *Handler) RouteMatcher() service.Matcher

+ func (h *Handler) Snapshot(ctx context.Context) []byte

+ func (h *Handler) StartWorker(ctx context.Context) error

+ func (h *Handler) WithJanitor(interval, ttl time.Duration, taskTimeout ...time.Duration) *Handler

+ type InMemoryBackend struct

+ func NewInMemoryBackend(accountID, region string) *InMemoryBackend

+ func (b *InMemoryBackend) AddInsightEventInternal(event InsightEvent)

+ func (b *InMemoryBackend) AddInsightInternal(insight Insight)

+ func (b *InMemoryBackend) AddResourcePolicyInternal(policy ResourcePolicy)

+ func (b *InMemoryBackend) AddTraceRetrievalInternal(retrieval TraceRetrieval)

+ func (b *InMemoryBackend) CancelTraceRetrieval(retrievalToken string)

+ func (b *InMemoryBackend) CreateGroup(name, filterExpr string) (*Group, error)

+ func (b *InMemoryBackend) CreateGroupWithInsights(name, filterExpr string, ic InsightsConfiguration) (*Group, error)

+ func (b *InMemoryBackend) CreateSamplingRule(rule SamplingRule) (*SamplingRule, error)

+ func (b *InMemoryBackend) DeleteGroup(name string) error

+ func (b *InMemoryBackend) DeleteGroupByARN(name, arn string) error

+ func (b *InMemoryBackend) DeleteResourcePolicy(policyName string) error

+ func (b *InMemoryBackend) DeleteSamplingRule(ruleName string) (*SamplingRule, error)

+ func (b *InMemoryBackend) GetAllParsedSegments() map[string][]*Segment

+ func (b *InMemoryBackend) GetEncryptionConfig() *EncryptionConfig

+ func (b *InMemoryBackend) GetGroup(name string) (*Group, error)

+ func (b *InMemoryBackend) GetGroupByARN(arn string) (*Group, error)

+ func (b *InMemoryBackend) GetGroups() []Group

+ func (b *InMemoryBackend) GetIndexingRules() []*IndexingRule

+ func (b *InMemoryBackend) GetInsight(insightID string) (*Insight, error)

+ func (b *InMemoryBackend) GetInsightEvents(insightID string) ([]*InsightEvent, error)

+ func (b *InMemoryBackend) GetInsightSummaries(states []string) ([]Insight, error)

+ func (b *InMemoryBackend) GetParsedSegments(traceID string) []*Segment

+ func (b *InMemoryBackend) GetRetrievedTracesGraph(retrievalToken string) (string, []*Trace)

+ func (b *InMemoryBackend) GetSamplingRules() []SamplingRule

+ func (b *InMemoryBackend) GetSamplingStatisticSummaries() []SamplingStatisticSummary

+ func (b *InMemoryBackend) GetSamplingTargets(docs []SamplingStatisticsDocument) ([]SamplingTargetResult, []UnprocessedStatisticsResult)

+ func (b *InMemoryBackend) GetServiceGraph(startTime, endTime time.Time) []map[string]any

+ func (b *InMemoryBackend) GetTimeSeriesServiceStatistics(startTime, endTime time.Time, period int) []map[string]any

+ func (b *InMemoryBackend) GetTrace(traceID string) *Trace

+ func (b *InMemoryBackend) GetTraceGraph(traceIDs []string) []map[string]any

+ func (b *InMemoryBackend) GetTraceSegmentDestination() string

+ func (b *InMemoryBackend) GetTraceSummaries() []Trace

+ func (b *InMemoryBackend) LastRuleModification() time.Time

+ func (b *InMemoryBackend) ListResourcePolicies() []ResourcePolicy

+ func (b *InMemoryBackend) ListRetrievedTraces(retrievalToken string) (string, []*Trace)

+ func (b *InMemoryBackend) ListTagsForResource(resourceARN string) []map[string]string

+ func (b *InMemoryBackend) PutEncryptionConfig(encType, keyID string) (*EncryptionConfig, error)

+ func (b *InMemoryBackend) PutResourcePolicy(policyName, policyDocument, revisionID string) (*ResourcePolicy, error)

+ func (b *InMemoryBackend) PutTelemetryRecords(records []TelemetryRecord)

+ func (b *InMemoryBackend) PutTraceSegments(segments []string) []string

+ func (b *InMemoryBackend) Reset()

+ func (b *InMemoryBackend) Restore(ctx context.Context, data []byte) error

+ func (b *InMemoryBackend) Snapshot(ctx context.Context) []byte

+ func (b *InMemoryBackend) StartTraceRetrieval(traceIDs []string) string

+ func (b *InMemoryBackend) TagResource(resourceARN string, tags map[string]string)

+ func (b *InMemoryBackend) UntagResource(resourceARN string, tagKeys []string)

+ func (b *InMemoryBackend) UpdateGroup(name, filterExpr string) (*Group, error)

+ func (b *InMemoryBackend) UpdateGroupByARN(name, arn, filterExpr string) (*Group, error)

+ func (b *InMemoryBackend) UpdateIndexingRule(name string) (*IndexingRule, error)

+ func (b *InMemoryBackend) UpdateSamplingRule(ruleName string, updates SamplingRule) (*SamplingRule, error)

+ func (b *InMemoryBackend) UpdateSamplingRuleWithPointers(ruleName string, updates SamplingRuleUpdate) (*SamplingRule, error)

+ func (b *InMemoryBackend) UpdateTraceSegmentDestination(destination string) string

+ type IndexingRule struct

+ ModifiedAt time.Time

+ Name string

+ type Insight struct

+ EndTime time.Time

+ GroupARN string

+ GroupName string

+ InsightID string

+ StartTime time.Time

+ State string

+ Summary string

+ type InsightEvent struct

+ EventTime time.Time

+ InsightID string

+ Summary string

+ type InsightsConfiguration struct

+ InsightsEnabled bool

+ NotificationsEnabled bool

+ type Janitor struct

+ Backend *InMemoryBackend

+ Interval time.Duration

+ TaskTimeout time.Duration

+ TraceTTL time.Duration

+ func NewJanitor(backend *InMemoryBackend, interval, traceTTL time.Duration) *Janitor

+ func (j *Janitor) Run(ctx context.Context)

+ func (j *Janitor) SweepOnce(ctx context.Context)

+ type Provider struct

+ func (p *Provider) Init(ctx *service.AppContext) (service.Registerable, error)

+ func (p *Provider) Name() string

+ type ResourcePolicy struct

+ PolicyDocument string

+ PolicyName string

+ PolicyRevisionID string

+ type SamplingRule struct

+ Attributes map[string]string

+ CreatedAt time.Time

+ FixedRate float64

+ HTTPMethod string

+ Host string

+ ModifiedAt time.Time

+ Priority int32

+ ReservoirSize int32

+ ResourceARN string

+ RuleARN string

+ RuleName string

+ ServiceName string

+ ServiceType string

+ URLPath string

+ type SamplingRuleUpdate struct

+ FixedRate *float64

+ HTTPMethod *string

+ Host *string

+ Priority *int32

+ ReservoirSize *int32

+ ResourceARN *string

+ ServiceName *string

+ ServiceType *string

+ URLPath *string

+ type SamplingStatisticSummary struct

+ BorrowCount int32

+ RequestCount int32

+ RuleName string

+ SampledCount int32

+ Timestamp time.Time

+ type SamplingStatisticsDocument struct

+ BorrowCount int32

+ ClientID string

+ RequestCount int32

+ RuleName string

+ SampledCount int32

+ type SamplingTargetResult struct

+ FixedRate float64

+ ReservoirQuotaTTL time.Time

+ ReservoirSize int32

+ RuleName string

+ type Segment struct

+ AWS map[string]any

+ Annotations map[string]any

+ Document string

+ EndTime float64

+ Error bool

+ Fault bool

+ HTTP *SegmentHTTP

+ ID string

+ Metadata map[string]any

+ Name string

+ Namespace string

+ Origin string

+ ParentID string

+ StartTime float64

+ Subsegments []Segment

+ Throttle bool

+ TraceID string

+ type SegmentHTTP struct

+ Request *SegmentHTTPRequest

+ Response *SegmentHTTPResponse

+ type SegmentHTTPRequest struct

+ ClientIP string

+ Method string

+ URL string

+ UserAgent string

+ type SegmentHTTPResponse struct

+ ContentLength int

+ Status int

+ type Settings struct

+ JanitorInterval time.Duration

+ TraceTTL time.Duration

+ type StorageBackend interface

+ CancelTraceRetrieval func(retrievalToken string)

+ CreateGroup func(name, filterExpr string) (*Group, error)

+ CreateGroupWithInsights func(name, filterExpr string, ic InsightsConfiguration) (*Group, error)

+ CreateSamplingRule func(rule SamplingRule) (*SamplingRule, error)

+ DeleteGroup func(name string) error

+ DeleteGroupByARN func(name, arn string) error

+ DeleteResourcePolicy func(policyName string) error

+ DeleteSamplingRule func(ruleName string) (*SamplingRule, error)

+ GetAllParsedSegments func() map[string][]*Segment

+ GetEncryptionConfig func() *EncryptionConfig

+ GetGroup func(name string) (*Group, error)

+ GetGroupByARN func(arn string) (*Group, error)

+ GetGroups func() []Group

+ GetIndexingRules func() []*IndexingRule

+ GetInsight func(insightID string) (*Insight, error)

+ GetInsightEvents func(insightID string) ([]*InsightEvent, error)

+ GetInsightSummaries func(states []string) ([]Insight, error)

+ GetParsedSegments func(traceID string) []*Segment

+ GetRetrievedTracesGraph func(retrievalToken string) (string, []*Trace)

+ GetSamplingRules func() []SamplingRule

+ GetSamplingStatisticSummaries func() []SamplingStatisticSummary

+ GetSamplingTargets func(docs []SamplingStatisticsDocument) ([]SamplingTargetResult, []UnprocessedStatisticsResult)

+ GetServiceGraph func(startTime, endTime time.Time) []map[string]any

+ GetTimeSeriesServiceStatistics func(startTime, endTime time.Time, period int) []map[string]any

+ GetTrace func(traceID string) *Trace

+ GetTraceGraph func(traceIDs []string) []map[string]any

+ GetTraceSegmentDestination func() string

+ GetTraceSummaries func() []Trace

+ LastRuleModification func() time.Time

+ ListResourcePolicies func() []ResourcePolicy

+ ListRetrievedTraces func(retrievalToken string) (string, []*Trace)

+ ListTagsForResource func(resourceARN string) []map[string]string

+ PutEncryptionConfig func(encType, keyID string) (*EncryptionConfig, error)

+ PutResourcePolicy func(policyName, policyDocument, revisionID string) (*ResourcePolicy, error)

+ PutTelemetryRecords func(records []TelemetryRecord)

+ PutTraceSegments func(segments []string) []string

+ Reset func()

+ Restore func(ctx context.Context, data []byte) error

+ Snapshot func(ctx context.Context) []byte

+ StartTraceRetrieval func(traceIDs []string) string

+ TagResource func(resourceARN string, tags map[string]string)

+ UntagResource func(resourceARN string, tagKeys []string)

+ UpdateGroup func(name, filterExpr string) (*Group, error)

+ UpdateGroupByARN func(name, arn, filterExpr string) (*Group, error)

+ UpdateIndexingRule func(name string) (*IndexingRule, error)

+ UpdateSamplingRule func(ruleName string, updates SamplingRule) (*SamplingRule, error)

+ UpdateSamplingRuleWithPointers func(ruleName string, updates SamplingRuleUpdate) (*SamplingRule, error)

+ UpdateTraceSegmentDestination func(destination string) string

+ type TelemetryRecord struct

+ SegmentsReceivedCount int32

+ SegmentsRejectedCount int32

+ SegmentsSentCount int32

+ SegmentsSpilloverCount int32

+ Timestamp time.Time

+ type Trace struct

+ Segments []string

+ StartTime time.Time

+ TraceID string

+ type TraceRetrieval struct

+ RetrievalToken string

+ StartTime time.Time

+ Status string

+ type TraceSummaryData struct

+ Annotations map[string]any

+ ApproxTime float64

+ Duration float64

+ EntryPoint string

+ HTTP *TraceSummaryHTTP

+ HasError bool

+ HasFault bool

+ HasThrottle bool

+ IsPartial bool

+ ResponseTime float64

+ Revision int

+ ServiceIDs []TraceSummaryServiceID

+ TraceID string

+ Users []string

+ func BuildTraceSummary(traceID string, segs []*Segment) TraceSummaryData

+ type TraceSummaryHTTP struct

+ ClientIP string

+ HTTPMethod string

+ HTTPStatus int

+ HTTPURL string

+ UserAgent string

+ type TraceSummaryServiceID struct

+ Name string

+ Type string

+ type UnprocessedStatisticsResult struct

+ ErrorCode string

+ Message string

+ RuleName string

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