config

Documentation

Index

• Constants
• Variables
• type Config
  • func (config *Config) FetchConfigs()
• type FilebeatConfig
• type HarvesterConfig
• type JSONConfig
• type MultilineConfig
• type ProspectorConfig

Constants

const (
	DefaultRegistryFile                      = ".filebeat"
	DefaultIgnoreOlderDuration time.Duration = 0
	DefaultCloseOlderDuration  time.Duration = 1 * time.Hour
	DefaultScanFrequency       time.Duration = 10 * time.Second
	DefaultSpoolSize           uint64        = 2048
	DefaultIdleTimeout         time.Duration = 5 * time.Second
	DefaultHarvesterBufferSize int           = 16 << 10 // 16384
	DefaultInputType                         = "log"
	DefaultDocumentType                      = "log"
	DefaultTailFiles                         = false
	DefaultBackoff                           = 1 * time.Second
	DefaultBackoffFactor                     = 2
	DefaultMaxBackoff                        = 10 * time.Second
	DefaultForceCloseFiles                   = false
	DefaultMaxBytes                          = 10 * (1 << 20) // 10MB
)

Defaults for config variables which are not set

const (
	LogInputType   = "log"
	StdinInputType = "stdin"
)

Variables

var ValidInputType = map[string]struct{}{
	StdinInputType: {},
	LogInputType:   {},
}

List of valid input types

Types

type Config

type Config struct {
	Filebeat FilebeatConfig
}

func (*Config) FetchConfigs

func (config *Config) FetchConfigs()

Fetches and merges all config files given by configDir. All are put into one config object

type FilebeatConfig

type FilebeatConfig struct {
	Prospectors  []ProspectorConfig
	SpoolSize    uint64        `config:"spool_size"`
	PublishAsync bool          `config:"publish_async"`
	IdleTimeout  time.Duration `config:"idle_timeout"`
	RegistryFile string        `config:"registry_file"`
	ConfigDir    string        `config:"config_dir"`
}

type HarvesterConfig

type HarvesterConfig struct {
	common.EventMetadata `config:",inline"` // Fields and tags to add to events.

	BufferSize         int    `config:"harvester_buffer_size"`
	DocumentType       string `config:"document_type"`
	Encoding           string `config:"encoding"`
	InputType          string `config:"input_type"`
	TailFiles          bool   `config:"tail_files"`
	Backoff            string `config:"backoff"`
	BackoffDuration    time.Duration
	BackoffFactor      int    `config:"backoff_factor"`
	MaxBackoff         string `config:"max_backoff"`
	MaxBackoffDuration time.Duration
	CloseOlder         string `config:"close_older"`
	CloseOlderDuration time.Duration
	ForceCloseFiles    bool             `config:"force_close_files"`
	ExcludeLines       []string         `config:"exclude_lines"`
	IncludeLines       []string         `config:"include_lines"`
	MaxBytes           int              `config:"max_bytes"`
	Multiline          *MultilineConfig `config:"multiline"`
	JSON               *JSONConfig      `config:"json"`
}

type JSONConfig

type JSONConfig struct {
	MessageKey    string `config:"message_key"`
	KeysUnderRoot bool   `config:"keys_under_root"`
	OverwriteKeys bool   `config:"overwrite_keys"`
	AddErrorKey   bool   `config:"add_error_key"`
}

type MultilineConfig

type MultilineConfig struct {
	Negate   bool   `config:"negate"`
	Match    string `config:"match"`
	MaxLines *int   `config:"max_lines"`
	Pattern  string `config:"pattern"`
	Timeout  string `config:"timeout"`
}

type ProspectorConfig

type ProspectorConfig struct {
	ExcludeFiles          []string `config:"exclude_files"`
	ExcludeFilesRegexp    []*regexp.Regexp
	Harvester             HarvesterConfig `config:",inline"`
	Input                 string
	IgnoreOlder           string `config:"ignore_older"`
	IgnoreOlderDuration   time.Duration
	Paths                 []string
	ScanFrequency         string `config:"scan_frequency"`
	ScanFrequencyDuration time.Duration
}