-
Notifications
You must be signed in to change notification settings - Fork 145
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Load inputs from external configuration files in Elastic Agent in sta…
…ndalone mode (#30087)
## What does this PR do?
This PR adds support for loading external configuration files to load inputs when running Agent in standalone mode.
Users have to put their configuration files into `{path.config}/inputs.d` with the extension `yml`.
When it is configured, Agent takes the `inputs` configuration from the last standalone configuration and appends the inputs from the external configuration files to it. When the standalone configurations are reloaded, external input configurations are reloaded as well.
The external configuration file must include `inputs`, otherwise the file is invalid. Example for correct file:
```yaml
inputs:
- data_stream:
dataset: system.auth
type: logs
id: logfile-system.auth-my-id
paths:
- /var/log/auth.log*
use_output: default
```
## Why is it important?
Users can configure external configuration files, similar to Filebeat. So managing configuration can be done by Git or Chef instead of Fleet.- Loading branch information
Showing
15 changed files
with
409 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| // Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| // or more contributor license agreements. Licensed under the Elastic License; | ||
| // you may not use this file except in compliance with the Elastic License. | ||
|
|
||
| package config | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "path/filepath" | ||
|
|
||
| "github.com/elastic/beats/v7/x-pack/elastic-agent/pkg/core/logger" | ||
| "github.com/elastic/go-ucfg" | ||
| "github.com/elastic/go-ucfg/cfgutil" | ||
| ) | ||
|
|
||
| // Loader is used to load configuration from the paths | ||
| // including appending multiple input configurations. | ||
| type Loader struct { | ||
| logger *logger.Logger | ||
| inputsFolder string | ||
| } | ||
|
|
||
| // NewLoader creates a new Loader instance to load configuration | ||
| // files from different paths. | ||
| func NewLoader(logger *logger.Logger, inputsFolder string) *Loader { | ||
| return &Loader{logger: logger, inputsFolder: inputsFolder} | ||
| } | ||
|
|
||
| // Load iterates over the list of files and loads the confguration from them. | ||
| // If a configuration file is under the folder set in `agent.config.inputs.path` | ||
| // it is appended to a list. If it is a regular config file, it is merged into | ||
| // the result config. The list of input configurations is merged into the result | ||
| // last. | ||
| func (l *Loader) Load(files []string) (*Config, error) { | ||
| inputsList := make([]*ucfg.Config, 0) | ||
| merger := cfgutil.NewCollector(nil) | ||
| for _, f := range files { | ||
| cfg, err := LoadFile(f) | ||
| if err != nil { | ||
| if l.isFileUnderInputsFolder(f) { | ||
| return nil, fmt.Errorf("failed to load external configuration file '%s': %w. Are you sure it contains an inputs section?", f, err) | ||
| } | ||
| return nil, fmt.Errorf("failed to load configuration file '%s': %w", f, err) | ||
| } | ||
| l.logger.Debugf("Loaded configuration from %s", f) | ||
| if l.isFileUnderInputsFolder(f) { | ||
| inp, err := getInput(cfg) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("cannot get configuration from '%s': %w", f, err) | ||
| } | ||
| inputsList = append(inputsList, inp...) | ||
| l.logger.Debugf("Loaded %s input(s) from configuration from %s", len(inp), f) | ||
| } else { | ||
| if err := merger.Add(cfg.access(), err); err != nil { | ||
| return nil, fmt.Errorf("failed to merge configuration file '%s' to existing one: %w", f, err) | ||
| } | ||
| l.logger.Debugf("Merged configuration from %s into result", f) | ||
| } | ||
| } | ||
| config := merger.Config() | ||
|
|
||
| // if there is no input configuration, return what we have collected. | ||
| if len(inputsList) == 0 { | ||
| l.logger.Debugf("Merged all configuration files from %v, no external input files", files) | ||
| return newConfigFrom(config), nil | ||
| } | ||
|
|
||
| // merge inputs sections from the last standalone configuration | ||
| // file and all files from the inputs folder | ||
| start := 0 | ||
| if config.HasField("inputs") { | ||
| var err error | ||
| start, err = config.CountField("inputs") | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to count the number of inputs in the configuration: %w", err) | ||
| } | ||
| } | ||
| for i, ll := range inputsList { | ||
| if err := config.SetChild("inputs", start+i, ll); err != nil { | ||
| return nil, fmt.Errorf("failed to add inputs to result configuration: %w", err) | ||
| } | ||
| } | ||
|
|
||
| l.logger.Debugf("Merged all configuration files from %v, with external input files", files) | ||
| return newConfigFrom(config), nil | ||
| } | ||
|
|
||
| func getInput(c *Config) ([]*ucfg.Config, error) { | ||
| tmpConfig := struct { | ||
| Inputs []*ucfg.Config `config:"inputs"` | ||
| }{make([]*ucfg.Config, 0)} | ||
|
|
||
| if err := c.Unpack(&tmpConfig); err != nil { | ||
| return nil, fmt.Errorf("failed to parse inputs section from configuration: %w", err) | ||
| } | ||
| return tmpConfig.Inputs, nil | ||
| } | ||
|
|
||
| func (l *Loader) isFileUnderInputsFolder(f string) bool { | ||
| if matches, err := filepath.Match(l.inputsFolder, f); !matches || err != nil { | ||
| return false | ||
| } | ||
| return true | ||
| } |
Oops, something went wrong.