agent

Documentation

Index

• type Config
  • func NewConfigFromFile(file string) (*Config, error)
  • func NewConfigFromGlobs(globs []string) (*Config, error)
• type LogAgent
  • func (a *LogAgent) Start(persister operator.Persister) (err error)
  • func (a *LogAgent) Stop() (err error)
• type LogAgentBuilder
  • func NewBuilder(logger *zap.SugaredLogger) *LogAgentBuilder
  • func (b *LogAgentBuilder) Build() (*LogAgent, error)
  • func (b *LogAgentBuilder) WithConfig(cfg *Config) *LogAgentBuilder
  • func (b *LogAgentBuilder) WithConfigFiles(files []string) *LogAgentBuilder
  • func (b *LogAgentBuilder) WithDefaultOutput(defaultOutput operator.Operator) *LogAgentBuilder
  • func (b *LogAgentBuilder) WithPluginDir(pluginDir string) *LogAgentBuilder

Types

type Config

type Config struct {
	Pipeline pipeline.Config `json:"pipeline"                yaml:"pipeline"`
}

Config is the configuration of the stanza log agent.

func NewConfigFromFile

func NewConfigFromFile(file string) (*Config, error)

NewConfigFromFile will create a new agent config from a YAML file.

func NewConfigFromGlobs

func NewConfigFromGlobs(globs []string) (*Config, error)

NewConfigFromGlobs will create an agent config from multiple files matching a pattern.

type LogAgent

type LogAgent struct {
	*zap.SugaredLogger
	// contains filtered or unexported fields
}

LogAgent is an entity that handles log monitoring.

func (*LogAgent) Start

func (a *LogAgent) Start(persister operator.Persister) (err error)

Start will start the log monitoring process

func (*LogAgent) Stop

func (a *LogAgent) Stop() (err error)

Stop will stop the log monitoring process

type LogAgentBuilder

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

LogAgentBuilder is a construct used to build a log agent

func NewBuilder

func NewBuilder(logger *zap.SugaredLogger) *LogAgentBuilder

NewBuilder creates a new LogAgentBuilder

func (*LogAgentBuilder) Build

func (b *LogAgentBuilder) Build() (*LogAgent, error)

Build will build a new log agent using the values defined on the builder

func (*LogAgentBuilder) WithConfig

func (b *LogAgentBuilder) WithConfig(cfg *Config) *LogAgentBuilder

WithConfig builds the agent with a given, pre-built config

func (*LogAgentBuilder) WithConfigFiles

func (b *LogAgentBuilder) WithConfigFiles(files []string) *LogAgentBuilder

WithConfigFiles adds a list of globs to the search path for config files

func (*LogAgentBuilder) WithDefaultOutput

func (b *LogAgentBuilder) WithDefaultOutput(defaultOutput operator.Operator) *LogAgentBuilder

WithDefaultOutput adds a default output when building a log agent

func (*LogAgentBuilder) WithPluginDir

func (b *LogAgentBuilder) WithPluginDir(pluginDir string) *LogAgentBuilder

WithPluginDir adds the specified plugin directory when building a log agent