trace

Documentation

Overview

Package trace provides functions to annotate trace spans with AppSec related information.

Index

• Constants
• func SetAppSecEnabledTags(span TagSetter)
• func SetEventSpanTags(span TagSetter, events []any) error
• func SetTags[V any](span TagSetter, tags map[string]V)
• type NoopTagSetter
  • func (NoopTagSetter) SetTag(string, any)
• type TagSetter

Constants

const BlockedRequestTag = "appsec.blocked"

BlockedRequestTag used to convey whether a request is blocked

Functions

func SetAppSecEnabledTags

func SetAppSecEnabledTags(span TagSetter)

SetAppSecEnabledTags sets the AppSec-specific span tags that are expected to be in the web service entry span (span of type `web`) when AppSec is enabled.

func SetEventSpanTags

func SetEventSpanTags(span TagSetter, events []any) error

SetEventSpanTags sets the security event span tags into the service entry span.

func SetTags

func SetTags[V any](span TagSetter, tags map[string]V)

SetTags fills the span tags using the key/value pairs found in `tags`

Types

type NoopTagSetter

type NoopTagSetter struct{}

NoopTagSetter is a TagSetter that does nothing. Useful when no tracer Span is available, but a TagSetter is assumed.

func (NoopTagSetter) SetTag

func (NoopTagSetter) SetTag(string, any)

type TagSetter

type TagSetter interface {
	SetTag(string, any)
}

TagSetter is the interface needed to set a span tag.