Skip to content

Commit

Permalink
Unset existing config blocks when they are missing (#9023) (#9041)
Browse files Browse the repository at this point in the history
* Unset existing config blocks when they are missing

When a configuration block type (ie output) is not set in Central
Management, Kibana doesn't return it in the payload.

Before this change, Beats was not taking that into account os missing
block types were not reloaded in case they changed. In particular that
means that if an output configuration exists and is removed, Beats won't
apply that change.

This PR fixes that behavior by detecting missing types and applying nil
config to them.

Fixes #9010

(cherry picked from commit f805d6c)
  • Loading branch information
exekias authored Nov 12, 2018
1 parent 4f2f917 commit 2274afe
Show file tree
Hide file tree
Showing 5 changed files with 112 additions and 7 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ https://github.com/elastic/beats/compare/v6.4.0...6.x[Check the HEAD diff]
- The export config subcommand should not display real value for field reference. {pull}8769[8769]
- Fix bug in loading dashboards from zip file. {issue}8051[8051]
- The setup command will not fail if no dashboard is available to import. {pull}8977[8977]
- Fix central management configurations reload when a configuration is removed in Kibana. {issue}9010[9010]

*Auditbeat*

Expand Down
17 changes: 17 additions & 0 deletions libbeat/common/reload/reload.go
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,23 @@ func (r *Registry) MustRegisterList(name string, list ReloadableList) {
}
}

// GetRegisteredNames returns the list of names registered
func (r *Registry) GetRegisteredNames() []string {
r.RLock()
defer r.RUnlock()
var names []string

for name := range r.confs {
names = append(names, name)
}

for name := range r.confsLists {
names = append(names, name)
}

return names
}

// GetReloadable returns the reloadable object with the given name, nil if not found
func (r *Registry) GetReloadable(name string) Reloadable {
r.RLock()
Expand Down
6 changes: 4 additions & 2 deletions libbeat/publisher/pipeline/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,10 @@ func makeWorkQueue() workQueue {
func (c *outputController) Reload(cfg *reload.ConfigWithMeta) error {
outputCfg := common.ConfigNamespace{}

if err := cfg.Config.Unpack(&outputCfg); err != nil {
return err
if cfg != nil {
if err := cfg.Config.Unpack(&outputCfg); err != nil {
return err
}
}

output, err := loadOutput(c.beat, c.monitors, outputCfg)
Expand Down
30 changes: 25 additions & 5 deletions x-pack/libbeat/management/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -181,9 +181,24 @@ func (cm *ConfigManager) fetch() bool {

func (cm *ConfigManager) apply() {
configOK := true

missing := map[string]bool{}
for _, name := range cm.registry.GetRegisteredNames() {
missing[name] = true
}

// Reload configs
for _, b := range cm.cache.Configs {
err := cm.reload(b.Type, b.Blocks)
configOK = configOK && err == nil
missing[b.Type] = false
}

// Unset missing configs
for name := range missing {
if missing[name] {
cm.reload(name, []*api.ConfigBlock{})
}
}

if !configOK {
Expand All @@ -199,15 +214,20 @@ func (cm *ConfigManager) reload(t string, blocks []*api.ConfigBlock) error {

if obj := cm.registry.GetReloadable(t); obj != nil {
// Single object
if len(blocks) != 1 {
if len(blocks) > 1 {
err := fmt.Errorf("got an invalid number of configs for %s: %d, expected: 1", t, len(blocks))
cm.logger.Error(err)
return err
}
config, err := blocks[0].ConfigWithMeta()
if err != nil {
cm.logger.Error(err)
return err

var config *reload.ConfigWithMeta
var err error
if len(blocks) == 1 {
config, err = blocks[0].ConfigWithMeta()
if err != nil {
cm.logger.Error(err)
return err
}
}

if err := obj.Reload(config); err != nil {
Expand Down
65 changes: 65 additions & 0 deletions x-pack/libbeat/management/manager_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,68 @@ func TestConfigManager(t *testing.T) {
}),
}, config2)
}

func TestRemoveItems(t *testing.T) {
registry := reload.NewRegistry()
id, err := uuid.NewV4()
if err != nil {
t.Fatalf("error while generating id: %v", err)
}
accessToken := "footoken"
reloadable := reloadable{
reloaded: make(chan *reload.ConfigWithMeta, 1),
}
registry.MustRegister("test.blocks", &reloadable)

mux := http.NewServeMux()
i := 0
responses := []string{
// Initial load
`{"configuration_blocks":[{"type":"test.blocks","config":{"module":"apache2"}}]}`,

// Return no blocks
`{"configuration_blocks":[]}`,
}
mux.Handle("/", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, responses[i])
i++
}))

server := httptest.NewServer(mux)

c, err := api.ConfigFromURL(server.URL)
if err != nil {
t.Fatal(err)
}

config := &Config{
Enabled: true,
Period: 100 * time.Millisecond,
Kibana: c,
AccessToken: accessToken,
}

manager, err := NewConfigManagerWithConfig(config, registry, id)
if err != nil {
t.Fatal(err)
}

manager.Start()

// On first reload we will get apache2 module
config1 := <-reloadable.reloaded
assert.Equal(t, &reload.ConfigWithMeta{
Config: common.MustNewConfigFrom(map[string]interface{}{
"module": "apache2",
}),
}, config1)

// Get a nil config, even if the block is not part of the payload
config2 := <-reloadable.reloaded
var nilConfig *reload.ConfigWithMeta
assert.Equal(t, nilConfig, config2)

// Cleanup
manager.Stop()
os.Remove(paths.Resolve(paths.Data, "management.yml"))
}

0 comments on commit 2274afe

Please sign in to comment.