Add enable-setting to all output plugins (#1987)

CHANGELOG.asciidoc

@@ -49,6 +49,7 @@ https://github.com/elastic/beats/compare/v5.0.0-alpha3...master[Check the HEAD d
 *Affecting all Beats*
 
 - Periodically log internal metrics. {pull}1955[1955]
+- Add enable-setting to all output modules. {pull}1987[1987]
 
 *Metricbeat*
 

filebeat/filebeat.full.yml

@@ -299,6 +299,9 @@ filebeat.prospectors:
 
 #-------------------------- Elasticsearch output ------------------------------
 output.elasticsearch:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # Array of hosts to connect to.
   # Scheme and port can be left out and will be set to the default (http and 9200)
   # In case you specify and additional path, the scheme is required: http://localhost:9200/path
@@ -396,6 +399,9 @@ output.elasticsearch:
 
 #----------------------------- Logstash output --------------------------------
 #output.logstash:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # The Logstash hosts
   #hosts: ["localhost:5044"]
 
@@ -446,6 +452,9 @@ output.elasticsearch:
 
 #------------------------------- Kafka output ---------------------------------
 #output.kafka:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # The list of Kafka broker addresses from where to fetch the cluster metadata.
   # The cluster metadata contain the actual Kafka brokers events are published
   # to.
@@ -534,6 +543,9 @@ output.elasticsearch:
 
 #------------------------------- Redis output ---------------------------------
 #output.redis:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # The list of Redis servers to connect to. If load balancing is enabled, the
   # events are distributed to the servers in the list. If one server becomes
   # unreachable, the events are distributed to the reachable servers only.
@@ -630,6 +642,9 @@ output.elasticsearch:
 
 #------------------------------- File output ----------------------------------
 #output.file:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # Path to the directory where to save the generated files. The option is
   # mandatory.
   #path: "/tmp/filebeat"
@@ -651,6 +666,9 @@ output.elasticsearch:
 
 #----------------------------- Console output ---------------------------------
 #output.console:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # Pretty print json event
   #pretty: false
 

libbeat/_meta/config.full.yml

@@ -81,6 +81,9 @@
 
 #-------------------------- Elasticsearch output ------------------------------
 output.elasticsearch:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # Array of hosts to connect to.
   # Scheme and port can be left out and will be set to the default (http and 9200)
   # In case you specify and additional path, the scheme is required: http://localhost:9200/path
@@ -178,6 +181,9 @@ output.elasticsearch:
 
 #----------------------------- Logstash output --------------------------------
 #output.logstash:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # The Logstash hosts
   #hosts: ["localhost:5044"]
 
@@ -228,6 +234,9 @@ output.elasticsearch:
 
 #------------------------------- Kafka output ---------------------------------
 #output.kafka:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # The list of Kafka broker addresses from where to fetch the cluster metadata.
   # The cluster metadata contain the actual Kafka brokers events are published
   # to.
@@ -316,6 +325,9 @@ output.elasticsearch:
 
 #------------------------------- Redis output ---------------------------------
 #output.redis:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # The list of Redis servers to connect to. If load balancing is enabled, the
   # events are distributed to the servers in the list. If one server becomes
   # unreachable, the events are distributed to the reachable servers only.
@@ -412,6 +424,9 @@ output.elasticsearch:
 
 #------------------------------- File output ----------------------------------
 #output.file:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # Path to the directory where to save the generated files. The option is
   # mandatory.
   #path: "/tmp/beatname"
@@ -433,6 +448,9 @@ output.elasticsearch:
 
 #----------------------------- Console output ---------------------------------
 #output.console:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # Pretty print json event
   #pretty: false
 

libbeat/common/config.go

@@ -103,6 +103,18 @@ func (c *Config) SetChild(name string, idx int, value *Config) error {
 	return c.access().SetChild(name, idx, value.access(), configOpts...)
 }
 
+func (c *Config) Enabled() bool {
+	testEnabled := struct {
+		Enabled bool `config:"enable"`
+	}{true}
+
+	if err := c.Unpack(&testEnabled); err != nil {
+		// if unpacking fails, expect 'enable' being set to default value
+		return true
+	}
+	return testEnabled.Enabled
+}
+
 func fromConfig(in *ucfg.Config) *Config {
 	return (*Config)(in)
 }

libbeat/docs/outputconfig.asciidoc

@@ -92,6 +92,14 @@ output.elasticsearch:
 
 You can specify the following options in the `elasticsearch` section of the +{beatname_lc}.yml+ config file:
 
+===== enable
+
+The enable config is a boolean setting to enable or disable the output. If set
+to false, the output is disabled.
+
+The default value is true.
+
+
 [[hosts-option]]
 ===== hosts
 
@@ -357,6 +365,13 @@ output.logstash:
 You can specify the following options in the `logstash` section of the
 +{beatname_lc}.yml+ config file:
 
+===== enable
+
+The enable config is a boolean setting to enable or disable the output. If set
+to false, the output is disabled.
+
+The default value is true.
+
 [[hosts]]
 ===== hosts
 
@@ -491,6 +506,13 @@ The Kafka output sends the events to Apache Kafka.
 
 You can specify the following options in the `kafka` section of the +{beatname_lc}.yml+ config file:
 
+===== enable
+
+The enable config is a boolean setting to enable or disable the output. If set
+to false, the output is disabled.
+
+The default value is true.
+
 ===== hosts
 
 The list of Kafka broker addresses from where to fetch the cluster metadata.
@@ -602,6 +624,13 @@ output.redis:
 
 You can specify the following options in the `redis` section of the +{beatname_lc}.yml+ config file:
 
+===== enable
+
+The enable config is a boolean setting to enable or disable the output. If set
+to false, the output is disabled.
+
+The default value is true.
+
 ===== hosts
 
 The list of Redis servers to connect to. If load balancing is enabled, the events are
@@ -746,6 +775,13 @@ output.file:
 
 You can specify the following options in the `file` section of the +{beatname_lc}.yml+ config file:
 
+===== enable
+
+The enable config is a boolean setting to enable or disable the output. If set
+to false, the output is disabled.
+
+The default value is true.
+
 [[path]]
 ===== path
 
@@ -787,6 +823,13 @@ You can specify the following options in the `console` section of the +{beatname
 
 If `pretty` is set to true, events written to stdout will be nicely formatted. The default is false.
 
+===== enable
+
+The enable config is a boolean setting to enable or disable the output. If set
+to false, the output is disabled.
+
+The default value is true.
+
 ===== bulk_max_size
 
 The maximum number of events to buffer internally during publishing. The default is 2048.

libbeat/outputs/outputs.go

@@ -51,14 +51,14 @@ type bulkOutputAdapter struct {
 	Outputer
 }
 
-var enabledOutputPlugins = make(map[string]OutputBuilder)
+var outputsPlugins = make(map[string]OutputBuilder)
 
 func RegisterOutputPlugin(name string, builder OutputBuilder) {
-	enabledOutputPlugins[name] = builder
+	outputsPlugins[name] = builder
 }
 
 func FindOutputPlugin(name string) OutputBuilder {
-	return enabledOutputPlugins[name]
+	return outputsPlugins[name]
 }
 
 func InitOutputs(
@@ -67,11 +67,14 @@ func InitOutputs(
 	topologyExpire int,
 ) ([]OutputPlugin, error) {
 	var plugins []OutputPlugin = nil
-	for name, plugin := range enabledOutputPlugins {
+	for name, plugin := range outputsPlugins {
 		config, exists := configs[name]
 		if !exists {
 			continue
 		}
+		if !config.Enabled() {
+			continue
+		}
 
 		if !config.HasField("index") {
 			config.SetString("index", -1, beatName)

metricbeat/metricbeat.full.yml

@@ -226,6 +226,9 @@ metricbeat.modules:
 
 #-------------------------- Elasticsearch output ------------------------------
 output.elasticsearch:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # Array of hosts to connect to.
   # Scheme and port can be left out and will be set to the default (http and 9200)
   # In case you specify and additional path, the scheme is required: http://localhost:9200/path
@@ -323,6 +326,9 @@ output.elasticsearch:
 
 #----------------------------- Logstash output --------------------------------
 #output.logstash:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # The Logstash hosts
   #hosts: ["localhost:5044"]
 
@@ -373,6 +379,9 @@ output.elasticsearch:
 
 #------------------------------- Kafka output ---------------------------------
 #output.kafka:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # The list of Kafka broker addresses from where to fetch the cluster metadata.
   # The cluster metadata contain the actual Kafka brokers events are published
   # to.
@@ -461,6 +470,9 @@ output.elasticsearch:
 
 #------------------------------- Redis output ---------------------------------
 #output.redis:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # The list of Redis servers to connect to. If load balancing is enabled, the
   # events are distributed to the servers in the list. If one server becomes
   # unreachable, the events are distributed to the reachable servers only.
@@ -557,6 +569,9 @@ output.elasticsearch:
 
 #------------------------------- File output ----------------------------------
 #output.file:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # Path to the directory where to save the generated files. The option is
   # mandatory.
   #path: "/tmp/metricbeat"
@@ -578,6 +593,9 @@ output.elasticsearch:
 
 #----------------------------- Console output ---------------------------------
 #output.console:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # Pretty print json event
   #pretty: false
 

packetbeat/packetbeat.full.yml

@@ -465,6 +465,9 @@ packetbeat.protocols.nfs:
 
 #-------------------------- Elasticsearch output ------------------------------
 output.elasticsearch:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # Array of hosts to connect to.
   # Scheme and port can be left out and will be set to the default (http and 9200)
   # In case you specify and additional path, the scheme is required: http://localhost:9200/path
@@ -562,6 +565,9 @@ output.elasticsearch:
 
 #----------------------------- Logstash output --------------------------------
 #output.logstash:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # The Logstash hosts
   #hosts: ["localhost:5044"]
 
@@ -612,6 +618,9 @@ output.elasticsearch:
 
 #------------------------------- Kafka output ---------------------------------
 #output.kafka:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # The list of Kafka broker addresses from where to fetch the cluster metadata.
   # The cluster metadata contain the actual Kafka brokers events are published
   # to.
@@ -700,6 +709,9 @@ output.elasticsearch:
 
 #------------------------------- Redis output ---------------------------------
 #output.redis:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # The list of Redis servers to connect to. If load balancing is enabled, the
   # events are distributed to the servers in the list. If one server becomes
   # unreachable, the events are distributed to the reachable servers only.
@@ -796,6 +808,9 @@ output.elasticsearch:
 
 #------------------------------- File output ----------------------------------
 #output.file:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # Path to the directory where to save the generated files. The option is
   # mandatory.
   #path: "/tmp/packetbeat"
@@ -817,6 +832,9 @@ output.elasticsearch:
 
 #----------------------------- Console output ---------------------------------
 #output.console:
+  # Boolean flag to enable or disable the output module.
+  #enable: true
+
   # Pretty print json event
   #pretty: false