config

Documentation

Index

• Constants
• Variables
• func Read(configFile string) error
• func ReadIfPresent()
• func SetupTracing()
• func ShutdownTracing()
• type Config
• type ForwarderConfig
• type ReadinessConfig
• type ReceiverConfig
• type ReceiverErrorConfig
• type ReceiverProgressConfig
• type ReceiverTeardownConfig
• type SenderConfig

Constants

const (
	// DefaultReceiverPort point to a default port of receiver component, and is
	// unique so that components can be easily run on localhost for easy debugging
	DefaultReceiverPort = 22111
	// DefaultForwarderPort point to a default port of forwarder component
	DefaultForwarderPort = 22110
)

Variables

var Instance = defaultValues()

Instance holds configuration values

var Log = newLogger()

Log is a default logger for wathola

Functions

func Read

func Read(configFile string) error

Read a config file and update configuration object

func ReadIfPresent

func ReadIfPresent()

ReadIfPresent read a configuration file if it exists

func SetupTracing

func SetupTracing()

func ShutdownTracing

func ShutdownTracing()

Types

type Config

type Config struct {
	Sender        SenderConfig
	Forwarder     ForwarderConfig
	Receiver      ReceiverConfig
	Readiness     ReadinessConfig
	LogLevel      string
	TracingConfig string
}

Config hold complete configuration

type ForwarderConfig

type ForwarderConfig struct {
	Target string
	Port   int
}

ForwarderConfig holds configuration for forwarder

type ReadinessConfig

type ReadinessConfig struct {
	Enabled bool
	URI     string
	Message string
	Status  int
}

ReadinessConfig holds a readiness configuration

type ReceiverConfig

type ReceiverConfig struct {
	Teardown ReceiverTeardownConfig
	Progress ReceiverProgressConfig
	Errors   ReceiverErrorConfig
	Port     int
}

ReceiverConfig hold configuration for receiver

type ReceiverErrorConfig

type ReceiverErrorConfig struct {
	UnavailablePeriodToReport time.Duration
}

ReceiverErrorConfig holds error reporting config of the receiver

type ReceiverProgressConfig

type ReceiverProgressConfig struct {
	Duration time.Duration
}

ReceiverProgressConfig holds config receiver progress reporting

type ReceiverTeardownConfig

type ReceiverTeardownConfig struct {
	Duration time.Duration
	Interval time.Duration
}

ReceiverTeardownConfig holds config receiver teardown

type SenderConfig

type SenderConfig struct {
	Address  interface{}
	Interval time.Duration
}

SenderConfig hold configuration for sender