api

Documentation

Index

• Variables
• type Factory
• type Module

Variables

var ErrNotEnabled = errors.New("module is not enabled")

ErrNotEnabled is a special error type that should be returned by a Factory when the associated Module is not enabled.

Types

type Factory

type Factory struct {
	Name config.ModuleName
	Fn   func(cfg *config.Config) (Module, error)
}

Factory encapsulates the initialization of a Module

type Module

type Module interface {
	GetStats() map[string]interface{}
	Register(*http.ServeMux) error
	Close()
}

Module defines the common API implemented by every System Probe Module