collector

Documentation

Index

• type Collector
  • func New(config *Config, targetConfigs map[string]*types.TargetConfig, ...) *Collector
  • func (c *Collector) AddInput(name string, cfg map[string]interface{}) error
  • func (c *Collector) AddOutput(name string, cfg map[string]interface{}) error
  • func (c *Collector) AddSubscriptionConfig(sc *types.SubscriptionConfig) error
  • func (c *Collector) AddTarget(tc *types.TargetConfig) error
  • func (c *Collector) Capabilities(ctx context.Context, tName string, ext ...*gnmi_ext.Extension) (*gnmi.CapabilityResponse, error)
  • func (c *Collector) CreateTarget(name string) error
  • func (c *Collector) DeleteOutput(name string) error
  • func (c *Collector) DeleteSubscription(name string) error
  • func (c *Collector) DeleteTarget(ctx context.Context, name string) error
  • func (c *Collector) Export(ctx context.Context, rsp *gnmi.SubscribeResponse, m outputs.Meta, ...)
  • func (c *Collector) Get(ctx context.Context, tName string, req *gnmi.GetRequest) (*gnmi.GetResponse, error)
  • func (c *Collector) GetModels(ctx context.Context, tName string) ([]*gnmi.ModelData, error)
  • func (c *Collector) InitInputs(ctx context.Context)
  • func (c *Collector) InitOutput(ctx context.Context, name string, tcs map[string]*types.TargetConfig)
  • func (c *Collector) InitOutputs(ctx context.Context)
  • func (c *Collector) PolledSubscriptionsTargets() map[string][]string
  • func (c *Collector) Set(ctx context.Context, tName string, req *gnmi.SetRequest) (*gnmi.SetResponse, error)
  • func (c *Collector) Start(ctx context.Context)
  • func (c *Collector) StopTarget(ctx context.Context, name string) error
  • func (c *Collector) Subscribe(ctx context.Context, tName string) error
  • func (c *Collector) SubscribeOnce(ctx context.Context, tName string) error
  • func (c *Collector) TargetPoll(targetName, subscriptionName string) (*gnmi.SubscribeResponse, error)
  • func (c *Collector) TargetSubscribeOnce(ctx context.Context, name string) error
  • func (c *Collector) TargetSubscribePoll(ctx context.Context, name string)
  • func (c *Collector) TargetSubscribeStream(ctx context.Context, name string)
• type CollectorOption
  • func WithCache(ch *cache.Cache) CollectorOption
  • func WithDialOptions(dialOptions []grpc.DialOption) CollectorOption
  • func WithEventProcessors(eps map[string]map[string]interface{}) CollectorOption
  • func WithInputs(inputsConfig map[string]map[string]interface{}) CollectorOption
  • func WithLocker(locker lockers.Locker) CollectorOption
  • func WithLogger(logger *log.Logger) CollectorOption
  • func WithOutputs(outs map[string]map[string]interface{}) CollectorOption
  • func WithPrometheusRegistry(reg *prometheus.Registry) CollectorOption
  • func WithProtoDescriptor(d desc.Descriptor) CollectorOption
  • func WithSubscriptions(subs map[string]*types.SubscriptionConfig) CollectorOption
• type Config

Types

type Collector

type Collector struct {
	Config *Config

	Subscriptions map[string]*types.SubscriptionConfig

	Outputs map[string]outputs.Output

	Inputs map[string]inputs.Input

	Targets map[string]*target.Target

	EventProcessorsConfig map[string]map[string]interface{}
	// contains filtered or unexported fields
}

Collector //

func New

func New(config *Config, targetConfigs map[string]*types.TargetConfig, opts ...CollectorOption) *Collector

New //

func (*Collector) AddInput

func (c *Collector) AddInput(name string, cfg map[string]interface{}) error

AddInput adds an input called name, with config cfg to the collector instance

func (*Collector) AddOutput

func (c *Collector) AddOutput(name string, cfg map[string]interface{}) error

AddOutput initializes an output called name, with config cfg if it does not already exist

func (*Collector) AddSubscriptionConfig

func (c *Collector) AddSubscriptionConfig(sc *types.SubscriptionConfig) error

AddSubscriptionConfig adds a subscriptionConfig sc to Collector's map if it does not already exists

func (*Collector) AddTarget

func (c *Collector) AddTarget(tc *types.TargetConfig) error

AddTarget initializes a target based on *TargetConfig

func (*Collector) Capabilities

func (c *Collector) Capabilities(ctx context.Context, tName string, ext ...*gnmi_ext.Extension) (*gnmi.CapabilityResponse, error)

func (*Collector) CreateTarget

func (c *Collector) CreateTarget(name string) error

func (*Collector) DeleteOutput

func (c *Collector) DeleteOutput(name string) error

func (*Collector) DeleteSubscription

func (c *Collector) DeleteSubscription(name string) error

func (*Collector) DeleteTarget

func (c *Collector) DeleteTarget(ctx context.Context, name string) error

func (*Collector) Export

func (c *Collector) Export(ctx context.Context, rsp *gnmi.SubscribeResponse, m outputs.Meta, outs ...string)

func (*Collector) Get

func (c *Collector) Get(ctx context.Context, tName string, req *gnmi.GetRequest) (*gnmi.GetResponse, error)

func (*Collector) GetModels

func (c *Collector) GetModels(ctx context.Context, tName string) ([]*gnmi.ModelData, error)

func (*Collector) InitInputs

func (c *Collector) InitInputs(ctx context.Context)

func (*Collector) InitOutput

func (c *Collector) InitOutput(ctx context.Context, name string, tcs map[string]*types.TargetConfig)

func (*Collector) InitOutputs

func (c *Collector) InitOutputs(ctx context.Context)

func (*Collector) PolledSubscriptionsTargets

func (c *Collector) PolledSubscriptionsTargets() map[string][]string

PolledSubscriptionsTargets returns a map of target name to a list of subscription names that have Mode == POLL

func (*Collector) Set

func (c *Collector) Set(ctx context.Context, tName string, req *gnmi.SetRequest) (*gnmi.SetResponse, error)

func (*Collector) Start

func (c *Collector) Start(ctx context.Context)

Start start the prometheus server as well as a goroutine per target selecting on the response chan, the error chan and the ctx.Done() chan

func (*Collector) StopTarget

func (c *Collector) StopTarget(ctx context.Context, name string) error

func (*Collector) Subscribe

func (c *Collector) Subscribe(ctx context.Context, tName string) error

Subscribe //

func (*Collector) SubscribeOnce

func (c *Collector) SubscribeOnce(ctx context.Context, tName string) error

func (*Collector) TargetPoll

func (c *Collector) TargetPoll(targetName, subscriptionName string) (*gnmi.SubscribeResponse, error)

TargetPoll sends a gnmi.SubscribeRequest_Poll to targetName and returns the response and an error, it uses the targetName and the subscriptionName strings to find the gnmi.GNMI_SubscribeClient

func (*Collector) TargetSubscribeOnce

func (c *Collector) TargetSubscribeOnce(ctx context.Context, name string) error

func (*Collector) TargetSubscribePoll

func (c *Collector) TargetSubscribePoll(ctx context.Context, name string)

func (*Collector) TargetSubscribeStream

func (c *Collector) TargetSubscribeStream(ctx context.Context, name string)

type CollectorOption

type CollectorOption func(c *Collector)

func WithCache

func WithCache(ch *cache.Cache) CollectorOption

func WithDialOptions

func WithDialOptions(dialOptions []grpc.DialOption) CollectorOption

func WithEventProcessors

func WithEventProcessors(eps map[string]map[string]interface{}) CollectorOption

func WithInputs

func WithInputs(inputsConfig map[string]map[string]interface{}) CollectorOption

func WithLocker

func WithLocker(locker lockers.Locker) CollectorOption

func WithLogger

func WithLogger(logger *log.Logger) CollectorOption

func WithOutputs

func WithOutputs(outs map[string]map[string]interface{}) CollectorOption

func WithPrometheusRegistry

func WithPrometheusRegistry(reg *prometheus.Registry) CollectorOption

func WithProtoDescriptor

func WithProtoDescriptor(d desc.Descriptor) CollectorOption

func WithSubscriptions

func WithSubscriptions(subs map[string]*types.SubscriptionConfig) CollectorOption

type Config

type Config struct {
	Name                string
	Debug               bool
	Format              string
	TargetReceiveBuffer uint
	RetryTimer          time.Duration
	ClusterName         string
	LockRetryTimer      time.Duration
}

Config is the collector config