Add info Metricset to Docker module

CHANGELOG.asciidoc

@@ -50,6 +50,7 @@ https://github.com/elastic/beats/compare/v5.0.0-beta1...master[Check the HEAD di
 
 - Add experimental filebeat metricset in the beats module. {pull}2297[2297]
 - Add experimental libbeat metricset in the beats module. {pull}2339[2339]
+- Add experimental docker module. Provided by Ingensi and @douaejeouit based on dockbeat.
 
 *Packetbeat*
 

metricbeat/docs/fields.asciidoc

@@ -769,6 +769,69 @@ type: keyword
 Example field
 
 
+[float]
+== info Fields
+
+experimental[]
+info metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information
+
+
+
+[float]
+== containers Fields
+
+Overall container stats.
+
+
+
+[float]
+=== docker.info.containers.paused
+
+type: long
+
+Total number of paused containers.
+
+
+[float]
+=== docker.info.containers.running
+
+type: long
+
+Total number of running containers.
+
+
+[float]
+=== docker.info.containers.stopped
+
+type: long
+
+Total number of stopped containers.
+
+
+[float]
+=== docker.info.containers.total
+
+type: long
+
+Total number of existing containers.
+
+
+[float]
+=== docker.info.id
+
+type: keyword
+
+Unique docker host identifier.
+
+
+[float]
+=== docker.info.images
+
+type: long
+
+Total number of existing images.
+
+
 [float]
 == memory Fields
 

metricbeat/docs/modules/docker.asciidoc

@@ -21,7 +21,7 @@ in <<configuration-metricbeat>>. Here is an example configuration:
 ----
 metricbeat.modules:
 #- module: docker
-  #metricsets: ["cpu","memory","network","diskio","container"]
+  #metricsets: ["cpu", "info", "memory", "network", "diskio", "container"]
   #enabled: true
   #period: 10s
   #hosts: ["localhost"]
@@ -44,6 +44,8 @@ The following metricsets are available:
 
 * <<metricbeat-metricset-docker-diskio,diskio>>
 
+* <<metricbeat-metricset-docker-info,info>>
+
 * <<metricbeat-metricset-docker-memory,memory>>
 
 * <<metricbeat-metricset-docker-network,network>>
@@ -54,6 +56,8 @@ include::docker/cpu.asciidoc[]
 
 include::docker/diskio.asciidoc[]
 
+include::docker/info.asciidoc[]
+
 include::docker/memory.asciidoc[]
 
 include::docker/network.asciidoc[]

metricbeat/docs/modules/docker/info.asciidoc

@@ -0,0 +1,19 @@
+////
+This file is generated! See scripts/docs_collector.py
+////
+
+[[metricbeat-metricset-docker-info]]
+include::../../../module/docker/info/_meta/docs.asciidoc[]
+
+
+==== Fields
+
+For a description of each field in the metricset, see the
+<<exported-fields-docker,exported fields>> section.
+
+Here is an example document generated by this metricset:
+
+[source,json]
+----
+include::../../../module/docker/info/_meta/data.json[]
+----

metricbeat/etc/beat.full.yml

@@ -80,7 +80,7 @@ metricbeat.modules:
 
 #------------------------------- docker Module -------------------------------
 #- module: docker
-  #metricsets: ["cpu","memory","network","diskio","container"]
+  #metricsets: ["cpu", "info", "memory", "network", "diskio", "container"]
   #enabled: true
   #period: 10s
   #hosts: ["localhost"]

metricbeat/etc/fields.yml

@@ -475,6 +475,44 @@
               description: >
                 Example field
 
+        - name: info
+          type: group
+          description: >
+            experimental[]
+
+            info metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information
+          fields:
+            - name: containers
+              type: group
+              description: >
+                Overall container stats.
+              fields:
+                - name: paused
+                  type: long
+                  description: >
+                    Total number of paused containers.
+                - name: running
+                  type: long
+                  description: >
+                    Total number of running containers.
+                - name: stopped
+                  type: long
+                  description: >
+                    Total number of stopped containers.
+                - name: total
+                  type: long
+                  description: >
+                    Total number of existing containers.
+            - name: id
+              type: keyword
+              description: >
+                Unique docker host identifier.
+
+            - name: images
+              type: long
+              description: >
+                Total number of existing images.
+
         - name: memory
           type: group
           description: >

metricbeat/include/list.go

@@ -17,6 +17,7 @@ import (
 	_ "github.com/elastic/beats/metricbeat/module/docker/container"
 	_ "github.com/elastic/beats/metricbeat/module/docker/cpu"
 	_ "github.com/elastic/beats/metricbeat/module/docker/diskio"
+	_ "github.com/elastic/beats/metricbeat/module/docker/info"
 	_ "github.com/elastic/beats/metricbeat/module/docker/memory"
 	_ "github.com/elastic/beats/metricbeat/module/docker/network"
 	_ "github.com/elastic/beats/metricbeat/module/haproxy"

metricbeat/metricbeat.full.yml

@@ -80,7 +80,7 @@ metricbeat.modules:
 
 #------------------------------- docker Module -------------------------------
 #- module: docker
-  #metricsets: ["cpu","memory","network","diskio","container"]
+  #metricsets: ["cpu", "info", "memory", "network", "diskio", "container"]
   #enabled: true
   #period: 10s
   #hosts: ["localhost"]

metricbeat/metricbeat.template-es2x.json

@@ -332,6 +332,34 @@
                 }
               }
             },
+            "info": {
+              "properties": {
+                "containers": {
+                  "properties": {
+                    "paused": {
+                      "type": "long"
+                    },
+                    "running": {
+                      "type": "long"
+                    },
+                    "stopped": {
+                      "type": "long"
+                    },
+                    "total": {
+                      "type": "long"
+                    }
+                  }
+                },
+                "id": {
+                  "ignore_above": 1024,
+                  "index": "not_analyzed",
+                  "type": "string"
+                },
+                "images": {
+                  "type": "long"
+                }
+              }
+            },
             "memory": {
               "properties": {
                 "example": {

metricbeat/metricbeat.template.json

@@ -335,6 +335,33 @@
                 }
               }
             },
+            "info": {
+              "properties": {
+                "containers": {
+                  "properties": {
+                    "paused": {
+                      "type": "long"
+                    },
+                    "running": {
+                      "type": "long"
+                    },
+                    "stopped": {
+                      "type": "long"
+                    },
+                    "total": {
+                      "type": "long"
+                    }
+                  }
+                },
+                "id": {
+                  "ignore_above": 1024,
+                  "type": "keyword"
+                },
+                "images": {
+                  "type": "long"
+                }
+              }
+            },
             "memory": {
               "properties": {
                 "example": {

metricbeat/module/docker/_meta/config.yml

@@ -1,5 +1,5 @@
 #- module: docker
-  #metricsets: ["cpu","memory","network","diskio","container"]
+  #metricsets: ["cpu", "info", "memory", "network", "diskio", "container"]
   #enabled: true
   #period: 10s
   #hosts: ["localhost"]

metricbeat/module/docker/info/_meta/data.json

@@ -0,0 +1,26 @@
+{
+    "@timestamp": "2016-05-23T08:05:34.853Z",
+    "beat": {
+        "hostname": "host.example.com",
+        "name": "host.example.com"
+    },
+    "docker": {
+        "info": {
+            "containers": {
+                "paused": 0,
+                "running": 1,
+                "stopped": 16,
+                "total": 17
+            },
+            "id": "HAUM:OUVF:WQF3:3BMQ:JS3B:QEMH:U7YR:SM5Z:P2UA:CRKR:5KRS:UTVU",
+            "images": 784
+        }
+    },
+    "metricset": {
+        "host": "localhost",
+        "module": "docker",
+        "name": "info",
+        "rtt": 115
+    },
+    "type": "metricsets"
+}

metricbeat/module/docker/info/_meta/docs.asciidoc

@@ -0,0 +1,3 @@
+=== docker info MetricSet
+
+This is the info metricset of the module docker.

metricbeat/module/docker/info/_meta/fields.yml

@@ -0,0 +1,37 @@
+- name: info
+  type: group
+  description: >
+    experimental[]
+
+    info metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information
+  fields:
+    - name: containers
+      type: group
+      description: >
+        Overall container stats.
+      fields:
+        - name: paused
+          type: long
+          description: >
+            Total number of paused containers.
+        - name: running
+          type: long
+          description: >
+            Total number of running containers.
+        - name: stopped
+          type: long
+          description: >
+            Total number of stopped containers.
+        - name: total
+          type: long
+          description: >
+            Total number of existing containers.
+    - name: id
+      type: keyword
+      description: >
+        Unique docker host identifier.
+
+    - name: images
+      type: long
+      description: >
+        Total number of existing images.

metricbeat/module/docker/info/data.go

@@ -0,0 +1,23 @@
+package info
+
+import (
+	"github.com/elastic/beats/libbeat/common"
+
+	dc "github.com/fsouza/go-dockerclient"
+)
+
+func eventMapping(info *dc.DockerInfo) common.MapStr {
+
+	event := common.MapStr{
+		"id": info.ID,
+		"containers": common.MapStr{
+			"total":   info.Containers,
+			"running": info.ContainersRunning,
+			"paused":  info.ContainersPaused,
+			"stopped": info.ContainersStopped,
+		},
+		"images": info.Images,
+	}
+
+	return event
+}