Adding beat module with stats metricset

metricbeat/docker-compose.yml

@@ -14,6 +14,7 @@ services:
     env_file:
       - ./module/aerospike/_meta/env
       - ./module/apache/_meta/env
+      - ./module/beat/_meta/env
       - ./module/ceph/_meta/env
       - ./module/consul/_meta/env
       - ./module/couchbase/_meta/env
@@ -63,6 +64,11 @@ services:
     ports:
       - 80
 
+  metricbeat:
+    build: ./module/beat/_meta
+    ports:
+      - 5066
+
   ceph:
     build: ./module/ceph/_meta
     ports:

metricbeat/docs/fields.asciidoc

@@ -16,6 +16,7 @@ grouped in the following categories:
 * <<exported-fields-apache>>
 * <<exported-fields-aws>>
 * <<exported-fields-beat-common>>
+* <<exported-fields-beat>>
 * <<exported-fields-ceph>>
 * <<exported-fields-cloud>>
 * <<exported-fields-common>>
@@ -1568,6 +1569,231 @@ type: keyword
 
 Time series instance id
 
+--
+
+[[exported-fields-beat]]
+== Beat fields
+
+Beat module
+
+
+
+[float]
+== beat fields
+
+
+
+
+*`beat.id`*::
++
+--
+type: keyword
+
+Beat ID.
+
+
+--
+
+*`beat.type`*::
++
+--
+type: keyword
+
+Beat type.
+
+
+--
+
+[float]
+== stats fields
+
+Beat stats
+
+
+
+*`beat.stats.uptime.ms`*::
++
+--
+type: long
+
+Beat uptime
+
+
+--
+
+*`beat.stats.runtime.goroutines`*::
++
+--
+type: long
+
+Number of goroutines running in Beat
+
+
+--
+
+[float]
+== libbeat fields
+
+Fields common to all Beats
+
+
+
+[float]
+== output fields
+
+Output stats
+
+
+
+*`beat.stats.libbeat.output.type`*::
++
+--
+type: keyword
+
+Type of output
+
+
+--
+
+[float]
+== events fields
+
+Event counters
+
+
+
+*`beat.stats.libbeat.output.events.acked`*::
++
+--
+type: long
+
+Number of events acknowledged
+
+
+--
+
+*`beat.stats.libbeat.output.events.active`*::
++
+--
+type: long
+
+Number of active events
+
+
+--
+
+*`beat.stats.libbeat.output.events.batches`*::
++
+--
+type: long
+
+Number of event batches
+
+
+--
+
+*`beat.stats.libbeat.output.events.dropped`*::
++
+--
+type: long
+
+Number of events dropped
+
+
+--
+
+*`beat.stats.libbeat.output.events.duplicates`*::
++
+--
+type: long
+
+Number of events duplicated
+
+
+--
+
+*`beat.stats.libbeat.output.events.failed`*::
++
+--
+type: long
+
+Number of events failed
+
+
+--
+
+*`beat.stats.libbeat.output.events.toomany`*::
++
+--
+type: long
+
+Number of too many events
+
+
+--
+
+*`beat.stats.libbeat.output.events.total`*::
++
+--
+type: long
+
+Total number of events
+
+
+--
+
+[float]
+== read fields
+
+Read stats
+
+
+
+*`beat.stats.libbeat.output.read.bytes`*::
++
+--
+type: long
+
+Number of bytes read
+
+
+--
+
+*`beat.stats.libbeat.output.read.errors`*::
++
+--
+type: long
+
+Number of read errors
+
+
+--
+
+[float]
+== write fields
+
+Write stats
+
+
+
+*`beat.stats.libbeat.output.write.bytes`*::
++
+--
+type: long
+
+Number of bytes written
+
+
+--
+
+*`beat.stats.libbeat.output.write.errors`*::
++
+--
+type: long
+
+Number of write errors
+
+
 --
 
 [[exported-fields-ceph]]

metricbeat/metricbeat.reference.yml

@@ -156,6 +156,18 @@ metricbeat.modules:
   # Password of hosts. Empty by default
   #password: password
 
+#-------------------------------- Beat Module --------------------------------
+- module: beat
+  metricsets:
+    - stats
+  period: 10s
+  hosts: ["http://localhost:5066"]
+  #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
+
+  # Set to true to send data collected by module to X-Pack
+  # Monitoring instead of metricbeat-* indices.
+  #xpack.enabled: false
+
 #-------------------------------- Ceph Module --------------------------------
 - module: ceph
   metricsets: ["cluster_disk", "cluster_health", "monitor_health", "pool_disk", "osd_tree"]

metricbeat/module/beat/_meta/Dockerfile

@@ -0,0 +1,6 @@
+FROM docker.elastic.co/beats/metricbeat:7.0.0
+
+COPY healthcheck.sh /
+HEALTHCHECK --interval=1s --retries=300 CMD sh /healthcheck.sh
+
+ENTRYPOINT [ "metricbeat", "-E", "http.enabled=true", "-E", "http.host=0.0.0.0" ]

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

@@ -0,0 +1,9 @@
+- module: beat
+  metricsets:
+    - stats
+  period: 10s
+  hosts: ["http://localhost:5066"]
+  #username: "user"
+  #password: "secret"
+  xpack.enabled: true
+

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

@@ -0,0 +1,10 @@
+- module: beat
+  metricsets:
+    - stats
+  period: 10s
+  hosts: ["http://localhost:5066"]
+  #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
+
+  # Set to true to send data collected by module to X-Pack
+  # Monitoring instead of metricbeat-* indices.
+  #xpack.enabled: false

metricbeat/module/beat/_meta/config.yml

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

metricbeat/module/beat/_meta/env

@@ -0,0 +1,2 @@
+BEAT_HOST=metricbeat
+BEAT_PORT=5066

metricbeat/module/beat/_meta/fields.yml

@@ -0,0 +1,20 @@
+- key: beat
+  title: "Beat"
+  description: >
+    Beat module
+  release: ga
+  settings: ["ssl", "http"]
+  short_config: false
+  fields:
+    - name: beat
+      type: group
+      description: >
+      fields:
+        - name: id
+          type: keyword
+          description: >
+            Beat ID.
+        - name: type
+          type: keyword
+          description: >
+            Beat type.

metricbeat/module/beat/_meta/healthcheck.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+# Check that all endpoints are available
+curl -f http://localhost:5066 || exit 1
+curl -f http://localhost:5066/stats || exit 1
+curl -f http://localhost:5066/state || exit 1