telemetry

Documentation

Index

• Constants
• func RunAdditionalOperations(cfg *Config) error
• type Config
  • func NewConfig(port uint) *Config
  • func ParseConfig(bytes []byte) (*Config, error)
• type Module
  • func NewModule(cfg config.Config) *Module
  • func (m *Module) Name() string
  • func (m *Module) RunAdditionalOperations() error

Constants

const (
	ModuleName = "telemetry"
)

Functions

func RunAdditionalOperations

func RunAdditionalOperations(cfg *Config) error

RunAdditionalOperations runs the module additional operations

Types

type Config

type Config struct {
	Port uint `yaml:"port"`
}

Config represents the configuration for the telemetry module

func NewConfig

func NewConfig(port uint) *Config

NewConfig allows to build a new Config instance

func ParseConfig

func ParseConfig(bytes []byte) (*Config, error)

ParseConfig allows to parse a byte array as a Config instance

type Module

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

Module represents the telemetry module

func NewModule

func NewModule(cfg config.Config) *Module

NewModule returns a new Module implementation

func (*Module) Name

func (m *Module) Name() string

Name implements modules.Module

func (*Module) RunAdditionalOperations

func (m *Module) RunAdditionalOperations() error

RunAdditionalOperations implements modules.AdditionalOperationsModule