config

Documentation

Index

• Constants
• type PipeConfig
• type SatelliteConfig
  • func Load(configPath string) *SatelliteConfig
  • func NewDefaultSatelliteConfig() *SatelliteConfig
• type SharingConfig

Constants

const RegularExpression = "${_|[A-Z]+:.*}"

${ENV:defaultVal} pattern is supported to override the default value by the env config. And the value would be converted to the different types, such as int, float64 ana string. If you want to keep it as the string value, please decorate it with `"`.

Types

type PipeConfig

type PipeConfig struct {
	PipeCommonConfig *config.CommonFields       `mapstructure:"common_config"`
	Gatherer         *gatherer.GathererConfig   `mapstructure:"gatherer"`
	Processor        *processor.ProcessorConfig `mapstructure:"processor"`
	Sender           *sender.SenderConfig       `mapstructure:"sender"`
}

PipeConfig initializes the different module in different namespace.

type SatelliteConfig

type SatelliteConfig struct {
	Logger    *log.LoggerConfig `mapstructure:"logger"`
	Pipes     []*PipeConfig     `mapstructure:"pipes"`
	Sharing   *SharingConfig    `mapstructure:"sharing"`
	Telemetry *telemetry.Config `mapstructure:"telemetry"`
}

SatelliteConfig is to initialize Satellite.

func Load

func Load(configPath string) *SatelliteConfig

Load SatelliteConfig. The func could not use global logger of Satellite, because it is executed before logger initialization.

func NewDefaultSatelliteConfig

func NewDefaultSatelliteConfig() *SatelliteConfig

NewDefaultSatelliteConfig creates a satellite config with default value.

type SharingConfig

type SharingConfig struct {
	Clients             []plugin.Config      `mapstructure:"clients"`
	Servers             []plugin.Config      `mapstructure:"servers"`
	SharingCommonConfig *config.CommonFields `mapstructure:"common_config"`
}

SharingConfig contains some plugins,which could be shared by every namespace. That is useful to reduce resources cost.