config

Documentation

Overview

Package config parses Tracer configuration files.

Index

• type Config
  • func Load(r io.Reader) (Config, error)
  • func (cfg Config) QueryTransportConfig(engine string) (map[string]interface{}, error)
  • func (cfg Config) QueryTransports() ([]string, error)
  • func (cfg Config) Storage() (string, error)
  • func (cfg Config) StorageConfig() (map[string]interface{}, error)
  • func (cfg Config) StorageTransport() (string, error)
  • func (cfg Config) StorageTransportConfig() (map[string]interface{}, error)
• type MissingKeyError
  • func (err MissingKeyError) Error() string
• type MissingSectionError
  • func (err MissingSectionError) Error() string
• type WrongValueTypeError
  • func (err WrongValueTypeError) Error() string

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config is the Tracer configuration file.

func Load

func Load(r io.Reader) (Config, error)

Load loads a configuration file.

func (Config) QueryTransportConfig

func (cfg Config) QueryTransportConfig(engine string) (map[string]interface{}, error)

QueryTransportConfig returns the configuration of a query transport.

func (Config) QueryTransports

func (cfg Config) QueryTransports() ([]string, error)

QueryTransports returns the names of the query transports.

func (Config) Storage

func (cfg Config) Storage() (string, error)

Storage returns the name of the storage engine.

func (Config) StorageConfig

func (cfg Config) StorageConfig() (map[string]interface{}, error)

StorageConfig returns the configuration of the storage engine.

func (Config) StorageTransport

func (cfg Config) StorageTransport() (string, error)

StorageTransport returns the name of the storage transport.

func (Config) StorageTransportConfig

func (cfg Config) StorageTransportConfig() (map[string]interface{}, error)

StorageTransportConfig returns the configuration of the storage transport.

type MissingKeyError

type MissingKeyError string

MissingKeyError is returned when a configuration key is missing.

func (MissingKeyError) Error

func (err MissingKeyError) Error() string

type MissingSectionError

type MissingSectionError string

MissingSectionError is returned when a configuration section is missing.

func (MissingSectionError) Error

func (err MissingSectionError) Error() string

type WrongValueTypeError

type WrongValueTypeError struct {
	Key  string
	Type string
}

WrongValueTypeError is returned when a configuration key has the wrong type.

func (WrongValueTypeError) Error

func (err WrongValueTypeError) Error() string