models

Documentation

Index

• Constants
• Variables
• func NewSpanContext(traceID string) trace.SpanContext
• type ApiOptions
  • func NewApiOptions(vu modules.VU, val goja.Value) (ApiOptions, error)
• type HttpClientOptions
  • func NewHttpClientOptions(vu modules.VU, val goja.Value) (HttpClientOptions, error)
• type Job
  • func NewJob(traceId string, options TracetestOptions, request Request) Job
  • func (job Job) HandleRunResponse(run *openapi.TestRun, err error) Job
  • func (job Job) IsSuccessful() bool
  • func (job Job) Summary(baseUrl string) string
• type JobStatus
• type JobType
• type Metadata
• type OutputConfig
  • func NewConfig(params output.Params) (OutputConfig, error)
• type Propagator
  • func NewPropagator(propagators []PropagatorName) Propagator
  • func (p Propagator) GenerateHeaders(traceID string) http.Header
• type PropagatorName
• type Request
• type Test
• type TraceID
  • func DecodeTraceID(buf []byte) *TraceID
  • func (t *TraceID) Encode() (string, []byte, error)
  • func (t *TraceID) IsValid() bool
  • func (t *TraceID) IsValidCloud() bool
• type TracetestOptions
  • func NewTracetestOptions(runTime *goja.Runtime, params *goja.Object) TracetestOptions
• type TracetestRun
  • func (tr *TracetestRun) IsSuccessful() bool
  • func (tr *TracetestRun) Summary(baseUrl string) string

Constants

const (
	DefaultServerUrl = "http://localhost:3000"
	ServerURL        = "serverUrl"
	ServerPath       = "serverPath"
)

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.
)

Variables

var (
	ENV_SERVER_URL  = "XK6_TRACETEST_SERVER_URL"
	ENV_SERVER_PATH = "XK6_TRACETEST_SERVER_PATH"
)

Functions

func NewSpanContext

func NewSpanContext(traceID string) trace.SpanContext

Types

type ApiOptions

type ApiOptions struct {
	ServerUrl  string
	ServerPath string
}

func NewApiOptions

func NewApiOptions(vu modules.VU, val goja.Value) (ApiOptions, error)

type HttpClientOptions

type HttpClientOptions struct {
	Propagator Propagator
	Tracetest  TracetestOptions
}

func NewHttpClientOptions

func NewHttpClientOptions(vu modules.VU, val goja.Value) (HttpClientOptions, error)

type Job

type Job struct {
	TraceID          string
	TestID           string
	VariableName     string
	JobType          JobType
	Request          Request
	Run              *TracetestRun
	JobStatus        JobStatus
	TracetestOptions TracetestOptions
	Error            string
}

func NewJob

func NewJob(traceId string, options TracetestOptions, request Request) Job

func (Job) HandleRunResponse

func (job Job) HandleRunResponse(run *openapi.TestRun, err error) Job

func (Job) IsSuccessful

func (job Job) IsSuccessful() bool

func (Job) Summary

func (job Job) Summary(baseUrl string) string

type JobStatus

type JobStatus string

const (
	Pending JobStatus = "pending"
	Running JobStatus = "running"
	Failed  JobStatus = "failed"
	Success JobStatus = "success"
)

type JobType

type JobType string

const (
	RunTestFromId JobType = "runTestFromId"
)

type Metadata

type Metadata map[string]string

type OutputConfig

type OutputConfig struct {
	ServerUrl  string
	ServerPath string
}

func NewConfig

func NewConfig(params output.Params) (OutputConfig, error)

type Propagator

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

func NewPropagator

func NewPropagator(propagators []PropagatorName) Propagator

func (Propagator) GenerateHeaders

func (p Propagator) GenerateHeaders(traceID string) http.Header

type PropagatorName

type PropagatorName string

const (
	TraceContext PropagatorName = "tracecontext"
	Baggage      PropagatorName = "baggage"
	PropagatorB3 PropagatorName = "b3"
	OT           PropagatorName = "ot"
	Jaeger       PropagatorName = "jaeger"
	XRay         PropagatorName = "xray"
)

type Request

type Request struct {
	Method   string
	URL      string
	ID       string
	Metadata Metadata
}

type Test

type Test struct {
	ID   string
	Name string
}

type TraceID

type TraceID struct {
	Prefix            int16
	Code              int8
	UnixTimestampNano uint64
}

func DecodeTraceID

func DecodeTraceID(buf []byte) *TraceID

func (*TraceID) Encode

func (t *TraceID) Encode() (string, []byte, error)

func (*TraceID) IsValid

func (t *TraceID) IsValid() bool

func (*TraceID) IsValidCloud

func (t *TraceID) IsValidCloud() bool

type TracetestOptions

type TracetestOptions struct {
	TestID       string
	ShouldWait   bool
	VariableName string
}

func NewTracetestOptions

func NewTracetestOptions(runTime *goja.Runtime, params *goja.Object) TracetestOptions

type TracetestRun

type TracetestRun struct {
	TestId  string
	TestRun *openapi.TestRun
}

func (*TracetestRun) IsSuccessful

func (tr *TracetestRun) IsSuccessful() bool

func (*TracetestRun) Summary

func (tr *TracetestRun) Summary(baseUrl string) string