Small adjustments to docker module (#2630)

* Remove config from short config * Comment out config by default * Rename tls.enable to tls.enabled for consistency * Make all field names lower case * Mark the module experimental also in the docs (apply this also to beats module) Part of #2629
elastic · Sep 23, 2016 · f1af264 · f1af264
1 parent 24ecf68
commit f1af264
Show file tree

Hide file tree

Showing 17 changed files with 87 additions and 89 deletions.
diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc
@@ -405,6 +405,7 @@ Contains user configurable fields.
 [[exported-fields-beats]]
 == beats Fields
 
+experimental[]
 beats Module
 
 
@@ -704,6 +705,7 @@ The document type. Always set to "metricsets".
 [[exported-fields-docker]]
 == docker Fields
 
+experimental[]
 Docker stats collected from Docker.
 
 

diff --git a/metricbeat/docs/modules/beats.asciidoc b/metricbeat/docs/modules/beats.asciidoc
@@ -5,6 +5,8 @@ This file is generated! See scripts/docs_collector.py
 [[metricbeat-module-beats]]
 == beats Module
 
+experimental[]
+
 This is the beats Module.
 
 

diff --git a/metricbeat/docs/modules/docker.asciidoc b/metricbeat/docs/modules/docker.asciidoc
@@ -5,6 +5,8 @@ This file is generated! See scripts/docs_collector.py
 [[metricbeat-module-docker]]
 == docker Module
 
+experimental[]
+
 This is the docker Module.
 
 
@@ -18,17 +20,17 @@ in <<configuration-metricbeat>>. Here is an example configuration:
 [source,yaml]
 ----
 metricbeat.modules:
-- module: docker
-  metricsets: ["cpu","memory","network","diskio","container"]
-  enabled: true
-  period: 5s
-  hosts: ["localhost"]
-  socket: unix:///var/run/docker.sock
-
-         # If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
-  tls:
-           # By default, TLS is disabled
-          enable: false
+#- module: docker
+  #metricsets: ["cpu","memory","network","diskio","container"]
+  #enabled: true
+  #period: 5s
+  #hosts: ["localhost"]
+  #socket: unix:///var/run/docker.sock
+
+  # If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
+  #tls:
+    # By default, TLS is disabled
+    #enabled: false
 ----
 
 [float]

diff --git a/metricbeat/etc/beat.full.yml b/metricbeat/etc/beat.full.yml
@@ -79,17 +79,17 @@ metricbeat.modules:
 
 
 #------------------------------- docker Module -------------------------------
-- module: docker
-  metricsets: ["cpu","memory","network","diskio","container"]
-  enabled: true
-  period: 5s
-  hosts: ["localhost"]
-  socket: unix:///var/run/docker.sock
-
-         # If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
-  tls:
-           # By default, TLS is disabled
-          enable: false
+#- module: docker
+  #metricsets: ["cpu","memory","network","diskio","container"]
+  #enabled: true
+  #period: 5s
+  #hosts: ["localhost"]
+  #socket: unix:///var/run/docker.sock
+
+  # If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
+  #tls:
+    # By default, TLS is disabled
+    #enabled: false
 
 #------------------------------- haproxy Module ------------------------------
 #- module: haproxy

diff --git a/metricbeat/etc/beat.yml b/metricbeat/etc/beat.yml
@@ -43,17 +43,4 @@ metricbeat.modules:
   period: 10s
   processes: ['.*']
 
-#------------------------------- docker Module -------------------------------
-- module: docker
-  metricsets: ["cpu","memory","network","diskio","container"]
-  enabled: true
-  period: 5s
-  hosts: ["localhost"]
-  socket: unix:///var/run/docker.sock
-
-         # If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
-  tls:
-           # By default, TLS is disabled
-          enable: false
-
 
diff --git a/metricbeat/etc/fields.yml b/metricbeat/etc/fields.yml
@@ -212,6 +212,8 @@
 - key: beats
   title: "beats"
   description: >
+    experimental[]
+
     beats Module
   short_config: false
   fields:
@@ -380,7 +382,10 @@
 - key: docker
   title: "docker"
   description: >
+    experimental[]
+
     Docker stats collected from Docker.
+  short_config: false
   fields:
     - name: docker
       type: group

diff --git a/metricbeat/metricbeat.full.yml b/metricbeat/metricbeat.full.yml
@@ -79,17 +79,17 @@ metricbeat.modules:
 
 
 #------------------------------- docker Module -------------------------------
-- module: docker
-  metricsets: ["cpu","memory","network","diskio","container"]
-  enabled: true
-  period: 5s
-  hosts: ["localhost"]
-  socket: unix:///var/run/docker.sock
-
-         # If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
-  tls:
-           # By default, TLS is disabled
-          enable: false
+#- module: docker
+  #metricsets: ["cpu","memory","network","diskio","container"]
+  #enabled: true
+  #period: 5s
+  #hosts: ["localhost"]
+  #socket: unix:///var/run/docker.sock
+
+  # If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
+  #tls:
+    # By default, TLS is disabled
+    #enabled: false
 
 #------------------------------- haproxy Module ------------------------------
 #- module: haproxy

diff --git a/metricbeat/metricbeat.yml b/metricbeat/metricbeat.yml
@@ -43,19 +43,6 @@ metricbeat.modules:
   period: 10s
   processes: ['.*']
 
-#------------------------------- docker Module -------------------------------
-- module: docker
-  metricsets: ["cpu","memory","network","diskio","container"]
-  enabled: true
-  period: 5s
-  hosts: ["localhost"]
-  socket: unix:///var/run/docker.sock
-
-         # If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
-  tls:
-           # By default, TLS is disabled
-          enable: false
-
 
 
 #================================ General =====================================

diff --git a/metricbeat/module/beats/_meta/docs.asciidoc b/metricbeat/module/beats/_meta/docs.asciidoc
@@ -1,4 +1,6 @@
 == beats Module
 
+experimental[]
+
 This is the beats Module.
 
diff --git a/metricbeat/module/beats/_meta/fields.yml b/metricbeat/module/beats/_meta/fields.yml
@@ -1,6 +1,8 @@
 - key: beats
   title: "beats"
   description: >
+    experimental[]
+
     beats Module
   short_config: false
   fields:

diff --git a/metricbeat/module/docker/_meta/config.yml b/metricbeat/module/docker/_meta/config.yml
@@ -1,11 +1,11 @@
-- module: docker
-  metricsets: ["cpu","memory","network","diskio","container"]
-  enabled: true
-  period: 5s
-  hosts: ["localhost"]
-  socket: unix:///var/run/docker.sock
+#- module: docker
+  #metricsets: ["cpu","memory","network","diskio","container"]
+  #enabled: true
+  #period: 5s
+  #hosts: ["localhost"]
+  #socket: unix:///var/run/docker.sock
 
-         # If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
-  tls:
-           # By default, TLS is disabled
-          enable: false
+  # If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
+  #tls:
+    # By default, TLS is disabled
+    #enabled: false
diff --git a/metricbeat/module/docker/_meta/docs.asciidoc b/metricbeat/module/docker/_meta/docs.asciidoc
@@ -1,4 +1,6 @@
 == docker Module
 
+experimental[]
+
 This is the docker Module.
 
diff --git a/metricbeat/module/docker/_meta/fields.yml b/metricbeat/module/docker/_meta/fields.yml
@@ -1,7 +1,10 @@
 - key: docker
   title: "docker"
   description: >
+    experimental[]
+
     Docker stats collected from Docker.
+  short_config: false
   fields:
     - name: docker
       type: group

diff --git a/metricbeat/module/docker/config.go b/metricbeat/module/docker/config.go
@@ -1,7 +1,7 @@
 package docker
 
 type TlsConfig struct {
-	Enabled  bool   `config:"enable"`
+	Enabled  bool   `config:"enabled"`
 	CaPath   string `config:"ca_path"`
 	CertPath string `config:"cert_path"`
 	KeyPath  string `config:"key_path"`

diff --git a/metricbeat/module/docker/container/data.go b/metricbeat/module/docker/container/data.go
@@ -22,16 +22,16 @@ func eventMapping(mycontainer *dc.APIContainers) common.MapStr {
 	event := common.MapStr{
 		"@timestamp": time.Now(),
 		"container": common.MapStr{
-			"created":    common.Time(time.Unix(mycontainer.Created, 0)),
-			"id":         mycontainer.ID,
-			"name":       docker.ExtractContainerName(mycontainer.Names),
-			"labels":     docker.BuildLabelArray(mycontainer.Labels),
-			"command":    mycontainer.Command,
-			"image":      mycontainer.Image,
-			"ports":      docker.ConvertContainerPorts(&mycontainer.Ports),
-			"sizeRootFs": mycontainer.SizeRootFs,
-			"sizeRw":     mycontainer.SizeRw,
-			"status":     mycontainer.Status,
+			"created":      common.Time(time.Unix(mycontainer.Created, 0)),
+			"id":           mycontainer.ID,
+			"name":         docker.ExtractContainerName(mycontainer.Names),
+			"labels":       docker.BuildLabelArray(mycontainer.Labels),
+			"command":      mycontainer.Command,
+			"image":        mycontainer.Image,
+			"ports":        docker.ConvertContainerPorts(&mycontainer.Ports),
+			"size_root_fs": mycontainer.SizeRootFs,
+			"size_rw":      mycontainer.SizeRw,
+			"status":       mycontainer.Status,
 		},
 		"socket": docker.GetSocket(),
 	}

diff --git a/metricbeat/module/docker/diskio/data.go b/metricbeat/module/docker/diskio/data.go
@@ -24,7 +24,7 @@ func eventMapping(myBlkioStats *BlkioStats) common.MapStr {
 		"blkio": common.MapStr{
 			"reads":  myBlkioStats.reads,
 			"writes": myBlkioStats.writes,
-			"Total":  myBlkioStats.totals,
+			"total":  myBlkioStats.totals,
 		},
 	}
 	return event

diff --git a/metricbeat/module/docker/network/data.go b/metricbeat/module/docker/network/data.go
@@ -22,14 +22,18 @@ func eventMapping(myNetStats *NETstats) common.MapStr {
 		},
 		"socket": docker.GetSocket(),
 		myNetStats.NameInterface: common.MapStr{
-			"rx_bytes":   myNetStats.RxBytes,
-			"rx_dropped": myNetStats.RxDropped,
-			"rx_errors":  myNetStats.RxErrors,
-			"rx_packets": myNetStats.RxPackets,
-			"tx_bytes":   myNetStats.TxBytes,
-			"tx_dropped": myNetStats.TxDropped,
-			"tx_errors":  myNetStats.TxErrors,
-			"tx_packets": myNetStats.TxPackets,
+			"rx": common.MapStr{
+				"bytes":   myNetStats.RxBytes,
+				"dropped": myNetStats.RxDropped,
+				"errors":  myNetStats.RxErrors,
+				"packets": myNetStats.RxPackets,
+			},
+			"tx": common.MapStr{
+				"bytes":   myNetStats.TxBytes,
+				"dropped": myNetStats.TxDropped,
+				"errors":  myNetStats.TxErrors,
+				"packets": myNetStats.TxPackets,
+			},
 		},
 	}
 	return event