Add HealthCheck information for Metricbeat docker module

metricbeat/_meta/beat.full.yml

@@ -103,7 +103,7 @@ metricbeat.modules:
 
 #------------------------------- Docker Module -------------------------------
 #- module: docker
-  #metricsets: ["cpu", "info", "memory", "network", "diskio", "container"]
+  #metricsets: ["container", "cpu", "diskio", "healthcheck", "info", "memory", "network"]
   #hosts: ["unix:///var/run/docker.sock"]
   #enabled: true
   #period: 10s

metricbeat/docs/fields.asciidoc

@@ -1171,6 +1171,68 @@ type: scaled_float
 Number of reads and writes combined.
 
 
+[float]
+== healthcheck Fields
+
+Docker container metrics.
+
+
+
+[float]
+=== docker.healthcheck.failingstreak
+
+type: integer
+
+concurent failed check
+
+
+[float]
+=== docker.healthcheck.status
+
+type: keyword
+
+Healthcheck status code
+
+
+[float]
+== event Fields
+
+event fields.
+
+
+
+[float]
+=== docker.healthcheck.event.end_date
+
+type: date
+
+Healthcheck end date
+
+
+[float]
+=== docker.healthcheck.event.start_date
+
+type: date
+
+Healthcheck start date
+
+
+[float]
+=== docker.healthcheck.event.output
+
+type: keyword
+
+Healthcheck output
+
+
+[float]
+=== docker.healthcheck.event.exit_code
+
+type: integer
+
+Healthcheck status code
+
+
 [float]
 == info Fields
 

metricbeat/docs/modules/docker.asciidoc

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

metricbeat/docs/modules/docker/healthcheck.asciidoc

@@ -0,0 +1,19 @@
+////
+This file is generated! See scripts/docs_collector.py
+////
+
+[[metricbeat-metricset-docker-healthcheck]]
+include::../../../module/docker/healthcheck/_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/healthcheck/_meta/data.json[]
+----

metricbeat/include/list.go

@@ -18,6 +18,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/healthcheck"
 	_ "github.com/elastic/beats/metricbeat/module/docker/info"
 	_ "github.com/elastic/beats/metricbeat/module/docker/memory"
 	_ "github.com/elastic/beats/metricbeat/module/docker/network"

metricbeat/metricbeat.full.yml

@@ -103,7 +103,7 @@ metricbeat.modules:
 
 #------------------------------- Docker Module -------------------------------
 #- module: docker
-  #metricsets: ["cpu", "info", "memory", "network", "diskio", "container"]
+  #metricsets: ["container", "cpu", "diskio", "healthcheck", "info", "memory", "network"]
   #hosts: ["unix:///var/run/docker.sock"]
   #enabled: true
   #period: 10s

metricbeat/metricbeat.template-es2x.json

@@ -668,6 +668,36 @@
                 }
               }
             },
+            "healthcheck": {
+              "properties": {
+                "event": {
+                  "properties": {
+                    "end_date": {
+                      "type": "date"
+                    },
+                    "exit_code": {
+                      "type": "long"
+                    },
+                    "output": {
+                      "ignore_above": 1024,
+                      "index": "not_analyzed",
+                      "type": "string"
+                    },
+                    "start_date": {
+                      "type": "date"
+                    }
+                  }
+                },
+                "failingstreak": {
+                  "type": "long"
+                },
+                "status": {
+                  "ignore_above": 1024,
+                  "index": "not_analyzed",
+                  "type": "string"
+                }
+              }
+            },
             "info": {
               "properties": {
                 "containers": {

metricbeat/metricbeat.template.json

@@ -670,6 +670,34 @@
                 }
               }
             },
+            "healthcheck": {
+              "properties": {
+                "event": {
+                  "properties": {
+                    "end_date": {
+                      "type": "date"
+                    },
+                    "exit_code": {
+                      "type": "long"
+                    },
+                    "output": {
+                      "ignore_above": 1024,
+                      "type": "keyword"
+                    },
+                    "start_date": {
+                      "type": "date"
+                    }
+                  }
+                },
+                "failingstreak": {
+                  "type": "long"
+                },
+                "status": {
+                  "ignore_above": 1024,
+                  "type": "keyword"
+                }
+              }
+            },
             "info": {
               "properties": {
                 "containers": {

metricbeat/module/docker/_meta/config.yml

@@ -1,5 +1,5 @@
 #- module: docker
-  #metricsets: ["cpu", "info", "memory", "network", "diskio", "container"]
+  #metricsets: ["container", "cpu", "diskio", "healthcheck", "info", "memory", "network"]
   #hosts: ["unix:///var/run/docker.sock"]
   #enabled: true
   #period: 10s

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

@@ -32,4 +32,4 @@
         "rtt": 115
     },
     "type": "metricsets"
-}
+}

metricbeat/module/docker/container/data.go

@@ -32,6 +32,7 @@ func eventMapping(cont *dc.APIContainers) common.MapStr {
 	}
 
 	labels := docker.DeDotLabels(cont.Labels)
+
 	if len(labels) > 0 {
 		event["labels"] = labels
 	}

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

@@ -0,0 +1,26 @@
+{
+    "@timestamp": "2016-05-23T08:05:34.853Z",
+    "beat": {
+        "hostname": "host.example.com",
+        "name": "host.example.com"
+    },
+    "docker": {
+        "healthcheck": {
+            "failingstreak": 0,
+            "status": "healthy",
+            "event": {
+              "end_date": "2017-01-09T20:38:13.080472813+01:00",
+              "exit_code": 0,
+              "output": "this is an event output",
+              "start_date": "2017-01-09T20:38:12.999970865+01:00",
+            }
+        }
+    },
+    "metricset": {
+        "host": "/var/run/docker.sock",
+        "module": "docker",
+        "name": "container",
+        "rtt": 115
+    },
+    "type": "metricsets"
+}

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

@@ -0,0 +1,4 @@
+=== Docker healthcheck Metricset
+
+The Docker `healthcheck` metricset collects information and statistics about
+running Docker containers.

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

@@ -0,0 +1,34 @@
+- name: healthcheck
+  type: group
+  description: >
+    Docker container metrics.
+  fields:
+    - name: failingstreak
+      type: integer
+      description: >
+        concurent failed check
+    - name: status
+      type: keyword
+      description: >
+        Healthcheck status code
+    - name: event
+      type: group
+      description: >
+        event fields.
+      fields:
+        - name: end_date
+          type: date
+          description: >
+            Healthcheck end date
+        - name: start_date
+          type: date
+          description: >
+            Healthcheck start date
+        - name: output
+          type: keyword
+          description: >
+            Healthcheck output
+        - name: exit_code
+          type: integer
+          description: >
+            Healthcheck status code

metricbeat/module/docker/healthcheck/container_integration_test.go

@@ -0,0 +1,25 @@
+// +build integration
+
+package healthcheck
+
+import (
+	"testing"
+
+	mbtest "github.com/elastic/beats/metricbeat/mb/testing"
+)
+
+func TestData(t *testing.T) {
+	f := mbtest.NewEventsFetcher(t, getConfig())
+	err := mbtest.WriteEvents(f, t)
+	if err != nil {
+		t.Fatal("write", err)
+	}
+}
+
+func getConfig() map[string]interface{} {
+	return map[string]interface{}{
+		"module":     "docker",
+		"metricsets": []string{"healthcheck"},
+		"hosts":      []string{"unix:///var/run/docker.sock"},
+	}
+}

metricbeat/module/docker/healthcheck/data.go

@@ -0,0 +1,52 @@
+package healthcheck
+
+import (
+	"github.com/elastic/beats/libbeat/common"
+	"github.com/elastic/beats/metricbeat/mb"
+	"github.com/elastic/beats/metricbeat/module/docker"
+
+	dc "github.com/fsouza/go-dockerclient"
+	"strings"
+)
+
+func eventsMapping(containersList []dc.APIContainers, m *MetricSet) []common.MapStr {
+	myEvents := []common.MapStr{}
+	for _, container := range containersList {
+		returnevent := eventMapping(&container, m)
+		// Compare event to empty event
+		if returnevent != nil {
+			myEvents = append(myEvents, returnevent)
+		}
+	}
+	return myEvents
+}
+
+func eventMapping(cont *dc.APIContainers, m *MetricSet) common.MapStr {
+	event := common.MapStr{}
+	// Detect if healthcheck is available for container
+	if strings.Contains(cont.Status, "(") && strings.Contains(cont.Status, ")") {
+		container, _ := m.dockerClient.InspectContainer(cont.ID)
+		last_event := len(container.State.Health.Log) - 1
+		// Detect if an healthcheck already occured
+		if last_event >= 0 {
+			event = common.MapStr{
+				mb.ModuleData: common.MapStr{
+					"container": common.MapStr{
+						"name": docker.ExtractContainerName(cont.Names),
+						"id":   cont.ID,
+					},
+				},
+				"status":        container.State.Health.Status,
+				"failingstreak": container.State.Health.FailingStreak,
+				"event": common.MapStr{
+					"start_date": common.Time(container.State.Health.Log[last_event].Start),
+					"end_date":   common.Time(container.State.Health.Log[last_event].End),
+					"exit_code":  container.State.Health.Log[last_event].ExitCode,
+					"output":     container.State.Health.Log[last_event].Output,
+				},
+			}
+			return event
+		}
+	}
+	return nil
+}