server

Documentation

Overview

Package server contains the interface and implementation of the BindPlane Server

Index

• Constants
• func NewBindPlane(cfg *config.Config, logger *zap.Logger, s store.Store, versions agent.Versions) bpserver.BindPlane
• type Relayer
  • func (r *Relayer[T]) AwaitResult() (id string, result <-chan T, cancelFunc func())
  • func (r *Relayer[T]) SendResult(id string, result T)
• type Relayers
  • func NewRelayers(logger *zap.Logger) *Relayers
  • func (r *Relayers) Logs() server.Relayer[exposedserver.RelayLogs]
  • func (r *Relayers) Metrics() server.Relayer[exposedserver.RelayMetrics]
  • func (r *Relayers) Traces() server.Relayer[exposedserver.RelayTraces]

Constants

const HeaderSessionID = "X-BindPlane-Session-ID"

HeaderSessionID is the name of the HTTP header where a BindPlane Session ID can be found. This will be used by Relayer to match up the request with an eventual response via OTLP HTTP POST.

Functions

func NewBindPlane

func NewBindPlane(cfg *config.Config, logger *zap.Logger, s store.Store, versions agent.Versions) bpserver.BindPlane

NewBindPlane creates a new BindPlane Server using the given store and agent versions

Types

type Relayer

type Relayer[T any] struct {
	// contains filtered or unexported fields
}

Relayer forwards results to consumers awaiting the results. It is intentionally generic and is used to support cases where the request for results is decoupled from the response with the results.

func (*Relayer[T]) AwaitResult

func (r *Relayer[T]) AwaitResult() (id string, result <-chan T, cancelFunc func())

AwaitResult will create a new ID and channel where results will be received. It also returns a cancelFunc that must be called to cleanup the channel.

func (*Relayer[T]) SendResult

func (r *Relayer[T]) SendResult(id string, result T)

SendResult will forward results to the channel returned by AwaitResult

type Relayers

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

Relayers is a wrapper around multiple Relayer instances used for different types of results

func NewRelayers

func NewRelayers(logger *zap.Logger) *Relayers

NewRelayers returns a new set of Relayers

func (*Relayers) Logs

func (r *Relayers) Logs() server.Relayer[exposedserver.RelayLogs]

Logs returns the Relayer for logs

func (*Relayers) Metrics

func (r *Relayers) Metrics() server.Relayer[exposedserver.RelayMetrics]

Metrics returns the Relayer for metrics

func (*Relayers) Traces

func (r *Relayers) Traces() server.Relayer[exposedserver.RelayTraces]

Traces returns the Relayer for traces