app

Documentation

Index

• type Agent
  • func NewAgent(processors []processors.Processor, httpServer *http.Server, logger *zap.Logger) *Agent
  • func (a *Agent) Run() error
  • func (a *Agent) Stop()
• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Bind(flags *flag.FlagSet)
  • func (b *Builder) CreateAgent(logger *zap.Logger) (*Agent, error)
  • func (b *Builder) GetProcessors(rep reporter.Reporter, mFactory metrics.Factory) ([]processors.Processor, error)
  • func (b *Builder) WithMetricsFactory(mf metrics.Factory) *Builder
  • func (b *Builder) WithReporter(r reporter.Reporter) *Builder
• type HTTPServerConfiguration
  • func (c HTTPServerConfiguration) GetHTTPServer(svc string, channel *tchannel.Channel, mFactory metrics.Factory) *http.Server
• type ProcessorConfiguration
  • func (c *ProcessorConfiguration) GetThriftProcessor(mFactory metrics.Factory, factory thrift.TProtocolFactory, ...) (processors.Processor, error)
• type ServerConfiguration

Types

type Agent

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

Agent is a composition of all services / components

func NewAgent

func NewAgent(
	processors []processors.Processor,
	httpServer *http.Server,
	logger *zap.Logger,
) *Agent

NewAgent creates the new Agent.

func (*Agent) Run

func (a *Agent) Run() error

Run runs all of agent UDP and HTTP servers in separate go-routines. It returns an error when it's immediately apparent on startup, but any errors happening after starting the servers are only logged.

func (*Agent) Stop

func (a *Agent) Stop()

Stop forces all agent go routines to exit.

type Builder

type Builder struct {
	Processors []ProcessorConfiguration `yaml:"processors"`
	HTTPServer HTTPServerConfiguration  `yaml:"httpServer"`
	Metrics    jmetrics.Builder         `yaml:"metrics"`

	// These 3 fields are copied from tchreporter.Builder because yaml does not parse embedded structs
	CollectorHostPorts   []string `yaml:"collectorHostPorts"`
	DiscoveryMinPeers    int      `yaml:"minPeers"`
	CollectorServiceName string   `yaml:"collectorServiceName"`

	tchreporter.Builder
	// contains filtered or unexported fields
}

Builder Struct to hold configurations

func NewBuilder

func NewBuilder() *Builder

NewBuilder creates a default builder with three processors.

func (*Builder) Bind

func (b *Builder) Bind(flags *flag.FlagSet)

Bind binds the agent builder to command line options

func (*Builder) CreateAgent

func (b *Builder) CreateAgent(logger *zap.Logger) (*Agent, error)

CreateAgent creates the Agent

func (*Builder) GetProcessors

func (b *Builder) GetProcessors(rep reporter.Reporter, mFactory metrics.Factory) ([]processors.Processor, error)

GetProcessors creates Processors with attached Reporter

func (*Builder) WithMetricsFactory

func (b *Builder) WithMetricsFactory(mf metrics.Factory) *Builder

WithMetricsFactory sets an externally initialized metrics factory.

func (*Builder) WithReporter

func (b *Builder) WithReporter(r reporter.Reporter) *Builder

WithReporter adds auxiliary reporters.

type HTTPServerConfiguration

type HTTPServerConfiguration struct {
	HostPort string `yaml:"hostPort" validate:"nonzero"`
}

HTTPServerConfiguration holds config for a server providing sampling strategies and baggage restrictions to clients

func (HTTPServerConfiguration) GetHTTPServer

func (c HTTPServerConfiguration) GetHTTPServer(svc string, channel *tchannel.Channel, mFactory metrics.Factory) *http.Server

GetHTTPServer creates an HTTP server that provides sampling strategies and baggage restrictions to client libraries.

type ProcessorConfiguration

type ProcessorConfiguration struct {
	Workers  int                 `yaml:"workers"`
	Model    model               `yaml:"model"`
	Protocol protocol            `yaml:"protocol"`
	Server   ServerConfiguration `yaml:"server"`
}

ProcessorConfiguration holds config for a processor that receives spans from Server

func (*ProcessorConfiguration) GetThriftProcessor

func (c *ProcessorConfiguration) GetThriftProcessor(
	mFactory metrics.Factory,
	factory thrift.TProtocolFactory,
	handler processors.AgentProcessor,
) (processors.Processor, error)

GetThriftProcessor gets a TBufferedServer backed Processor using the collector configuration

type ServerConfiguration

type ServerConfiguration struct {
	QueueSize     int    `yaml:"queueSize"`
	MaxPacketSize int    `yaml:"maxPacketSize"`
	HostPort      string `yaml:"hostPort" validate:"nonzero"`
}

ServerConfiguration holds config for a server that receives spans from the network