Adding beat module with state metricset

CHANGELOG.next.asciidoc

@@ -238,6 +238,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
 - Add a system/entropy metricset {pull}12450[12450]
 - Allow redis URL format in redis hosts config. {pull}12408[12408]
 - Add tags into ec2 metricset. {issue}[12263]12263 {pull}12372[12372]
+- Add `beat` module. {pull}12181[12181] {pull}12615[12615]
 - Collect tags for cloudwatch metricset in aws module. {issue}[12263]12263 {pull}12480[12480]
 
 *Packetbeat*

metricbeat/docs/fields.asciidoc

@@ -1600,6 +1600,53 @@ type: keyword
 Beat type.
 
 
+type: keyword
+
+--
+
+[float]
+=== state
+
+Beat state
+
+
+
+*`beat.state.management.enabled`*::
++
+--
+Is central management enabled?
+
+
+type: boolean
+
+--
+
+*`beat.state.module.count`*::
++
+--
+Number of modules enabled
+
+
+type: integer
+
+--
+
+*`beat.state.output.name`*::
++
+--
+Name of output used by Beat
+
+
+type: keyword
+
+--
+
+*`beat.state.queue.name`*::
++
+--
+Name of queue being used by Beat
+
+
 type: keyword
 
 --

metricbeat/metricbeat.reference.yml

@@ -160,6 +160,7 @@ metricbeat.modules:
 - module: beat
   metricsets:
     - stats
+    - state
   period: 10s
   hosts: ["http://localhost:5066"]
   #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]

metricbeat/module/beat/_meta/config-xpack.yml

@@ -1,6 +1,7 @@
 - module: beat
   metricsets:
     - stats
+    - state
   period: 10s
   hosts: ["http://localhost:5066"]
   #username: "user"

metricbeat/module/beat/_meta/config.reference.yml

@@ -1,6 +1,7 @@
 - module: beat
   metricsets:
     - stats
+    - state
   period: 10s
   hosts: ["http://localhost:5066"]
   #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]

metricbeat/module/beat/_meta/config.yml

@@ -1,6 +1,7 @@
 - module: beat
   metricsets:
     - stats
+    - state
   period: 10s
   hosts: ["http://localhost:5066"]
 

metricbeat/module/beat/beat_integration_test.go

@@ -27,11 +27,13 @@ import (
 	"github.com/elastic/beats/libbeat/tests/compose"
 	mbtest "github.com/elastic/beats/metricbeat/mb/testing"
 	"github.com/elastic/beats/metricbeat/module/beat"
+	_ "github.com/elastic/beats/metricbeat/module/beat/state"
 	_ "github.com/elastic/beats/metricbeat/module/beat/stats"
 )
 
 var metricSets = []string{
 	"stats",
+	"state",
 }
 
 func TestFetch(t *testing.T) {

metricbeat/module/beat/state/_meta/data.json

@@ -0,0 +1,33 @@
+{
+    "@timestamp": "2017-10-12T08:05:34.853Z",
+    "beat": {
+        "state": {
+            "management": {
+                "enabled": false
+            },
+            "module": {
+                "count": 3
+            },
+            "output": {
+                "name": "elasticsearch"
+            },
+            "queue": {
+                "name": "mem"
+            }
+        }
+    },
+    "event": {
+        "dataset": "beat.state",
+        "duration": 115000,
+        "module": "beat"
+    },
+    "metricset": {
+        "name": "state"
+    },
+    "service": {
+        "address": "127.0.0.1:5066",
+        "id": "1f0c187b-f2ef-4950-b9cc-dd6864b9191a",
+        "name": "Shaunaks-MacBook-Pro-2.local",
+        "type": "metricbeat"
+    }
+}

metricbeat/module/beat/state/_meta/fields.yml

@@ -0,0 +1,22 @@
+- name: state
+  type: group
+  description: >
+    Beat state
+  release: ga
+  fields:
+    - name: management.enabled
+      type: boolean
+      description: >
+        Is central management enabled?
+    - name: module.count
+      type: integer
+      description: >
+        Number of modules enabled
+    - name: output.name
+      type: keyword
+      description: >
+        Name of output used by Beat
+    - name: queue.name
+      type: keyword
+      description: >
+        Name of queue being used by Beat

metricbeat/module/beat/state/_meta/test/state.800.json

@@ -0,0 +1,43 @@
+{
+    "beat": {
+        "name": "Shaunaks-MBP-2"
+    },
+    "host": {
+        "architecture": "x86_64",
+        "hostname": "Shaunaks-MBP-2",
+        "id": "EF6274EA-462F-5316-A14A-850E7BFD8126",
+        "os": {
+            "build": "18F132",
+            "family": "darwin",
+            "kernel": "18.6.0",
+            "name": "Mac OS X",
+            "platform": "darwin",
+            "version": "10.14.5"
+        }
+    },
+    "management": {
+        "enabled": false
+    },
+    "module": {
+        "count": 3,
+        "names": [
+            "system"
+        ]
+    },
+    "output": {
+        "name": "elasticsearch"
+    },
+    "outputs": {
+        "elasticsearch": {
+            "cluster_uuid": "c8sjZYNjRcOiCTGzQZoyqw"
+        }
+    },
+    "queue": {
+        "name": "mem"
+    },
+    "service": {
+        "id": "1f0c187b-f2ef-4950-b9cc-dd6864b9191a",
+        "name": "metricbeat",
+        "version": "8.0.0"
+    }
+}

metricbeat/module/beat/state/data.go

@@ -0,0 +1,72 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package state
+
+import (
+	"encoding/json"
+
+	"github.com/pkg/errors"
+
+	"github.com/elastic/beats/libbeat/common"
+	s "github.com/elastic/beats/libbeat/common/schema"
+	c "github.com/elastic/beats/libbeat/common/schema/mapstriface"
+	"github.com/elastic/beats/metricbeat/mb"
+	"github.com/elastic/beats/metricbeat/module/beat"
+)
+
+var (
+	schema = s.Schema{
+		"management": c.Dict("management", s.Schema{
+			"enabled": c.Bool("enabled"),
+		}),
+		"module": c.Dict("module", s.Schema{
+			"count": c.Int("count"),
+		}),
+		"output": c.Dict("output", s.Schema{
+			"name": c.Str("name"),
+		}),
+		"queue": c.Dict("queue", s.Schema{
+			"name": c.Str("name"),
+		}),
+	}
+)
+
+func eventMapping(r mb.ReporterV2, info beat.Info, content []byte) error {
+	var event mb.Event
+	event.RootFields = common.MapStr{}
+	event.RootFields.Put("service", common.MapStr{
+		"id":   info.UUID,
+		"name": info.Name,
+	})
+
+	event.Service = info.Beat
+
+	var data map[string]interface{}
+	err := json.Unmarshal(content, &data)
+	if err != nil {
+		return errors.Wrap(err, "failure parsing Beat's State API response")
+	}
+
+	event.MetricSetFields, err = schema.Apply(data)
+	if err != nil {
+		return errors.Wrap(err, "failure to apply state schema")
+	}
+
+	r.Event(event)
+	return nil
+}

metricbeat/module/beat/state/data_test.go

@@ -0,0 +1,55 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+// +build !integration
+
+package state
+
+import (
+	"io/ioutil"
+	"path/filepath"
+	"testing"
+
+	"github.com/elastic/beats/metricbeat/module/beat"
+
+	mbtest "github.com/elastic/beats/metricbeat/mb/testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestEventMapping(t *testing.T) {
+
+	files, err := filepath.Glob("./_meta/test/state.*.json")
+	assert.NoError(t, err)
+
+	info := beat.Info{
+		UUID: "1234",
+		Beat: "helloworld",
+	}
+
+	for _, f := range files {
+		input, err := ioutil.ReadFile(f)
+		assert.NoError(t, err)
+
+		reporter := &mbtest.CapturingReporterV2{}
+		err = eventMapping(reporter, info, input)
+
+		assert.NoError(t, err, f)
+		assert.True(t, len(reporter.GetEvents()) >= 1, f)
+		assert.Equal(t, 0, len(reporter.GetErrors()), f)
+	}
+}