config

package

v1.1.2 Latest Latest Go to latest Published: Feb 23, 2024 License: GPL-3.0 Imports: 14 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

Repository

github.com/rechecked/rcagent

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Contains(s []string, val string) bool
func FileExists(file string) bool
func GetConfigDirFilePath(path string) string
func GetConfigFilePath(name string) string
func GetPluginDirFilePath(name string) string
func InitConfig(file string, defaultFile embed.FS) error
func LogDebug(v ...interface{})
func LogDebugf(format string, a ...interface{})
func ParseConfig() error
func ParseConfigDir()
func ParseFile(defaultFile embed.FS) error
func ParseSecretsFile() (map[string]string, error)
func ParseVersion(versionFile embed.FS)
func UsingManager() bool
type CheckCfg
- func (c *CheckCfg) Name() string
type Data
type ManagerCfg
type SenderCfg
type Values
- func ParseValues(r *http.Request) Values
- func (v *Values) GetUnits() string

Constants ¶

This section is empty.

Variables ¶

View Source

var AllowedUnits = []string{"B", "kB", "MB", "GB", "TB", "PB", "KiB", "MiB", "GiB", "TiB", "PiB"}

View Source

var ConfigDefaultFile embed.FS

View Source

var ConfigDir string

View Source

var ConfigFile string

View Source

var DebugMode bool

View Source

var Log service.Logger

View Source

var PluginDir string

View Source

var Settings = new(settings)

View Source

var Version string

Functions ¶

func Contains ¶

func Contains(s []string, val string) bool

func FileExists ¶

func FileExists(file string) bool

func GetConfigDirFilePath ¶ added in v1.1.0

func GetConfigDirFilePath(path string) string

func GetConfigFilePath ¶ added in v1.1.0

func GetConfigFilePath(name string) string

func GetPluginDirFilePath ¶ added in v1.1.0

func GetPluginDirFilePath(name string) string

func InitConfig ¶ added in v1.1.0

func InitConfig(file string, defaultFile embed.FS) error

func LogDebug ¶ added in v1.1.0

func LogDebug(v ...interface{})

func LogDebugf ¶ added in v1.1.0

func LogDebugf(format string, a ...interface{})

func ParseConfig ¶ added in v1.1.0

func ParseConfig() error

func ParseConfigDir ¶ added in v1.1.0

func ParseConfigDir()

Run through all YAML config files in the config directory if it exists and import any configurations for checks and senders. Does not return actual error but logs issues.

func ParseFile ¶

func ParseFile(defaultFile embed.FS) error

func ParseSecretsFile ¶ added in v1.1.0

func ParseSecretsFile() (map[string]string, error)

func ParseVersion ¶ added in v1.0.1

func ParseVersion(versionFile embed.FS)

Set the version to the version in the VERSION file if it doesn't already exist during build time (this is mostly for DEV)

func UsingManager ¶ added in v1.1.0

func UsingManager() bool

Types ¶

type CheckCfg ¶

type CheckCfg struct {
	Hostname    string `yaml:"hostname"`
	Address     string `yaml:"address"`
	Servicename string `yaml:"servicename"`
	Interval    string `yaml:"interval"`
	Endpoint    string `yaml:"endpoint"`
	Options     Values `yaml:"options"`
	Disabled    bool
	NextRun     time.Time
}

func (*CheckCfg) Name ¶ added in v1.1.0

func (c *CheckCfg) Name() string

type Data ¶ added in v1.1.0

type Data struct {
	Checks    []CheckCfg
	Senders   []SenderCfg
	Secrets   map[string]string
	HostAddrs map[string]string
	sync.RWMutex
}

var CfgData Data

Actual config data (checks, senders, secrets) after parse

type ManagerCfg ¶ added in v1.1.0

type ManagerCfg struct {
	Url        string `yaml:"url"`
	APIKey     string `yaml:"apikey"`
	IgnoreCert bool   `yaml:"ignoreCert"`
}

type SenderCfg ¶

type SenderCfg struct {
	Name  string `yaml:"name"`
	Url   string `yaml:"url"`
	Token string `yaml:"token"`
	Type  string `yaml:"type"`
}

type Values ¶

type Values struct {
	Check    bool
	Pretty   bool
	Plugin   string
	Name     string
	Path     string
	Args     []string
	Against  string
	Expected string
	Warning  string
	Critical string
	Delta    int
	Units    string
}

func ParseValues ¶

func ParseValues(r *http.Request) Values

func (*Values) GetUnits ¶ added in v1.1.0

func (v *Values) GetUnits() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL