agent

Documentation

Index

• type LoadAgent
  • func New(config LoadAgentConfig) (*LoadAgent, error)
  • func (a *LoadAgent) AddUsers(n int) error
  • func (a *LoadAgent) RemoveUsers(n int) error
  • func (a *LoadAgent) Start() error
  • func (a *LoadAgent) Status() *loadtest.Status
  • func (a *LoadAgent) Stop() error
• type LoadAgentConfig
  • func (c LoadAgentConfig) IsValid() error

Types

type LoadAgent

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

LoadAgent is the object acting as a client to the load-test agent HTTP API.

func New

func New(config LoadAgentConfig) (*LoadAgent, error)

New creates and initializes a new LoadAgent for the given config. An error is returned if the initialization fails.

func (*LoadAgent) AddUsers

func (a *LoadAgent) AddUsers(n int) error

func (*LoadAgent) RemoveUsers

func (a *LoadAgent) RemoveUsers(n int) error

func (*LoadAgent) Start

func (a *LoadAgent) Start() error

func (*LoadAgent) Status

func (a *LoadAgent) Status() *loadtest.Status

func (*LoadAgent) Stop

func (a *LoadAgent) Stop() error

type LoadAgentConfig

type LoadAgentConfig struct {
	// A sring that identifies the load-test agent instance.
	Id string
	// The API URL used to control the specified load-test instance.
	ApiURL string
	// The configuration for the load-test to run.
	LoadTestConfig loadtest.Config
}

LoadAgentConfig holds information about the load-test agent instance.

func (LoadAgentConfig) IsValid

func (c LoadAgentConfig) IsValid() error

IsValid checks whether a LoadAgentConfig is valid or not. Returns an error if the validation fails.