ss

Documentation

Overview

Package ss holds shared internal types for sseq.

Index

• Constants
• type BatchConfig
• type Encoder
• type Sender
  • func NewSender(config BatchConfig, encoder Encoder, writer Writer) *Sender
  • func (sender *Sender) Close() error
  • func (sender *Sender) Send(event SpanEvent) error
• type SpanEvent
• type TimedEvent
• type Writer

Constants

const (
	DefaultBatchSize     = 20
	DefaultFlushInterval = time.Second
	DefaultHTTPTimeout   = 10 * time.Second
)

Types

type BatchConfig

type BatchConfig struct {
	BatchSize     int
	FlushInterval time.Duration
}

BatchConfig controls asynchronous flush behavior.

type Encoder

type Encoder interface {
	Encode(event SpanEvent) ([]byte, error)
}

Encoder serializes span events for a provider.

type Sender

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

Sender batches encoded spans and flushes them through a Writer.

func NewSender

func NewSender(config BatchConfig, encoder Encoder, writer Writer) *Sender

NewSender creates an asynchronous span sender.

func (*Sender) Close

func (sender *Sender) Close() error

Close flushes buffered events and releases the writer.

func (*Sender) Send

func (sender *Sender) Send(event SpanEvent) error

Send encodes and queues a span event for delivery.

type SpanEvent

type SpanEvent struct {
	Name           string
	Application    string
	TraceID        string
	SpanID         string
	ParentID       string
	SpanKind       string
	StartTime      time.Time
	EndTime        time.Time
	HasError       bool
	StatusMessage  string
	HTTPStatusCode int
	Events         []TimedEvent
	Attributes     map[string]any
}

SpanEvent is a completed span ready for encoding and delivery.

type TimedEvent

type TimedEvent struct {
	Name       string
	Time       time.Time
	Attributes map[string]any
}

TimedEvent is a point-in-time annotation attached to a span.

type Writer

type Writer interface {
	WritePayload(payload []byte)
	Close() error
}

Writer delivers encoded payload batches.