Add memcached module with stats metricset

CHANGELOG.asciidoc

@@ -98,6 +98,7 @@ https://github.com/elastic/beats/compare/v5.1.1...master[Check the HEAD diff]
 - The Docker, Kafka, and Prometheus modules are now Beta, instead of experimental. {pull}3525[3525]
 - The HAProxy module is now GA, instead of experimental. {pull}3525[3525]
 - Add the ability to collect the environment variables from system processes. {pull}3337[3337]
+- Add memcached module with stats metricset. {pull}3693[3693]
 
 *Packetbeat*
 - Add `fields` and `fields_under_root` to packetbeat protocols configurations. {pull}3518[3518]

metricbeat/docker-compose.yml

@@ -22,6 +22,7 @@ services:
       - ${PWD}/module/haproxy/_meta/env
       - ${PWD}/module/jolokia/_meta/env
       - ${PWD}/module/kafka/_meta/env
+      - ${PWD}/module/memcached/_meta/env
       - ${PWD}/module/mongodb/_meta/env
       - ${PWD}/module/mysql/_meta/env
       - ${PWD}/module/nginx/_meta/env
@@ -42,6 +43,7 @@ services:
       haproxy:    { condition: service_healthy }
       jolokia:    { condition: service_healthy }
       kafka:      { condition: service_healthy }
+      memcached:  { condition: service_healthy }
       mongodb:    { condition: service_healthy }
       mysql:      { condition: service_healthy }
       nginx:      { condition: service_healthy }
@@ -70,6 +72,9 @@ services:
   kafka:
     build: ${PWD}/module/kafka/_meta
 
+  memcached:
+    build: ${PWD}/module/memcached/_meta
+
   mongodb:
     build: ${PWD}/module/mongodb/_meta
 

metricbeat/docs/fields.asciidoc

@@ -23,6 +23,7 @@ grouped in the following categories:
 * <<exported-fields-haproxy>>
 * <<exported-fields-jolokia>>
 * <<exported-fields-kafka>>
+* <<exported-fields-memcached>>
 * <<exported-fields-mongodb>>
 * <<exported-fields-mysql>>
 * <<exported-fields-nginx>>
@@ -3321,6 +3322,139 @@ type: keyword
 Broker address
 
 
+[[exported-fields-memcached]]
+== memcached Fields
+
+[]beta
+memcached Module
+
+
+
+[float]
+== memcached Fields
+
+
+
+
+[float]
+== stats Fields
+
+stats
+
+
+
+[float]
+=== memcached.stats.pid
+
+type: long
+
+Current process ID of the Memcached task.
+
+
+[float]
+=== memcached.stats.uptime.sec
+
+type: long
+
+Memcached server uptime.
+
+
+[float]
+=== memcached.stats.threads
+
+type: long
+
+Number of threads used by the current Memcached server process.
+
+
+[float]
+=== memcached.stats.connections.current
+
+type: long
+
+Number of open connections to this Memcached server, should be the same value on all servers during normal operation.
+
+
+[float]
+=== memcached.stats.connections.total
+
+type: long
+
+Numer of successful connect attempts to this server since it has been started.
+
+
+[float]
+=== memcached.stats.get.hits
+
+type: long
+
+Number of successful "get" commands (cache hits) since startup, divide them by the "cmd_get" value to get the cache hitrate.
+
+
+[float]
+=== memcached.stats.get.misses
+
+type: long
+
+Number of failed "get" requests because nothing was cached for this key or the cached value was too old.
+
+
+[float]
+=== memcached.stats.cmd.get
+
+type: long
+
+Number of "get" commands received since server startup not counting if they were successful or not.
+
+
+[float]
+=== memcached.stats.cmd.set
+
+type: long
+
+Number of "set" commands serviced since startup.
+
+
+[float]
+=== memcached.stats.read.bytes
+
+type: long
+
+Total number of bytes received from the network by this server.
+
+
+[float]
+=== memcached.stats.written.bytes
+
+type: long
+
+Total number of bytes send to the network by this server.
+
+
+[float]
+=== memcached.stats.items.current
+
+type: long
+
+Number of items currently in this server's cache.
+
+
+[float]
+=== memcached.stats.items.total
+
+type: long
+
+Number of items stored ever stored on this server. This is no "maximum item count" value but a counted increased by every new item stored in the cache.
+
+
+[float]
+=== memcached.stats.evictions
+
+type: long
+
+Number of objects removed from the cache to free up memory for new items because Memcached reached it's maximum memory setting (limit_maxbytes).
+
+
 [[exported-fields-mongodb]]
 == MongoDB Fields
 

metricbeat/docs/modules/memcached.asciidoc

@@ -0,0 +1,37 @@
+////
+This file is generated! See scripts/docs_collector.py
+////
+
+[[metricbeat-module-memcached]]
+== memcached Module
+
+This is the memcached Module. These metricsets were tested with memcached version 1.4.35.
+
+
+
+[float]
+=== Example Configuration
+
+The memcached module supports the standard configuration options that are described
+in <<configuration-metricbeat>>. Here is an example configuration:
+
+[source,yaml]
+----
+metricbeat.modules:
+- module: memcached
+  metricsets: ["stats"]
+  enabled: true
+  period: 10s
+  hosts: ["localhost:11211"]
+
+----
+
+[float]
+=== Metricsets
+
+The following metricsets are available:
+
+* <<metricbeat-metricset-memcached-stats,stats>>
+
+include::memcached/stats.asciidoc[]
+

metricbeat/docs/modules/memcached/stats.asciidoc

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

metricbeat/docs/modules_list.asciidoc

@@ -10,6 +10,7 @@ This file is generated! See scripts/docs_collector.py
   * <<metricbeat-module-haproxy,HAProxy>>
   * <<metricbeat-module-jolokia,Jolokia>>
   * <<metricbeat-module-kafka,kafka>>
+  * <<metricbeat-module-memcached,memcached>>
   * <<metricbeat-module-mongodb,MongoDB>>
   * <<metricbeat-module-mysql,MySQL>>
   * <<metricbeat-module-nginx,Nginx>>
@@ -31,6 +32,7 @@ include::modules/golang.asciidoc[]
 include::modules/haproxy.asciidoc[]
 include::modules/jolokia.asciidoc[]
 include::modules/kafka.asciidoc[]
+include::modules/memcached.asciidoc[]
 include::modules/mongodb.asciidoc[]
 include::modules/mysql.asciidoc[]
 include::modules/nginx.asciidoc[]

metricbeat/include/list.go

@@ -39,6 +39,8 @@ import (
 	_ "github.com/elastic/beats/metricbeat/module/kafka"
 	_ "github.com/elastic/beats/metricbeat/module/kafka/consumergroup"
 	_ "github.com/elastic/beats/metricbeat/module/kafka/partition"
+	_ "github.com/elastic/beats/metricbeat/module/memcached"
+	_ "github.com/elastic/beats/metricbeat/module/memcached/stats"
 	_ "github.com/elastic/beats/metricbeat/module/mongodb"
 	_ "github.com/elastic/beats/metricbeat/module/mongodb/dbstats"
 	_ "github.com/elastic/beats/metricbeat/module/mongodb/status"

metricbeat/metricbeat.full.yml

@@ -179,6 +179,14 @@ metricbeat.modules:
   #username: ""
   #password: ""
 
+#------------------------------ memcached Module -----------------------------
+- module: memcached
+  metricsets: ["stats"]
+  enabled: true
+  period: 10s
+  hosts: ["localhost:11211"]
+
+
 #------------------------------- MongoDB Module ------------------------------
 #- module: mongodb
   #metricsets: ["dbstats", "status"]

metricbeat/module/memcached/_meta/Dockerfile

@@ -0,0 +1,8 @@
+FROM memcached:1.4.35-alpine
+
+USER root
+RUN apk update
+RUN apk add netcat-openbsd
+USER memcache
+
+HEALTHCHECK CMD nc -z localhost 11211

metricbeat/module/memcached/_meta/config.yml

@@ -0,0 +1,6 @@
+- module: memcached
+  metricsets: ["stats"]
+  enabled: true
+  period: 10s
+  hosts: ["localhost:11211"]
+

metricbeat/module/memcached/_meta/docs.asciidoc

@@ -0,0 +1,4 @@
+== memcached Module
+
+This is the memcached Module. These metricsets were tested with memcached version 1.4.35.
+

metricbeat/module/memcached/_meta/env

@@ -0,0 +1,2 @@
+MEMCACHED_HOST=memcached
+MEMCACHED_PORT=11211

metricbeat/module/memcached/_meta/fields.yml

@@ -0,0 +1,12 @@
+- key: memcached
+  title: "memcached"
+  description: >
+    []beta
+
+    memcached Module
+  short_config: false
+  fields:
+    - name: memcached
+      type: group
+      description: >
+      fields:

metricbeat/module/memcached/doc.go

@@ -0,0 +1,4 @@
+/*
+Package memcached is a Metricbeat module that contains MetricSets.
+*/
+package memcached

metricbeat/module/memcached/stats/_meta/data.json

@@ -0,0 +1,46 @@
+{
+    "@timestamp": "2016-05-23T08:05:34.853Z",
+    "beat": {
+        "hostname": "host.example.com",
+        "name": "host.example.com"
+    },
+    "memcached": {
+        "stats": {
+            "cmd": {
+                "get": 0,
+                "set": 0
+            },
+            "connections": {
+                "current": 10,
+                "total": 11
+            },
+            "evictions": 0,
+            "get": {
+                "hits": 0,
+                "misses": 0
+            },
+            "items": {
+                "current": 0,
+                "total": 0
+            },
+            "pid": 1,
+            "read": {
+                "bytes": 6
+            },
+            "threads": 4,
+            "uptime": {
+                "sec": 7
+            },
+            "written": {
+                "bytes": 0
+            }
+        }
+    },
+    "metricset": {
+        "host": "127.0.0.1:11211",
+        "module": "memcached",
+        "name": "stats",
+        "rtt": 115
+    },
+    "type": "metricsets"
+}

metricbeat/module/memcached/stats/_meta/docs.asciidoc

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