config

Documentation

Index

• Variables
• func WriteDefaultConfigFile(filename string) error
• type Config
  • func NewConfig() *Config
  • func (c *Config) GetTracker(trackingID string) *TrackerConfig
  • func (c *Config) LoadFile(path string) error
• type Duration
  • func (d *Duration) UnmarshalTOML(data []byte) (err error)
• type GeoIPConfig
• type GlobalConfig
• type HTTPConfig
• type LogConfig
• type TrackerConfig

Variables

var ConfigFile embed.FS

Functions

func WriteDefaultConfigFile

func WriteDefaultConfigFile(filename string) error

WriteDefaultConfigFile write default configuration file

Types

type Config

type Config struct {
	Log      LogConfig
	HTTP     HTTPConfig
	GeoIP    GeoIPConfig `toml:"geo-ip"`
	Global   GlobalConfig
	Trackers []TrackerConfig
	Outputs  []outputs.Output
}

Config is the root of the configuration

func NewConfig

func NewConfig() *Config

NewConfig create new configuration

func (*Config) GetTracker

func (c *Config) GetTracker(trackingID string) *TrackerConfig

GetTracker retrive tracker configuration

func (*Config) LoadFile

func (c *Config) LoadFile(path string) error

LoadFile loads the given config file and applies it to c

type Duration

type Duration struct {
	time.Duration
}

Duration custom configuration type

func (*Duration) UnmarshalTOML

func (d *Duration) UnmarshalTOML(data []byte) (err error)

UnmarshalTOML unmarshal TOML bytes to Duration

type GeoIPConfig

type GeoIPConfig struct {
	Database string
}

GeoIPConfig for GeoIP configuration section

type GlobalConfig

type GlobalConfig struct {
	Tags map[string]string
}

GlobalConfig for global configuration section

type HTTPConfig

type HTTPConfig struct {
	ListenAddr string
}

HTTPConfig for HTTP configuration section

type LogConfig

type LogConfig struct {
	Level   string
	Format  string
	Modules string
}

LogConfig for log configuration section

type TrackerConfig

type TrackerConfig struct {
	Origin       string
	TrackingID   string `toml:"tracking_id"`
	Badge        string
	RateLimiting map[string]interface{}
	RateLimiter  usage.RateLimiter
}

TrackerConfig for tracker configurtion section