Document Beater Interface

Add godocs describing how the Beater interface is used. Read YAML configuration file one time (instead of twice) Remove os.Exit calls from Packetbeat Print Config OK to stdout on succesful -configtest. Changed HandleFlags() to return an error Fixes #1234
elastic · Mar 29, 2016 · 35605b7 · 35605b7
1 parent bdd7ed3
commit 35605b7
Show file tree

Hide file tree

Showing 13 changed files with 306 additions and 313 deletions.
diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
@@ -18,6 +18,7 @@ https://github.com/elastic/beats/compare/v1.1.2...master[Check the HEAD diff]
 - Run function to start a beat no returns an error instead of directly exiting. {pull}771[771]
 - Move event preprocessor applying GeoIP to packetbeat {pull}772[772]
 - Add include_fields and drop_fields as part of generic filtering {pull}1120[1120]
+- The method signature of HandleFlags() was changed to allow returning an error {pull}1249[1249]
 
 *Packetbeat*
 - Rename output fields in the dns package. Former flag `recursion_allowed` becomes `recursion_available`. {pull}803[803]
@@ -83,6 +84,7 @@ https://github.com/elastic/beats/compare/v1.1.2...master[Check the HEAD diff]
 - Ensure proper shutdown of libbeat. {pull}1075[1075]
 - Add `fields` and `fields_under_root` options under the `shipper` configuration {pull}1092[1092]
 - Add the ability to use a SOCKS5 proxy with the Logstash output {issue}823[823]
+- The `-configtest` flag will now print "Config OK" to stdout on success {pull}1249[1249]
 
 *Packetbeat*
 - Change the DNS library used throughout the dns package to github.com/miekg/dns. {pull}803[803]

diff --git a/filebeat/beater/filebeat.go b/filebeat/beater/filebeat.go
@@ -4,7 +4,6 @@ import (
 	"fmt"
 
 	"github.com/elastic/beats/libbeat/beat"
-	"github.com/elastic/beats/libbeat/cfgfile"
 	"github.com/elastic/beats/libbeat/logp"
 
 	cfg "github.com/elastic/beats/filebeat/config"
@@ -32,7 +31,7 @@ func New() *Filebeat {
 func (fb *Filebeat) Config(b *beat.Beat) error {
 
 	// Load Base config
-	err := cfgfile.Read(&fb.FbConfig, "")
+	err := b.RawConfig.Unpack(&fb.FbConfig)
 
 	if err != nil {
 		return fmt.Errorf("Error reading config file: %v", err)

diff --git a/filebeat/tests/system/test_prospector.py b/filebeat/tests/system/test_prospector.py
@@ -250,7 +250,7 @@ def test_shutdown_no_prospectors(self):
 
         self.wait_until(
             lambda: self.log_contains(
-                "shutting down"),
+                "Exiting"),
             max_timeout=10)
 
         filebeat.check_kill_and_wait(exit_code=1)
@@ -273,7 +273,7 @@ def test_no_paths_defined(self):
 
         self.wait_until(
             lambda: self.log_contains(
-                "shutting down"),
+                "Exiting"),
             max_timeout=10)
 
         filebeat.check_kill_and_wait(exit_code=1)