subscriber

Documentation

Index

• type BalanceMode
• type Config
  • func NewConfig() Config
• type PointsWriter
• type Service
  • func NewService(c Config) *Service
  • func (s *Service) Close() error
  • func (s *Service) Open() error
  • func (s *Service) Points() chan<- *cluster.WritePointsRequest
  • func (s *Service) SetLogOutput(w io.Writer)
  • func (s *Service) Update() error
• type UDP
  • func NewUDP(addr string) *UDP
  • func (u *UDP) WritePoints(p *cluster.WritePointsRequest) (err error)

Types

type BalanceMode

type BalanceMode int

BalanceMode sets what balance mode to use on a subscription. valid options are currently ALL or ANY

const (
	ALL BalanceMode = iota
	ANY
)

ALL is a Balance mode option

type Config

type Config struct {
	// Whether to enable to Subscriber service
	Enabled bool `toml:"enabled"`
}

Config represents a configuration of the subscriber service.

func NewConfig

func NewConfig() Config

NewConfig returns a new instance of a subscriber config.

type PointsWriter

type PointsWriter interface {
	WritePoints(p *cluster.WritePointsRequest) error
}

PointsWriter is an interface for writing points to a subscription destination. Only WritePoints() needs to be satisfied.

type Service

type Service struct {
	MetaClient interface {
		Databases() []meta.DatabaseInfo
		WaitForDataChanged() chan struct{}
	}
	NewPointsWriter func(u url.URL) (PointsWriter, error)
	Logger          *log.Logger
	// contains filtered or unexported fields
}

Service manages forking the incoming data from InfluxDB to defined third party destinations. Subscriptions are defined per database and retention policy.

func NewService

func NewService(c Config) *Service

NewService returns a subscriber service with given settings

func (*Service) Close

func (s *Service) Close() error

Close terminates the subscription service

func (*Service) Open

func (s *Service) Open() error

Open starts the subscription service.

func (*Service) Points

func (s *Service) Points() chan<- *cluster.WritePointsRequest

Points returns a channel into which write point requests can be sent.

func (*Service) SetLogOutput

func (s *Service) SetLogOutput(w io.Writer)

SetLogOutput sets the writer to which all logs are written. It must not be called after Open is called.

func (*Service) Update

func (s *Service) Update() error

Update will start new and stop deleted subscriptions.

type UDP

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

UDP supports writing points over UDP using the line protocol.

func NewUDP

func NewUDP(addr string) *UDP

NewUDP returns a new UDP listener with default options.

func (*UDP) WritePoints

func (u *UDP) WritePoints(p *cluster.WritePointsRequest) (err error)

WritePoints writes points over UDP transport.