config

Documentation

Index

• Variables
• type ClassOptionsConfig
• type Config
  • func NewConfig(cfgFile string) (*Config, error)
  • func (c *Config) TelemetryClassEnabled(class types.TelemetryClass) bool
  • func (c *Config) TelemetryTypeEnabled(telemetry types.TelemetryType) bool
• type DBConfig
• type LogConfig
  • func (lc *LogConfig) String() string

Variables

var DefaultCfg = Config{

	TelemetryBaseURL: "http://localhost:9999/telemetry",
	Enabled:          false,
	CustomerID:       "0",
	Tags:             []string{},
	DataStores:       DefaultDBCfg,
	Logging:          DefaultLogging,
	ClassOptions:     DefaultClassOptions,
}

var DefaultClassOptions = ClassOptionsConfig{
	OptOut: true,
	OptIn:  false,
	Allow:  []types.TelemetryType{},
	Deny:   []types.TelemetryType{},
}

var DefaultDBCfg = DBConfig{
	Driver: "sqlite3",
	Params: "/tmp/telemetry/client/telemetry.db",
}

Defaults

var DefaultLogging = LogConfig{
	Level:    "info",
	Location: "stderr",
	Style:    "text",
}

Types

type ClassOptionsConfig

type ClassOptionsConfig struct {
	OptOut bool                  `yaml:"opt_out" json:"opt_out"`
	OptIn  bool                  `yaml:"opt_in" json:"opt_in"`
	Allow  []types.TelemetryType `yaml:"allow" json:"allow"`
	Deny   []types.TelemetryType `yaml:"deny" json:"deny"`
}

type Config

type Config struct {
	TelemetryBaseURL string             `yaml:"telemetry_base_url"`
	Enabled          bool               `yaml:"enabled"`
	CustomerID       string             `yaml:"customer_id"`
	Tags             []string           `yaml:"tags"`
	DataStores       DBConfig           `yaml:"datastores"`
	ClassOptions     ClassOptionsConfig `yaml:"classOptions"`
	Logging          LogConfig          `yaml:"logging"`
	Extras           any                `yaml:"extras,omitempty"`
}

func NewConfig

func NewConfig(cfgFile string) (*Config, error)

func (*Config) TelemetryClassEnabled

func (c *Config) TelemetryClassEnabled(class types.TelemetryClass) bool

func (*Config) TelemetryTypeEnabled

func (c *Config) TelemetryTypeEnabled(telemetry types.TelemetryType) bool

type DBConfig

type DBConfig struct {
	Driver string `yaml:"driver"`
	Params string `yaml:"params"`
}

Datastore config for staging the data

type LogConfig

type LogConfig struct {
	Level    string `yaml:"level" json:"level"`
	Location string `yaml:"location" json:"location"`
	Style    string `yaml:"style" json:"style"`
}

func (*LogConfig) String

func (lc *LogConfig) String() string