remote

Documentation

Overview

Package remote implements a generic workloadmeta Collector that receives events from a remote workloadmeta server.

Index

• type GenericCollector
  • func (c *GenericCollector) GetID() string
  • func (c *GenericCollector) GetTargetCatalog() workloadmeta.AgentType
  • func (c *GenericCollector) Pull(context.Context) error
  • func (c *GenericCollector) Run()
  • func (c *GenericCollector) Start(ctx context.Context, store workloadmeta.Component) error
• type GrpcClient
• type Stream
• type StreamHandler

Types

type GenericCollector

type GenericCollector struct {
	CollectorID   string
	Catalog       workloadmeta.AgentType
	StreamHandler StreamHandler

	Insecure bool // for testing
	// contains filtered or unexported fields
}

GenericCollector is a generic remote workloadmeta collector with resync mechanisms.

func (*GenericCollector) GetID

func (c *GenericCollector) GetID() string

GetID gets the identifier for the generic collector

func (*GenericCollector) GetTargetCatalog

func (c *GenericCollector) GetTargetCatalog() workloadmeta.AgentType

GetTargetCatalog gets the catalog this collector should target

func (*GenericCollector) Pull

func (c *GenericCollector) Pull(context.Context) error

Pull does nothing in workloadmeta collectors.

func (*GenericCollector) Run

func (c *GenericCollector) Run()

Run will run the generic collector streaming loop

func (*GenericCollector) Start

func (c *GenericCollector) Start(ctx context.Context, store workloadmeta.Component) error

Start starts the generic collector

type GrpcClient

type GrpcClient interface {
	// StreamEntites establishes the stream between the client and the remote gRPC server.
	StreamEntities(ctx context.Context, opts ...grpc.CallOption) (Stream, error)
}

GrpcClient interface that represents a gRPC client for the remote workloadmeta.

type Stream

type Stream interface {
	// Recv returns a response of the gRPC server
	Recv() (interface{}, error)
}

Stream is an interface that represents a gRPC stream.

type StreamHandler

type StreamHandler interface {
	// Port returns the targeted port
	Port() int
	// IsEnabled returns if the feature is enabled
	IsEnabled() bool
	// NewClient returns a client to connect to a remote gRPC server.
	NewClient(cc grpc.ClientConnInterface) GrpcClient
	// HandleResponse handles a response from the remote gRPC server.
	HandleResponse(response interface{}) ([]workloadmeta.CollectorEvent, error)
	// HandleResync is called on resynchronization.
	HandleResync(store workloadmeta.Component, events []workloadmeta.CollectorEvent)
}

StreamHandler is an interface that defines a gRPC stream handler.