snmptrap

Documentation

Index

• type Config
  • func NewConfig() Config
  • func (c Config) Validate() error
• type Data
• type Diagnostic
• type HandlerConfig
• type Service
  • func NewService(c Config, d Diagnostic) *Service
  • func (s *Service) Close() error
  • func (s *Service) Handler(c HandlerConfig, ctx ...keyvalue.T) (alert.Handler, error)
  • func (s *Service) Open() error
  • func (s *Service) Test(options interface{}) error
  • func (s *Service) TestOptions() interface{}
  • func (s *Service) Trap(trapOid string, dataList []Data) error
  • func (s *Service) Update(newConfig []interface{}) error

Types

type Config

type Config struct {
	// Whether Snmptrap is enabled.
	Enabled bool `toml:"enabled" override:"enabled"`
	// The host:port address of the SNMP trap server
	Addr string `toml:"addr" override:"addr"`
	// SNMP Community
	Community string `toml:"community" override:"community,redact"`
	// Retries count for traps
	Retries int `toml:"retries" override:"retries"`
}

func NewConfig

func NewConfig() Config

func (Config) Validate

func (c Config) Validate() error

type Data

type Data struct {
	Oid   string `mapstructure:"oid" json:"oid"`
	Type  string `mapstructure:"type" json:"type"`
	Value string `mapstructure:"value" json:"value"`
	// contains filtered or unexported fields
}

type Diagnostic

type Diagnostic interface {
	WithContext(ctx ...keyvalue.T) Diagnostic
	Error(msg string, err error)
}

type HandlerConfig

type HandlerConfig struct {
	TrapOid  string `mapstructure:"trap-oid"`
	DataList []Data `mapstructure:"data-list"`
}

type Service

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

func NewService

func NewService(c Config, d Diagnostic) *Service

func (*Service) Close

func (s *Service) Close() error

func (*Service) Handler

func (s *Service) Handler(c HandlerConfig, ctx ...keyvalue.T) (alert.Handler, error)

Handler creates a handler from the config.

func (*Service) Open

func (s *Service) Open() error

func (*Service) Test

func (s *Service) Test(options interface{}) error

func (*Service) TestOptions

func (s *Service) TestOptions() interface{}

func (*Service) Trap

func (s *Service) Trap(trapOid string, dataList []Data) error

func (*Service) Update

func (s *Service) Update(newConfig []interface{}) error