Add fields for Nginx and Nginx stub metricset

metricbeat/docker-compose.yml

@@ -32,7 +32,7 @@ mysql:
     - MYSQL_ROOT_PASSWORD=test
 
 nginx:
-  build: tests/environments/nginx
+  build: ${PWD}/tests/environments/nginx
 
 redis:
   image: redis:3.0.7

metricbeat/docs/fields.asciidoc

@@ -13,6 +13,7 @@ grouped in the following categories:
 * <<exported-fields-apache>>
 * <<exported-fields-redis>>
 * <<exported-fields-mysql>>
+* <<exported-fields-nginx>>
 * <<exported-fields-system>>
 
 [[exported-fields-common]]
@@ -518,6 +519,89 @@ type: long
 The number of bytes sent to all clients.
 
 
+[[exported-fields-nginx]]
+=== Nginx Status Fields
+
+Nginx server status metrics collected from various modules.
+
+
+
+=== nginx-stubstatus Fields
+
+`nginx-stubstatus` contains the metrics that were scraped from the ngx_http_stub_status_module status page.
+
+
+
+==== nginx-stubstatus.hostname
+
+type: keyword
+
+Nginx hostname
+
+
+==== nginx-stubstatus.active
+
+type: integer
+
+The current number of active client connections including Waiting connections.
+
+
+==== nginx-stubstatus.accepts
+
+type: integer
+
+The total number of accepted client connections.
+
+
+==== nginx-stubstatus.handled
+
+type: integer
+
+The total number of handled client connections.
+
+
+==== nginx-stubstatus.dropped
+
+type: integer
+
+The total number of dropped client connections.
+
+
+==== nginx-stubstatus.requests
+
+type: integer
+
+The total number of client requests.
+
+
+==== nginx-stubstatus.current
+
+type: integer
+
+The current number of client requests.
+
+
+==== nginx-stubstatus.reading
+
+type: integer
+
+The current number of connections where nginx is reading the request header.
+
+
+==== nginx-stubstatus.writing
+
+type: integer
+
+The current number of connections where nginx is writing the response back to the client.
+
+
+==== nginx-stubstatus.waiting
+
+type: integer
+
+The current number of idle client connections waiting for a request.
+
+
 [[exported-fields-system]]
 === System Status Fields
 

metricbeat/etc/fields.yml

@@ -10,6 +10,7 @@ sections:
   - ["apache", "Apache Status"]
   - ["redis", "Redis Info"]
   - ["mysql", "MySQL Status"]
+  - ["nginx", "Nginx Status"]
   - ["system", "System Status"]
 
 common:
@@ -284,6 +285,56 @@ mysql:
               type: long
               description: >
                 The number of bytes sent to all clients.
+nginx:
+  type: group
+  description: >
+    Nginx server status metrics collected from various modules.
+  fields:
+    - name: nginx-stubstatus
+      type: group
+      description: >
+        `nginx-stubstatus` contains the metrics that were scraped from the ngx_http_stub_status_module status page.
+      fields:
+        - name: hostname
+          type: keyword
+          description: >
+            Nginx hostname
+        - name: active
+          type: integer
+          description: >
+            The current number of active client connections including Waiting connections.
+        - name: accepts
+          type: integer
+          description: >
+            The total number of accepted client connections.
+        - name: handled
+          type: integer
+          description: >
+            The total number of handled client connections.
+        - name: dropped
+          type: integer
+          description: >
+            The total number of dropped client connections.
+        - name: requests
+          type: integer
+          description: >
+            The total number of client requests.
+        - name: current
+          type: integer
+          description: >
+            The current number of client requests.
+        - name: reading
+          type: integer
+          description: >
+            The current number of connections where nginx is reading the request header.
+        - name: writing
+          type: integer
+          description: >
+            The current number of connections where nginx is writing the response back to the client.
+        - name: waiting
+          type: integer
+          description: >
+            The current number of idle client connections waiting for a request.
 redis:
   type: group
   description: >

metricbeat/etc/fields_base.yml

@@ -10,6 +10,7 @@ sections:
   - ["apache", "Apache Status"]
   - ["redis", "Redis Info"]
   - ["mysql", "MySQL Status"]
+  - ["nginx", "Nginx Status"]
   - ["system", "System Status"]
 
 common:

metricbeat/metricbeat.template-es2x.json

@@ -204,6 +204,42 @@
             }
           }
         },
+        "nginx-stubstatus": {
+          "properties": {
+            "accepts": {
+              "type": "integer"
+            },
+            "active": {
+              "type": "integer"
+            },
+            "current": {
+              "type": "integer"
+            },
+            "dropped": {
+              "type": "integer"
+            },
+            "handled": {
+              "type": "integer"
+            },
+            "hostname": {
+              "ignore_above": 1024,
+              "index": "not_analyzed",
+              "type": "string"
+            },
+            "reading": {
+              "type": "integer"
+            },
+            "requests": {
+              "type": "integer"
+            },
+            "waiting": {
+              "type": "integer"
+            },
+            "writing": {
+              "type": "integer"
+            }
+          }
+        },
         "redis-info": {
           "properties": {
             "clients": {

metricbeat/metricbeat.template.json

@@ -195,6 +195,41 @@
             }
           }
         },
+        "nginx-stubstatus": {
+          "properties": {
+            "accepts": {
+              "type": "integer"
+            },
+            "active": {
+              "type": "integer"
+            },
+            "current": {
+              "type": "integer"
+            },
+            "dropped": {
+              "type": "integer"
+            },
+            "handled": {
+              "type": "integer"
+            },
+            "hostname": {
+              "ignore_above": 1024,
+              "type": "keyword"
+            },
+            "reading": {
+              "type": "integer"
+            },
+            "requests": {
+              "type": "integer"
+            },
+            "waiting": {
+              "type": "integer"
+            },
+            "writing": {
+              "type": "integer"
+            }
+          }
+        },
         "redis-info": {
           "properties": {
             "clients": {

metricbeat/metricbeat.yml

@@ -358,3 +358,5 @@ logging:
   # Sets log level. The default log level is error.
   # Available log levels are: critical, error, warning, info, debug
   #level: error
+
+

metricbeat/module/nginx/fields.yml

@@ -0,0 +1,5 @@
+nginx:
+  type: group
+  description: >
+    Nginx server status metrics collected from various modules.
+  fields:

metricbeat/module/nginx/stubstatus/fields.yml

@@ -0,0 +1,45 @@
+- name: nginx-stubstatus
+  type: group
+  description: >
+    `nginx-stubstatus` contains the metrics that were scraped from the ngx_http_stub_status_module status page.
+  fields:
+    - name: hostname
+      type: keyword
+      description: >
+        Nginx hostname
+    - name: active
+      type: integer
+      description: >
+        The current number of active client connections including Waiting connections.
+    - name: accepts
+      type: integer
+      description: >
+        The total number of accepted client connections.
+    - name: handled
+      type: integer
+      description: >
+        The total number of handled client connections.
+    - name: dropped
+      type: integer
+      description: >
+        The total number of dropped client connections.
+    - name: requests
+      type: integer
+      description: >
+        The total number of client requests.
+    - name: current
+      type: integer
+      description: >
+        The current number of client requests.
+    - name: reading
+      type: integer
+      description: >
+        The current number of connections where nginx is reading the request header.
+    - name: writing
+      type: integer
+      description: >
+        The current number of connections where nginx is writing the response back to the client.
+    - name: waiting
+      type: integer
+      description: >
+        The current number of idle client connections waiting for a request.

metricbeat/module/nginx/stubstatus/stubstatus.go

@@ -1,4 +1,4 @@
-// Reads server status from nginx host under /server-status, stub_status module is required.
+// Reads server status from nginx host under /server-status, ngx_http_stub_status_module is required.
 package stubstatus
 
 import (