relay

Documentation

Index

• Constants
• Variables
• type Config
  • func LoadConfigFile(filename string) (cfg Config, err error)
• type HTTP
  • func (h *HTTP) Name() string
  • func (h *HTTP) Run() error
  • func (h *HTTP) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (h *HTTP) Stop() error
• type HTTPConfig
• type HTTPOutputConfig
• type Operation
• type Relay
  • func NewHTTP(cfg HTTPConfig) (Relay, error)
  • func NewUDP(config UDPConfig) (Relay, error)
• type Service
  • func New(config Config) (*Service, error)
  • func (s *Service) Run()
  • func (s *Service) Stop()
• type UDP
  • func (u *UDP) Name() string
  • func (u *UDP) Run() error
  • func (u *UDP) Stop() error
• type UDPConfig
• type UDPOutputConfig

Constants

const (
	DefaultHTTPTimeout      = 10 * time.Second
	DefaultMaxDelayInterval = 10 * time.Second
	DefaultBatchSizeKB      = 512

	KB = 1024
	MB = 1024 * KB
)

Variables

var ErrBufferFull = errors.New("retry buffer full")

Types

type Config

type Config struct {
	HTTPRelays []HTTPConfig `toml:"http"`
	UDPRelays  []UDPConfig  `toml:"udp"`
}

func LoadConfigFile

func LoadConfigFile(filename string) (cfg Config, err error)

LoadConfigFile parses the specified file into a Config object

type HTTP

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

HTTP is a relay for HTTP influxdb writes

func (*HTTP) Name

func (h *HTTP) Name() string

func (*HTTP) Run

func (h *HTTP) Run() error

func (*HTTP) ServeHTTP

func (h *HTTP) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*HTTP) Stop

func (h *HTTP) Stop() error

type HTTPConfig

type HTTPConfig struct {
	// Name identifies the HTTP relay
	Name string `toml:"name"`

	// Addr should be set to the desired listening host:port
	Addr string `toml:"bind-addr"`

	// Set certificate in order to handle HTTPS requests
	SSLCombinedPem string `toml:"ssl-combined-pem"`

	// Default retention policy to set for forwarded requests
	DefaultRetentionPolicy string `toml:"default-retention-policy"`

	// Outputs is a list of backed servers where writes will be forwarded
	Outputs []HTTPOutputConfig `toml:"output"`
}

type HTTPOutputConfig

type HTTPOutputConfig struct {
	// Name of the backend server
	Name string `toml:"name"`

	// Location should be set to the URL of the backend server's write endpoint
	Location string `toml:"location"`

	// Timeout sets a per-backend timeout for write requests. (Default 10s)
	// The format used is the same seen in time.ParseDuration
	Timeout string `toml:"timeout"`

	// Buffer failed writes up to maximum count. (Default 0, retry/buffering disabled)
	BufferSizeMB int `toml:"buffer-size-mb"`

	// Maximum batch size in KB (Default 512)
	MaxBatchKB int `toml:"max-batch-kb"`

	// Maximum delay between retry attempts.
	// The format used is the same seen in time.ParseDuration (Default 10s)
	MaxDelayInterval string `toml:"max-delay-interval"`

	// Skip TLS verification in order to use self signed certificate.
	// WARNING: It's insecure. Use it only for developing and don't use in production.
	SkipTLSVerification bool `toml:"skip-tls-verification"`
}

type Operation

type Operation func() error

type Relay

type Relay interface {
	Name() string
	Run() error
	Stop() error
}

func NewHTTP

func NewHTTP(cfg HTTPConfig) (Relay, error)

func NewUDP

func NewUDP(config UDPConfig) (Relay, error)

type Service

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

func New

func New(config Config) (*Service, error)

func (*Service) Run

func (s *Service) Run()

func (*Service) Stop

func (s *Service) Stop()

type UDP

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

UDP is a relay for UDP influxdb writes

func (*UDP) Name

func (u *UDP) Name() string

func (*UDP) Run

func (u *UDP) Run() error

func (*UDP) Stop

func (u *UDP) Stop() error

type UDPConfig

type UDPConfig struct {
	// Name identifies the UDP relay
	Name string `toml:"name"`

	// Addr is where the UDP relay will listen for packets
	Addr string `toml:"bind-addr"`

	// Precision sets the precision of the timestamps (input and output)
	Precision string `toml:"precision"`

	// ReadBuffer sets the socket buffer for incoming connections
	ReadBuffer int `toml:"read-buffer"`

	// Outputs is a list of backend servers where writes will be forwarded
	Outputs []UDPOutputConfig `toml:"output"`
}

type UDPOutputConfig

type UDPOutputConfig struct {
	// Name identifies the UDP backend
	Name string `toml:"name"`

	// Location should be set to the host:port of the backend server
	Location string `toml:"location"`

	// MTU sets the maximum output payload size, default is 1024
	MTU int `toml:"mtu"`
}