[Ingest Management] Agent supports capabilities definition #23848
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
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,97 @@ | ||
| // 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 capabilities | ||
|
|
||
| import ( | ||
| "errors" | ||
| "os" | ||
|
|
||
| "gopkg.in/yaml.v2" | ||
|
|
||
| "github.com/elastic/beats/v7/x-pack/elastic-agent/pkg/core/logger" | ||
| "github.com/elastic/beats/v7/x-pack/elastic-agent/pkg/core/status" | ||
| ) | ||
|
|
||
| // Capability provides a way of applying predefined filter to object. | ||
| // It's up to capability to determine if capability is applicable on object. | ||
| type Capability interface { | ||
| // Apply applies capabilities on input and returns true if input should be completely blocked | ||
| // otherwise, false and updated input is returned | ||
| Apply(interface{}) (interface{}, error) | ||
|
There was a problem hiding this comment. I still would say the interface is doing to much, while not really abstracting things. The input and output types are The E.g. Alternatively (in case we want transformations), we might want to pass the root configuration object to |
||
| } | ||
|
|
||
| var ( | ||
| // ErrBlocked is returned when capability is blocking. | ||
| ErrBlocked = errors.New("capability blocked") | ||
| ) | ||
|
|
||
| type capabilitiesManager struct { | ||
| caps []Capability | ||
| reporter status.Reporter | ||
| } | ||
|
|
||
| type capabilityFactory func(*logger.Logger, *ruleDefinitions, status.Reporter) (Capability, error) | ||
|
|
||
| // Load loads capabilities files and prepares manager. | ||
| func Load(capsFile string, log *logger.Logger, sc status.Controller) (Capability, error) { | ||
| handlers := []capabilityFactory{ | ||
| newInputsCapability, | ||
| newOutputsCapability, | ||
| newUpgradesCapability, | ||
| } | ||
|
|
||
| cm := &capabilitiesManager{ | ||
| caps: make([]Capability, 0), | ||
| reporter: sc.RegisterWithPersistance("capabilities", true), | ||
| } | ||
|
|
||
| // load capabilities from file | ||
| fd, err := os.Open(capsFile) | ||
| if err != nil && !os.IsNotExist(err) { | ||
| return cm, err | ||
| } | ||
|
|
||
| if os.IsNotExist(err) { | ||
| log.Infof("capabilities file not found in %s", capsFile) | ||
| return cm, nil | ||
| } | ||
| defer fd.Close() | ||
|
|
||
| definitions := &ruleDefinitions{Capabilities: make([]ruler, 0)} | ||
| dec := yaml.NewDecoder(fd) | ||
| if err := dec.Decode(&definitions); err != nil { | ||
| return cm, err | ||
| } | ||
|
|
||
| // make list of handlers out of capabilities definition | ||
| for _, h := range handlers { | ||
| cap, err := h(log, definitions, cm.reporter) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if cap == nil { | ||
| continue | ||
| } | ||
|
|
||
| cm.caps = append(cm.caps, cap) | ||
| } | ||
|
|
||
| return cm, nil | ||
| } | ||
|
|
||
| func (mgr *capabilitiesManager) Apply(in interface{}) (interface{}, error) { | ||
| var err error | ||
| // reset health on start, child caps will update to fail if needed | ||
| mgr.reporter.Update(status.Healthy) | ||
| for _, cap := range mgr.caps { | ||
| in, err = cap.Apply(in) | ||
| if err != nil { | ||
| return in, err | ||
| } | ||
| } | ||
|
|
||
| return in, nil | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: The number of parameters gets a little out of hand. Do we really need this function, or can we just use the struct and have a separate "init" or "start" function/method?
Do we pass a tuple of
ctx, log, agentInfooften? In the future we might even want to pass something for metrics and APM tracing. The 'tuple' could be combined into an appContext struct.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i'm +1 on this here. would be worth a small refactor across all the codebase, we have this pattern i think on multple places. these things were simple at first but got bloated over time
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The emitter function is actually become more of a wrapper for the
emitterControllerwith the addition of dynamic inputs and conditions.We should probably refactor that into a single controller.