serializer

README

package serializer

The Serializer is in charge of routing payloads from the different parts of the agent to the Forwarder. The backend currently offers 2 versions of the intake API. The V1 version takes JSON payloads, the V2 take protocol buffer payloads or JSON depending on endpoint.

While moving all the existing endpoints to the new format, the agent will support both API. That is why the serializer is here to choose a serialization protocol depending on the content and use the correct Forwarder method.

To be sent, a payload needs to implement the Marshaler interface.

Old V1 intake endpoint

The intake endpoint from the V1 API could ingest a large variety of JSON structs. To send arbitrary payloads to this endpoint use SendJSONToV1Intake that do not require a Marshaler object.

Documentation

Index

• Variables
• type EventsStreamJSONMarshaler
• type MetricSerializer
• type MockSerializer
  • func (s *MockSerializer) SendEvents(e EventsStreamJSONMarshaler) error
  • func (s *MockSerializer) SendJSONToV1Intake(data interface{}) error
  • func (s *MockSerializer) SendMetadata(m marshaler.Marshaler) error
  • func (s *MockSerializer) SendSeries(series marshaler.StreamJSONMarshaler) error
  • func (s *MockSerializer) SendServiceChecks(sc marshaler.StreamJSONMarshaler) error
  • func (s *MockSerializer) SendSketch(sketches marshaler.Marshaler) error
• type Serializer
  • func NewSerializer(forwarder forwarder.Forwarder) *Serializer
  • func (s *Serializer) SendEvents(e EventsStreamJSONMarshaler) error
  • func (s *Serializer) SendJSONToV1Intake(data interface{}) error
  • func (s *Serializer) SendMetadata(m marshaler.Marshaler) error
  • func (s *Serializer) SendSeries(series marshaler.StreamJSONMarshaler) error
  • func (s *Serializer) SendServiceChecks(sc marshaler.StreamJSONMarshaler) error
  • func (s *Serializer) SendSketch(sketches marshaler.Marshaler) error

Variables

var (
	// AgentPayloadVersion is the versions of the agent-payload repository
	// used to serialize to protobuf
	AgentPayloadVersion string
)

Types

type EventsStreamJSONMarshaler

type EventsStreamJSONMarshaler interface {
	marshaler.Marshaler

	// Create a single marshaler.
	CreateSingleMarshaler() marshaler.StreamJSONMarshaler

	// If the single marshaler cannot serialize, use smaller marshalers.
	CreateMarshalersBySourceType() []marshaler.StreamJSONMarshaler
}

EventsStreamJSONMarshaler handles two serialization logics.

type MetricSerializer

type MetricSerializer interface {
	SendEvents(e EventsStreamJSONMarshaler) error
	SendServiceChecks(sc marshaler.StreamJSONMarshaler) error
	SendSeries(series marshaler.StreamJSONMarshaler) error
	SendSketch(sketches marshaler.Marshaler) error
	SendMetadata(m marshaler.Marshaler) error
	SendJSONToV1Intake(data interface{}) error
}

MetricSerializer represents the interface of method needed by the aggregator to serialize its data

type MockSerializer

type MockSerializer struct {
	mock.Mock
}

MockSerializer is a mock for the MetricSerializer

func (*MockSerializer) SendEvents

func (s *MockSerializer) SendEvents(e EventsStreamJSONMarshaler) error

SendEvents serializes a list of event and sends the payload to the forwarder

func (*MockSerializer) SendJSONToV1Intake

func (s *MockSerializer) SendJSONToV1Intake(data interface{}) error

SendJSONToV1Intake serializes a payload and sends it to the forwarder. Some code sends arbitrary payload the v1 API.

func (*MockSerializer) SendMetadata

func (s *MockSerializer) SendMetadata(m marshaler.Marshaler) error

SendMetadata serializes a metadata payload and sends it to the forwarder

func (*MockSerializer) SendSeries

func (s *MockSerializer) SendSeries(series marshaler.StreamJSONMarshaler) error

SendSeries serializes a list of serviceChecks and sends the payload to the forwarder

func (*MockSerializer) SendServiceChecks

func (s *MockSerializer) SendServiceChecks(sc marshaler.StreamJSONMarshaler) error

SendServiceChecks serializes a list of serviceChecks and sends the payload to the forwarder

func (*MockSerializer) SendSketch

func (s *MockSerializer) SendSketch(sketches marshaler.Marshaler) error

SendSketch serializes a list of SketSeriesList and sends the payload to the forwarder

type Serializer

type Serializer struct {
	Forwarder forwarder.Forwarder
	// contains filtered or unexported fields
}

Serializer serializes metrics to the correct format and routes the payloads to the correct endpoint in the Forwarder

func NewSerializer

func NewSerializer(forwarder forwarder.Forwarder) *Serializer

NewSerializer returns a new Serializer initialized

func (*Serializer) SendEvents

func (s *Serializer) SendEvents(e EventsStreamJSONMarshaler) error

SendEvents serializes a list of event and sends the payload to the forwarder

func (*Serializer) SendJSONToV1Intake

func (s *Serializer) SendJSONToV1Intake(data interface{}) error

SendJSONToV1Intake serializes a payload and sends it to the forwarder. Some code sends arbitrary payload the v1 API.

func (*Serializer) SendMetadata

func (s *Serializer) SendMetadata(m marshaler.Marshaler) error

SendMetadata serializes a metadata payload and sends it to the forwarder

func (*Serializer) SendSeries

func (s *Serializer) SendSeries(series marshaler.StreamJSONMarshaler) error

SendSeries serializes a list of serviceChecks and sends the payload to the forwarder

func (*Serializer) SendServiceChecks

func (s *Serializer) SendServiceChecks(sc marshaler.StreamJSONMarshaler) error

SendServiceChecks serializes a list of serviceChecks and sends the payload to the forwarder

func (*Serializer) SendSketch

func (s *Serializer) SendSketch(sketches marshaler.Marshaler) error

SendSketch serializes a list of SketSeriesList and sends the payload to the forwarder