observer

Documentation

Index

• Variables
• type GRPCServer
• type LocalObserverServer
  • func NewLocalServer(payloadParser *parser.Parser, logger logrus.FieldLogger, ...) (*LocalObserverServer, error)
  • func (s *LocalObserverServer) GetEventsChannel() chan *flowpb.Payload
  • func (s *LocalObserverServer) GetFlows(req *observerpb.GetFlowsRequest, server observerpb.Observer_GetFlowsServer) (err error)
  • func (s *LocalObserverServer) GetLogger() logrus.FieldLogger
  • func (s *LocalObserverServer) GetOptions() observeroption.Options
  • func (s *LocalObserverServer) GetPayloadParser() *parser.Parser
  • func (s *LocalObserverServer) GetRingBuffer() *container.Ring
  • func (s *LocalObserverServer) GetStopped() chan struct{}
  • func (s *LocalObserverServer) ServerStatus(ctx context.Context, req *observerpb.ServerStatusRequest) (*observerpb.ServerStatusResponse, error)
  • func (s *LocalObserverServer) SetEventsChannel(events chan *flowpb.Payload)
  • func (s *LocalObserverServer) Start()

Variables

var DefaultOptions []observeroption.Option

DefaultOptions to include in the server. Other packages may extend this in their init() function.

Types

type GRPCServer

type GRPCServer interface {
	observerpb.ObserverServer
	// Start starts the server and blocks.
	Start()
	// GetEventsChannel returns the channel to push monitor events to.
	GetEventsChannel() chan *flowpb.Payload
	// SetEventsChannel sets the events channel. For unit testing only.
	SetEventsChannel(chan *flowpb.Payload)
	///GetRingBuffer returns the underlying ring buffer to parsed events.
	GetRingBuffer() *container.Ring
	// GetStopped returns a channel that gets closed at the end of the
	// main server loop after all the events have been processes. Used
	// in unit testing.
	GetStopped() chan struct{}
	// GetLogger returns the logger assigned to this gRPC server.
	GetLogger() logrus.FieldLogger
}

GRPCServer defines the interface for Hubble gRPC server, extending the auto-generated ObserverServer interface from the protobuf definition.

type LocalObserverServer

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

LocalObserverServer is an implementation of the server.Observer interface that's meant to be run embedded inside the Cilium process. It ignores all the state change events since the state is available locally.

func NewLocalServer

func NewLocalServer(
	payloadParser *parser.Parser,
	logger logrus.FieldLogger,
	options ...observeroption.Option,
) (*LocalObserverServer, error)

NewLocalServer returns a new local observer server.

func (*LocalObserverServer) GetEventsChannel

func (s *LocalObserverServer) GetEventsChannel() chan *flowpb.Payload

GetEventsChannel returns the event channel to receive flowpb.Payload events.

func (*LocalObserverServer) GetFlows

func (s *LocalObserverServer) GetFlows(
	req *observerpb.GetFlowsRequest,
	server observerpb.Observer_GetFlowsServer,
) (err error)

GetFlows implements the proto method for client requests.

func (*LocalObserverServer) GetLogger

func (s *LocalObserverServer) GetLogger() logrus.FieldLogger

GetLogger implements GRPCServer.GetLogger.

func (*LocalObserverServer) GetOptions

func (s *LocalObserverServer) GetOptions() observeroption.Options

GetOptions implements serveroptions.Server.GetOptions.

func (*LocalObserverServer) GetPayloadParser

func (s *LocalObserverServer) GetPayloadParser() *parser.Parser

GetPayloadParser implements GRPCServer.GetPayloadParser.

func (*LocalObserverServer) GetRingBuffer

func (s *LocalObserverServer) GetRingBuffer() *container.Ring

GetRingBuffer implements GRPCServer.GetRingBuffer.

func (*LocalObserverServer) GetStopped

func (s *LocalObserverServer) GetStopped() chan struct{}

GetStopped implements GRPCServer.GetStopped.

func (*LocalObserverServer) ServerStatus

func (s *LocalObserverServer) ServerStatus(
	ctx context.Context, req *observerpb.ServerStatusRequest,
) (*observerpb.ServerStatusResponse, error)

ServerStatus should have a comment, apparently. It returns the server status.

func (*LocalObserverServer) SetEventsChannel

func (s *LocalObserverServer) SetEventsChannel(events chan *flowpb.Payload)

SetEventsChannel implements GRPCServer.SetEventsChannel.

func (*LocalObserverServer) Start

func (s *LocalObserverServer) Start()

Start implements GRPCServer.Start.