module

package

v0.0.0-...-7983b3b Latest Latest Go to latest Published: Apr 8, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

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.

func Close()

Close each registered module

func GetStats() map[string]interface{}

GetStats returns the stats from all modules, namespaced by their names

func Register(cfg *config.Config, httpMux *mux.Router, factories []Factory) error

Register a set of modules, which involves: * Initialization using the provided Factory; * Registering the HTTP endpoints of each module;

func RestartModule(factory Factory) error

RestartModule triggers a module restart

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

Factory encapsulates the initialization of a Module

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

Module defines the common API implemented by every System Probe Module

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

Router provides a wrapper around mux.Router so routes can be re-registered This is needed to support the module-restart feature

func NewRouter(mux *mux.Router) *Router

NewRouter returns a new Router

func (r *Router) HandleFunc(path string, responseWriter func(http.ResponseWriter, *http.Request)) *mux.Route

HandleFunc registers a HandleFunc in such a way that routes can be registered multiple times