ws

Documentation

Index

• type Event
  • func NewForwarderEvent(p *ForwarderPayload) *Event
  • func NewHeartbeatEvent() *Event
  • func NewIssueEvent(p *IssuePayload) *Event
  • func NewLogEvent(p *LogPayload) *Event
  • func NewMetricEvent(p *MetricPayload) *Event
  • func NewSpanEvent(p *SpanPayload) *Event
  • func NewThroughputEvent(p *ThroughputPayload) *Event
• type ForwarderPayload
• type Hub
  • func NewHub() *Hub
  • func (h *Hub) Broadcast(ev *Event)
  • func (h *Hub) ServeWS(w http.ResponseWriter, r *http.Request)
• type IssuePayload
• type LogPayload
• type MetricPayload
• type SpanEvent
• type SpanPayload
• type ThroughputPayload

Types

type Event

type Event struct {
	Type      string `json:"type"`
	Timestamp int64  `json:"timestamp_ns"`
	Payload   any    `json:"payload"`
}

Event is the outer discriminated union sent over the WebSocket.

func NewForwarderEvent

func NewForwarderEvent(p *ForwarderPayload) *Event

func NewHeartbeatEvent

func NewHeartbeatEvent() *Event

NewHeartbeatEvent is a payload-less liveness beat the server sends on a timer. Clients use its arrival (and the silence when it stops) to track connectivity.

func NewIssueEvent

func NewIssueEvent(p *IssuePayload) *Event

func NewLogEvent

func NewLogEvent(p *LogPayload) *Event

func NewMetricEvent

func NewMetricEvent(p *MetricPayload) *Event

func NewSpanEvent

func NewSpanEvent(p *SpanPayload) *Event

func NewThroughputEvent

func NewThroughputEvent(p *ThroughputPayload) *Event

type ForwarderPayload

type ForwarderPayload struct {
	URL          string `json:"url"`
	Sent         int64  `json:"sent"`
	Errors       int64  `json:"errors"`
	LastErr      string `json:"lastError,omitempty"`
	PendingBytes int64  `json:"pendingBytes,omitempty"`
	DroppedSpool int64  `json:"droppedSpool,omitempty"`
}

type Hub

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

func NewHub

func NewHub() *Hub

func (*Hub) Broadcast

func (h *Hub) Broadcast(ev *Event)

func (*Hub) ServeWS

func (h *Hub) ServeWS(w http.ResponseWriter, r *http.Request)

type IssuePayload

type IssuePayload struct {
	TraceID     string `json:"traceId"`
	Kind        string `json:"kind"`
	Fingerprint string `json:"fingerprint"`
	Count       int    `json:"count"`
	WastedNs    int64  `json:"wastedNs"`
}

type LogPayload

type LogPayload struct {
	TraceID     string `json:"traceId"`
	SpanID      string `json:"spanId"`
	Severity    int    `json:"severity"`
	Body        string `json:"body"`
	ServiceName string `json:"serviceName"`
	SessionID   string `json:"sessionId"`
}

type MetricPayload

type MetricPayload struct {
	Name        string  `json:"name"`
	ServiceName string  `json:"serviceName"`
	Value       float64 `json:"value"`
	Type        string  `json:"type"`
}

type SpanEvent

type SpanEvent = SpanPayload

SpanEvent is kept as a backward-compat alias for SpanPayload.

type SpanPayload

type SpanPayload struct {
	TraceID     string `json:"traceId"`
	SpanID      string `json:"spanId"`
	ServiceName string `json:"serviceName"`
	Name        string `json:"name"`
	DurationNs  int64  `json:"durationNs"`
	StatusCode  int    `json:"statusCode"`
}

type ThroughputPayload

type ThroughputPayload struct {
	SpansPerSec float64 `json:"spansPerSec"`
	LogsPerSec  float64 `json:"logsPerSec"`
}