Skip to content

Commit

Permalink
[Heartbeat] Fix exit on disabled monitor (elastic#22829)
Browse files Browse the repository at this point in the history
Fixes a bug where when `enabled: false` was set on a monitor heartbeat
would refuse to start.

Fixes elastic#22665

(cherry picked from commit 15f3514)
  • Loading branch information
andrewvc committed Dec 1, 2020
1 parent 8c98036 commit 132b0c0
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 3 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,8 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d

*Heartbeat*

- The `service_name` monitor option is being replaced with `service.name` which is more correct. We will support the old option till 8.0. {pull}20330[20330]
- Fix exit on monitors with `enabled: false` {pull}22829[22829]

*Journalbeat*

Expand Down
9 changes: 7 additions & 2 deletions heartbeat/beater/heartbeat.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ import (
"fmt"
"time"

"github.com/elastic/beats/v7/heartbeat/hbregistry"

"github.com/pkg/errors"

"github.com/elastic/beats/v7/heartbeat/config"
"github.com/elastic/beats/v7/heartbeat/hbregistry"
"github.com/elastic/beats/v7/heartbeat/monitors"
"github.com/elastic/beats/v7/heartbeat/monitors/stdfields"
"github.com/elastic/beats/v7/heartbeat/scheduler"
"github.com/elastic/beats/v7/libbeat/autodiscover"
"github.com/elastic/beats/v7/libbeat/beat"
Expand Down Expand Up @@ -128,8 +128,13 @@ func (bt *Heartbeat) RunStaticMonitors(b *beat.Beat) error {
for _, cfg := range bt.config.Monitors {
created, err := factory.Create(b.Publisher, cfg)
if err != nil {
if err == stdfields.ErrPluginDisabled {
continue // don't stop loading monitors just because they're disabled
}

return errors.Wrap(err, "could not create monitor")
}

created.Start()
}
return nil
Expand Down
2 changes: 1 addition & 1 deletion heartbeat/monitors/stdfields/stdfields.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import (
)

// ErrPluginDisabled is returned when the monitor plugin is marked as disabled.
var ErrPluginDisabled = errors.New("Monitor not loaded, plugin is disabled")
var ErrPluginDisabled = errors.New("monitor not loaded, plugin is disabled")

// StdMonitorFields represents the generic configuration options around a monitor plugin.
type StdMonitorFields struct {
Expand Down
24 changes: 24 additions & 0 deletions heartbeat/tests/system/test_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,30 @@ def test_base(self):
self.wait_until(lambda: self.log_contains("heartbeat is running"))
heartbeat_proc.check_kill_and_wait()

def test_disabled(self):
"""
Basic test against a disabled monitor
"""

config = {
"monitors": [
{
"type": "http",
"enabled": "false",
"urls": ["http://localhost:9200"],
}
]
}

self.render_config_template(
path=os.path.abspath(self.working_dir) + "/log/*",
**config
)

heartbeat_proc = self.start_beat()
self.wait_until(lambda: self.log_contains("heartbeat is running"))
heartbeat_proc.check_kill_and_wait()

def test_fields_under_root(self):
"""
Basic test with fields and tags in monitor
Expand Down

0 comments on commit 132b0c0

Please sign in to comment.