shared

Documentation

Index

• func RunChecklist(checks ...Check) error
• type Check
  • func TCPConnect(host string) Check
• type Commons
• type EnvBinding
• type Log
• type Tracing

Functions

func RunChecklist

func RunChecklist(checks ...Check) error

RunChecklist runs all the given checks

Types

type Check

type Check func() error

Check is a single health-check

func TCPConnect

func TCPConnect(host string) Check

TCPConnect connects to a given tcp endpoint

type Commons

type Commons struct {
	Log     *Log     `yaml:"log"`
	Tracing *Tracing `yaml:"tracing"`
	OcisURL string   `yaml:"ocis_url" env:"OCIS_URL"`
}

Commons holds configuration that are common to all extensions. Each extension can then decide whether to overwrite its values.

type EnvBinding

type EnvBinding struct {
	EnvVars     []string    // name of the environment var.
	Destination interface{} // pointer to the original config value to modify.
}

EnvBinding represents a direct binding from an env variable to a go kind. Along with gookit/config, its primal goal is to unpack environment variables into a Go value. We do so with reflection, and this data structure is just a step in between.

type Log

type Log struct {
	Level  string `yaml:"level" env:"OCIS_LOG_LEVEL"`
	Pretty bool   `yaml:"pretty" env:"OCIS_LOG_PRETTY"`
	Color  bool   `yaml:"color" env:"OCIS_LOG_COLOR"`
	File   string `yaml:"file" env:"OCIS_LOG_FILE"`
}

Log defines the available logging configuration.

type Tracing

type Tracing struct {
	Enabled   bool   `yaml:"enabled" env:"OCIS_TRACING_ENABLED"`
	Type      string `yaml:"type" env:"OCIS_TRACING_TYPE"`
	Endpoint  string `yaml:"endpoint" env:"OCIS_TRACING_ENDPOINT"`
	Collector string `yaml:"collector" env:"OCIS_TRACING_COLLECTOR"`
}

Tracing defines the available tracing configuration.