Add kafka common fields at the module level

CHANGELOG.asciidoc

@@ -61,6 +61,7 @@ https://github.com/elastic/beats/compare/v6.4.0...master[Check the HEAD diff]
 *Metricbeat*
 
 - Add metrics about cache size to memcached module {pull}7740[7740]
+- Move common kafka fields (broker, topic and partition.id) to the module level to facilitate events correlation. Old fields will be removed in future versions {pull}7767[7767]
 
 *Packetbeat*
 

NOTICE.txt

@@ -115,6 +115,35 @@ COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+--------------------------------------------------------------------
+Dependency: github.com/bsm/sarama-cluster
+Revision: 7e67d87a6b3f83fe08c096fd084691bd9dca112f
+License type (autodetected): MIT
+./vendor/github.com/bsm/sarama-cluster/LICENSE:
+--------------------------------------------------------------------
+(The MIT License)
+
+Copyright (c) 2017 Black Square Media Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 --------------------------------------------------------------------
 Dependency: github.com/coreos/bbolt
 Revision: af9db2027c98c61ecd8e17caa5bd265792b9b9a2

dev-tools/generate_notice.py

@@ -233,6 +233,14 @@ def create_notice(filename, beat, copyright, vendor_dirs, csvfile, overrides=Non
     re.sub(r"\s+", " ", """Permission to use, copy, modify, and distribute this software for any
 purpose with or without fee is hereby granted, provided that the above
 copyright notice and this permission notice appear in all copies."""),
+    re.sub(r"\s+", " ", """Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+    """),
 ]
 
 BSD_LICENSE_CONTENTS = [

metricbeat/docs/fields.asciidoc

@@ -6964,6 +6964,63 @@ Kafka module
 
 
 
+[float]
+== broker fields
+
+Broker Consumer Group Information have been read from (Broker handling the consumer group).
+
+
+
+*`kafka.broker.id`*::
++
+--
+type: long
+
+Broker id
+
+
+--
+
+*`kafka.broker.address`*::
++
+--
+type: keyword
+
+Broker advertised address
+
+
+--
+
+*`kafka.topic.name`*::
++
+--
+type: keyword
+
+Topic name
+
+
+--
+
+*`kafka.topic.error.code`*::
++
+--
+type: long
+
+Topic error code.
+
+
+--
+
+*`kafka.partition.id`*::
++
+--
+type: long
+
+Partition id.
+
+
+--
+
 [float]
 == consumergroup fields
 
@@ -7010,6 +7067,9 @@ Consumer Group ID
 *`kafka.consumergroup.topic`*::
 +
 --
+
+deprecated[6.5]
+
 type: keyword
 
 Topic name
@@ -7019,6 +7079,9 @@ Topic name
 *`kafka.consumergroup.partition`*::
 +
 --
+
+deprecated[6.5]
+
 type: long
 
 Partition ID
@@ -7131,6 +7194,9 @@ Partition data.
 *`kafka.partition.partition.id`*::
 +
 --
+
+deprecated[6.5]
+
 type: long
 
 Partition id.
@@ -7176,6 +7242,16 @@ type: boolean
 Indicates if replica is included in the in-sync replicate set (ISR).
 
 
+--
+
+*`kafka.partition.partition.is_leader`*::
++
+--
+type: boolean
+
+Indicates if replica is the leader
+
+
 --
 
 *`kafka.partition.partition.error.code`*::
@@ -7191,6 +7267,9 @@ Error code from fetching partition.
 *`kafka.partition.topic.error.code`*::
 +
 --
+
+deprecated[6.5]
+
 type: long
 
 topic error code.
@@ -7201,6 +7280,9 @@ topic error code.
 *`kafka.partition.topic.name`*::
 +
 --
+
+deprecated[6.5]
+
 type: keyword
 
 Topic name
@@ -7211,6 +7293,9 @@ Topic name
 *`kafka.partition.broker.id`*::
 +
 --
+
+deprecated[6.5]
+
 type: long
 
 Broker id
@@ -7221,6 +7306,9 @@ Broker id
 *`kafka.partition.broker.address`*::
 +
 --
+
+deprecated[6.5]
+
 type: keyword
 
 Broker address

metricbeat/module/kafka/_meta/fields.yml

@@ -9,3 +9,33 @@
       type: group
       description: >
       fields:
+        - name: broker
+          type: group
+          description: >
+            Broker Consumer Group Information have been read from (Broker handling
+            the consumer group).
+          fields:
+            - name: id
+              type: long
+              description: >
+                Broker id
+
+            - name: address
+              type: keyword
+              description: >
+                Broker advertised address
+
+        - name: topic.name
+          type: keyword
+          description: >
+            Topic name
+
+        - name: topic.error.code
+          type: long
+          description: >
+            Topic error code.
+
+        - name: partition.id
+          type: long
+          description: >
+            Partition id.

metricbeat/module/kafka/consumergroup/_meta/data.json

@@ -1,36 +1,44 @@
 {
-    "@timestamp":"2016-05-23T08:05:34.853Z",
-    "type":"metricsets",
-    "beat":{
-        "hostname":"localhost",
-        "name":"localhost",
-        "version": "6.0.0-alpha1"
+    "@timestamp": "2017-10-12T08:05:34.853Z",
+    "beat": {
+        "hostname": "host.example.com",
+        "name": "host.example.com"
     },
-    "metricset":{
-        "host":"localhost",
-        "module":"kafka",
-        "name":"consumergroup",
-        "rtt":269
-    },
-    "kafka":{
-        "consumergroup":{
-            "id": "group",
-            "topic": "test",
-            "partition": 0,
-            "client": {
-              "host": "127.0.0.1",
-              "id": "client0",
-              "member_id": "client0-d20b677a-5740-433e-a7f8-fbdab1f0f150"
-            },
+    "kafka": {
+        "broker": {
+            "address": "172.18.0.2:9092",
+            "id": 0
+        },
+        "consumergroup": {
             "broker": {
-                "address": "kafka0:9092",
+                "address": "172.18.0.2:9092",
                 "id": 0
             },
+            "client": {
+                "host": "172.18.0.1",
+                "id": "sarama",
+                "member_id": "sarama-714cfb8b-39e5-4128-9109-e5056c5e8f56"
+            },
             "error": {
-              "code": 0
+                "code": 0
             },
+            "id": "test-group",
             "meta": "",
-            "offset": 0
+            "offset": -1,
+            "partition": 0,
+            "topic": "metricbeat-test"
+        },
+        "partition": {
+            "id": 0
+        },
+        "topic": {
+            "name": "metricbeat-test"
         }
+    },
+    "metricset": {
+        "host": "kafka:9092",
+        "module": "kafka",
+        "name": "consumergroup",
+        "rtt": 115
     }
-}
+}

metricbeat/module/kafka/consumergroup/_meta/fields.yml

@@ -6,6 +6,7 @@
   fields:
     - name: broker
       type: group
+      deprecated: 6.5
       description: >
         Broker Consumer Group Information have been read from (Broker handling
         the consumer group).
@@ -26,10 +27,12 @@
 
     - name: topic
       type: keyword
+      deprecated: 6.5
       description: Topic name
 
     - name: partition
       type: long
+      deprecated: 6.5
       description: Partition ID
 
     - name: offset

metricbeat/module/kafka/consumergroup/consumergroup.go

@@ -20,6 +20,8 @@ package consumergroup
 import (
 	"crypto/tls"
 
+	"github.com/pkg/errors"
+
 	"github.com/elastic/beats/libbeat/common"
 	"github.com/elastic/beats/libbeat/common/cfgwarn"
 	"github.com/elastic/beats/libbeat/common/transport/tlscommon"
@@ -95,25 +97,37 @@ func New(base mb.BaseMetricSet) (mb.MetricSet, error) {
 	}, nil
 }
 
-func (m *MetricSet) Fetch() ([]common.MapStr, error) {
+// Fetch consumer group metrics from kafka
+func (m *MetricSet) Fetch(r mb.ReporterV2) {
 	if err := m.broker.Connect(); err != nil {
-		logp.Err("broker connect failed: %v", err)
-		return nil, err
+		r.Error(errors.Wrap(err, "broker connection failed"))
+		return
 	}
-
-	b := m.broker
-	defer b.Close()
+	defer m.broker.Close()
 
 	brokerInfo := common.MapStr{
-		"id":      b.ID(),
-		"address": b.AdvertisedAddr(),
+		"id":      m.broker.ID(),
+		"address": m.broker.AdvertisedAddr(),
 	}
 
-	var events []common.MapStr
 	emitEvent := func(event common.MapStr) {
+		// TODO (deprecation): Remove fields from MetricSetFields moved to ModuleFields
 		event["broker"] = brokerInfo
-		events = append(events, event)
+		r.Event(mb.Event{
+			ModuleFields: common.MapStr{
+				"broker": brokerInfo,
+				"topic": common.MapStr{
+					"name": event["topic"],
+				},
+				"partition": common.MapStr{
+					"id": event["partition"],
+				},
+			},
+			MetricSetFields: event,
+		})
+	}
+	err := fetchGroupInfo(emitEvent, m.broker, m.groups.pred(), m.topics.pred())
+	if err != nil {
+		r.Error(err)
 	}
-	err := fetchGroupInfo(emitEvent, b, m.groups.pred(), m.topics.pred())
-	return events, err
 }