client

Documentation

Index

• Constants
• func EncodeTraceID(t TraceID) (string, []byte, error)
• func FromBytesToString(buf []byte) string
• func GenerateHeaderBasedOnPropagator(propagator string, traceID string) (http.Header, error)
• func RandHexStringRunes(n int) string
• type HTTPResponse
• type HttpFunc
• type HttpRequestFunc
• type Options
• type TraceID
  • func DecodeTraceID(buf []byte) *TraceID
  • func (t *TraceID) IsValid() bool
  • func (t *TraceID) IsValidCloud() bool
• type TracingClient
  • func New(vu modules.VU, requestFunc HttpRequestFunc, options Options) *TracingClient
  • func (c *TracingClient) Del(url goja.Value, args ...goja.Value) (*HTTPResponse, error)
  • func (c *TracingClient) Get(url goja.Value, args ...goja.Value) (*HTTPResponse, error)
  • func (c *TracingClient) Head(url goja.Value, args ...goja.Value) (*HTTPResponse, error)
  • func (c *TracingClient) Options(url goja.Value, args ...goja.Value) (*HTTPResponse, error)
  • func (c *TracingClient) Patch(url goja.Value, args ...goja.Value) (*HTTPResponse, error)
  • func (c *TracingClient) Post(url goja.Value, args ...goja.Value) (*HTTPResponse, error)
  • func (c *TracingClient) Put(url goja.Value, args ...goja.Value) (*HTTPResponse, error)
  • func (c *TracingClient) WithTrace(fn HttpFunc, spanName string, url goja.Value, args ...goja.Value) (*HTTPResponse, error)

Constants

const (
	PropagatorW3C    = "w3c"
	HeaderNameW3C    = "Traceparent"
	PropagatorB3     = "b3"
	HeaderNameB3     = "b3"
	PropagatorJaeger = "jaeger"
	HeaderNameJaeger = "uber-trace-id"
)

const (
	K6Prefix     = 0756 // Being 075 the ASCII code for 'K' :)
	K6Code_Cloud = 12   // To ingest and process the related spans in k6 Cloud.
	K6Code_Local = 33   // To not ingest and process the related spans, b/c they are part of a non-cloud run.
)

Functions

func EncodeTraceID

func EncodeTraceID(t TraceID) (string, []byte, error)

func FromBytesToString

func FromBytesToString(buf []byte) string

func GenerateHeaderBasedOnPropagator

func GenerateHeaderBasedOnPropagator(propagator string, traceID string) (http.Header, error)

func RandHexStringRunes

func RandHexStringRunes(n int) string

Types

type HTTPResponse

type HTTPResponse struct {
	*k6HTTP.Response `js:"-"`
	TraceID          string
}

type HttpFunc

type HttpFunc func(ctx context.Context, url goja.Value, args ...goja.Value) (*k6HTTP.Response, error)

type HttpRequestFunc

type HttpRequestFunc func(method string, url goja.Value, args ...goja.Value) (*k6HTTP.Response, error)

type Options

type Options struct {
	Propagator string
}

type TraceID

type TraceID struct {
	Prefix            int16
	Code              int8
	UnixTimestampNano uint64
}

TraceIDs of 16 bytes (128 bits) are supported by w3c, b3 and jaeger

func DecodeTraceID

func DecodeTraceID(buf []byte) *TraceID

func (*TraceID) IsValid

func (t *TraceID) IsValid() bool

func (*TraceID) IsValidCloud

func (t *TraceID) IsValidCloud() bool

type TracingClient

type TracingClient struct {
	// contains filtered or unexported fields
}

func New

func New(vu modules.VU, requestFunc HttpRequestFunc, options Options) *TracingClient

func (*TracingClient) Del

func (c *TracingClient) Del(url goja.Value, args ...goja.Value) (*HTTPResponse, error)

func (*TracingClient) Get

func (c *TracingClient) Get(url goja.Value, args ...goja.Value) (*HTTPResponse, error)

func (*TracingClient) Head

func (c *TracingClient) Head(url goja.Value, args ...goja.Value) (*HTTPResponse, error)

func (*TracingClient) Options

func (c *TracingClient) Options(url goja.Value, args ...goja.Value) (*HTTPResponse, error)

func (*TracingClient) Patch

func (c *TracingClient) Patch(url goja.Value, args ...goja.Value) (*HTTPResponse, error)

func (*TracingClient) Post

func (c *TracingClient) Post(url goja.Value, args ...goja.Value) (*HTTPResponse, error)

func (*TracingClient) Put

func (c *TracingClient) Put(url goja.Value, args ...goja.Value) (*HTTPResponse, error)

func (*TracingClient) WithTrace

func (c *TracingClient) WithTrace(fn HttpFunc, spanName string, url goja.Value, args ...goja.Value) (*HTTPResponse, error)