v1

Documentation

Index

• func NewHandler() http.Handler
• type Check
  • func NewCheck(c *lib.Check) Check
• type Error
  • func (e Error) Error() string
• type ErrorResponse
• type Group
  • func FlattenGroup(g *Group) []*Group
  • func NewGroup(g *lib.Group, parent *Group) *Group
  • func (g Group) GetID() string
  • func (g Group) GetReferencedIDs() []jsonapi.ReferenceID
  • func (g Group) GetReferences() []jsonapi.Reference
  • func (g *Group) SetID(v string) error
  • func (g *Group) SetToManyReferenceIDs(name string, ids []string) error
  • func (g *Group) SetToOneReferenceID(name, id string) error
• type Metric
  • func NewMetric(m *stats.Metric, t time.Duration) Metric
  • func (m Metric) GetID() string
  • func (m *Metric) SetID(id string) error
• type NullMetricType
  • func (t NullMetricType) MarshalJSON() ([]byte, error)
  • func (t *NullMetricType) UnmarshalJSON(data []byte) error
• type NullSetupData
• type NullValueType
  • func (t NullValueType) MarshalJSON() ([]byte, error)
  • func (t *NullValueType) UnmarshalJSON(data []byte) error
• type SetupData
  • func (sd SetupData) GetID() string
  • func (sd SetupData) GetName() string
• type Status
  • func NewStatus(engine *core.Engine) Status
  • func (s Status) GetID() string
  • func (s Status) GetName() string
  • func (s Status) SetID(id string) error

Functions

func NewHandler

func NewHandler() http.Handler

Types

type Check

type Check struct {
	ID     string `json:"id" yaml:"id"`
	Path   string `json:"path" yaml:"path"`
	Name   string `json:"name" yaml:"name"`
	Passes int64  `json:"passes" yaml:"passes"`
	Fails  int64  `json:"fails" yaml:"fails"`
}

func NewCheck

func NewCheck(c *lib.Check) Check

type Error

type Error struct {
	Status string `json:"status,omitempty"`
	Title  string `json:"title,omitempty"`
	Detail string `json:"detail,omitempty"`
}

Error is an api error

func (Error) Error

func (e Error) Error() string

type ErrorResponse

type ErrorResponse struct {
	Errors []Error `json:"errors"`
}

ErrorResponse is a struct wrapper around multiple errors

type Group

type Group struct {
	ID     string  `json:"-" yaml:"id"`
	Path   string  `json:"path" yaml:"path"`
	Name   string  `json:"name" yaml:"name"`
	Checks []Check `json:"checks" yaml:"checks"`

	Parent   *Group   `json:"-" yaml:"-"`
	ParentID string   `json:"-" yaml:"parent-id"`
	Groups   []*Group `json:"-" yaml:"-"`
	GroupIDs []string `json:"-" yaml:"group-ids"`
}

func FlattenGroup

func FlattenGroup(g *Group) []*Group

func NewGroup

func NewGroup(g *lib.Group, parent *Group) *Group

func (Group) GetID

func (g Group) GetID() string

func (Group) GetReferencedIDs

func (g Group) GetReferencedIDs() []jsonapi.ReferenceID

func (Group) GetReferences

func (g Group) GetReferences() []jsonapi.Reference

func (*Group) SetID

func (g *Group) SetID(v string) error

func (*Group) SetToManyReferenceIDs

func (g *Group) SetToManyReferenceIDs(name string, ids []string) error

func (*Group) SetToOneReferenceID

func (g *Group) SetToOneReferenceID(name, id string) error

type Metric

type Metric struct {
	Name string `json:"-" yaml:"name"`

	Type     NullMetricType `json:"type" yaml:"type"`
	Contains NullValueType  `json:"contains" yaml:"contains"`
	Tainted  null.Bool      `json:"tainted" yaml:"tainted"`

	Sample map[string]float64 `json:"sample" yaml:"sample"`
}

func NewMetric

func NewMetric(m *stats.Metric, t time.Duration) Metric

func (Metric) GetID

func (m Metric) GetID() string

func (*Metric) SetID

func (m *Metric) SetID(id string) error

type NullMetricType

type NullMetricType struct {
	Type  stats.MetricType
	Valid bool
}

func (NullMetricType) MarshalJSON

func (t NullMetricType) MarshalJSON() ([]byte, error)

func (*NullMetricType) UnmarshalJSON

func (t *NullMetricType) UnmarshalJSON(data []byte) error

type NullSetupData

type NullSetupData struct {
	SetupData
	Data interface{} `json:"data,omitempty" yaml:"data"`
}

NullSetupData is wrapper around null to satisfy jsonapi

type NullValueType

type NullValueType struct {
	Type  stats.ValueType
	Valid bool
}

func (NullValueType) MarshalJSON

func (t NullValueType) MarshalJSON() ([]byte, error)

func (*NullValueType) UnmarshalJSON

func (t *NullValueType) UnmarshalJSON(data []byte) error

type SetupData

type SetupData struct {
	Data interface{} `json:"data" yaml:"data"`
}

SetupData is just a simple wrapper to satisfy jsonapi

func (SetupData) GetID

func (sd SetupData) GetID() string

GetID is a dummy method so we can satisfy the jsonapi.MarshalIdentifier interface

func (SetupData) GetName

func (sd SetupData) GetName() string

GetName is a dummy method so we can satisfy the jsonapi.EntityNamer interface

type Status

type Status struct {
	Status lib.ExecutionStatus `json:"status" yaml:"status"`

	Paused  null.Bool `json:"paused" yaml:"paused"`
	VUs     null.Int  `json:"vus" yaml:"vus"`
	VUsMax  null.Int  `json:"vus-max" yaml:"vus-max"`
	Stopped bool      `json:"stopped" yaml:"stopped"`
	Running bool      `json:"running" yaml:"running"`
	Tainted bool      `json:"tainted" yaml:"tainted"`
}

func NewStatus

func NewStatus(engine *core.Engine) Status

func (Status) GetID

func (s Status) GetID() string

func (Status) GetName

func (s Status) GetName() string

func (Status) SetID

func (s Status) SetID(id string) error