collector

Documentation

Index

• type CollectingProcess
  • func InitCollectingProcess(input CollectorInput) (*CollectingProcess, error)
  • func (cp *CollectingProcess) GetAddress() net.Addr
  • func (cp *CollectingProcess) GetMsgChan() <-chan *entities.Message
  • func (cp *CollectingProcess) GetNumConnToCollector() int64
  • func (cp *CollectingProcess) GetNumRecordsReceived() int64
  • func (cp *CollectingProcess) Start()
  • func (cp *CollectingProcess) Stop()
• type CollectorInput
• type DecodingMode

Types

type CollectingProcess

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

func InitCollectingProcess

func InitCollectingProcess(input CollectorInput) (*CollectingProcess, error)

func (*CollectingProcess) GetAddress

func (cp *CollectingProcess) GetAddress() net.Addr

func (*CollectingProcess) GetMsgChan

func (cp *CollectingProcess) GetMsgChan() <-chan *entities.Message

func (*CollectingProcess) GetNumConnToCollector

func (cp *CollectingProcess) GetNumConnToCollector() int64

func (*CollectingProcess) GetNumRecordsReceived

func (cp *CollectingProcess) GetNumRecordsReceived() int64

func (*CollectingProcess) Start

func (cp *CollectingProcess) Start()

func (*CollectingProcess) Stop

func (cp *CollectingProcess) Stop()

type CollectorInput

type CollectorInput struct {
	IsIPv6      bool
	IsEncrypted bool
	// Address needs to be provided in hostIP:port format.
	Address string
	// Protocol needs to be provided in lower case format.
	// We support "tcp" and "udp" protocols.
	Protocol      string
	MaxBufferSize uint16
	TemplateTTL   uint32
	// TODO: group following fields into struct to be reuse in exporter
	CACert           []byte
	ServerCert       []byte
	ServerKey        []byte
	NumExtraElements int
	// DecodingMode specifies how unknown information elements (in templates) are handled when
	// decoding. The default value is DecodingModeStrict for historical reasons. For most uses,
	// DecodingModeLenientKeepUnknown is the most appropriate mode.
	DecodingMode DecodingMode
}

type DecodingMode

type DecodingMode string

DecodingMode specifies how unknown information elements (in templates) are handled when decoding. Unknown information elements are elements which are not part of the static registry included with the library. Note that regardless of the DecodingMode, data sets must always match the corresponding template.

const (
	// DecodingModeStrict will cause decoding to fail when an unknown IE is encountered in a template.
	DecodingModeStrict DecodingMode = "Strict"
	// DecodingModeLenientKeepUnknown will accept unknown IEs in templates. When decoding the
	// corresponding field in a data record, the value will be preserved (as an octet array).
	DecodingModeLenientKeepUnknown DecodingMode = "LenientKeepUnknown"
	// DecodingModeLenientDropUnknown will accept unknown IEs in templates. When decoding the
	// corresponding field in a data record, the value will be dropped (information element will
	// not be present in the resulting Record). Be careful when using this mode as the IEs
	// included in the resulting Record will no longer match the received template.
	DecodingModeLenientDropUnknown DecodingMode = "LenientDropUnknown"
)