Documentation
¶
Index ¶
- type Factory
- type Fileset
- func (fs *Fileset) GetMLConfigs() []mlimporter.MLConfig
- func (fs *Fileset) GetPipeline(esVersion string) (pipelineID string, content map[string]interface{}, err error)
- func (fs *Fileset) GetRequiredProcessors() []ProcessorRequirement
- func (fs *Fileset) Read(beatVersion string) error
- func (fs *Fileset) String() string
- type FilesetConfig
- type ModuleConfig
- type ModuleOverrides
- type ModuleRegistry
- type PipelineLoader
- type PipelineLoaderFactory
- type ProcessorRequirement
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Factory ¶
type Factory struct {
// contains filtered or unexported fields
}
Factory for modules
func NewFactory ¶
func NewFactory(outlet channel.Factory, registrar *registrar.Registrar, beatVersion string,
pipelineLoaderFactory PipelineLoaderFactory, beatDone chan struct{}) *Factory
NewFactory instantiates a new Factory
type Fileset ¶
type Fileset struct {
// contains filtered or unexported fields
}
Fileset struct is the representation of a fileset.
func New ¶
func New(
modulesPath string,
name string,
mcfg *ModuleConfig,
fcfg *FilesetConfig) (*Fileset, error)
New allocates a new Fileset object with the given configuration.
func (*Fileset) GetMLConfigs ¶
func (fs *Fileset) GetMLConfigs() []mlimporter.MLConfig
GetMLConfigs returns the list of machine-learning configurations declared by this fileset.
func (*Fileset) GetPipeline ¶
func (fs *Fileset) GetPipeline(esVersion string) (pipelineID string, content map[string]interface{}, err error)
GetPipeline returns the JSON content of the Ingest Node pipeline that parses the logs.
func (*Fileset) GetRequiredProcessors ¶
func (fs *Fileset) GetRequiredProcessors() []ProcessorRequirement
GetRequiredProcessors returns the list of processors on which this fileset depends.
type FilesetConfig ¶
type FilesetConfig struct {
Enabled *bool `config:"enabled"`
Var map[string]interface{} `config:"var"`
Prospector map[string]interface{} `config:"prospector"`
}
FilesetConfig contains the configuration file options for a fileset
type ModuleConfig ¶
type ModuleConfig struct {
Module string `config:"module" validate:"required"`
Enabled *bool `config:"enabled"`
// Filesets is inlined by code, see mcfgFromConfig
Filesets map[string]*FilesetConfig
}
ModuleConfig contains the configuration file options for a module
type ModuleOverrides ¶
type ModuleOverrides map[string]map[string]*common.Config // module -> fileset -> Config
type ModuleRegistry ¶
type ModuleRegistry struct {
// contains filtered or unexported fields
}
func NewModuleRegistry ¶
func NewModuleRegistry(moduleConfigs []*common.Config, beatVersion string, init bool) (*ModuleRegistry, error)
NewModuleRegistry reads and loads the configured module into the registry.
func (*ModuleRegistry) GetProspectorConfigs ¶
func (reg *ModuleRegistry) GetProspectorConfigs() ([]*common.Config, error)
func (*ModuleRegistry) InfoString ¶
func (reg *ModuleRegistry) InfoString() string
InfoString returns the enabled modules and filesets in a single string, ready to be shown to the user
func (*ModuleRegistry) LoadML ¶
func (reg *ModuleRegistry) LoadML(esClient PipelineLoader) error
LoadML loads the machine-learning configurations into Elasticsearch, if Xpack is available
func (*ModuleRegistry) LoadPipelines ¶
func (reg *ModuleRegistry) LoadPipelines(esClient PipelineLoader) error
LoadPipelines loads the pipelines for each configured fileset.
type PipelineLoader ¶
type PipelineLoader interface {
LoadJSON(path string, json map[string]interface{}) ([]byte, error)
Request(method, path string, pipeline string, params map[string]string, body interface{}) (int, []byte, error)
GetVersion() string
}
PipelineLoader is a subset of the Elasticsearch client API capable of loading the pipelines.
type PipelineLoaderFactory ¶
type PipelineLoaderFactory func() (PipelineLoader, error)
PipelineLoader factory builds and returns a PipelineLoader
type ProcessorRequirement ¶
type ProcessorRequirement struct {
Name string `config:"name"`
Plugin string `config:"plugin"`
}
ProcessorRequirement represents the declaration of a dependency to a particular Ingest Node processor / plugin.
Source Files