Add support for NGINX Plus versions 4-7

nginx/assets/configuration/spec.yaml

@@ -46,7 +46,7 @@ files:
         example: false
         display_default: true
     - name: plus_api_version
-      description: Specify the version of the Plus API to use. The check supports versions 1-3.
+      description: Specify the version of the Plus API to use. The check supports versions 1-7.
       value:
         type: integer
         display_default: 2

nginx/datadog_checks/nginx/data/conf.yaml.example

@@ -78,7 +78,7 @@ instances:
     # use_plus_api_stream: false
 
     ## @param plus_api_version - integer - optional - default: 2
-    ## Specify the version of the Plus API to use. The check supports versions 1-3.
+    ## Specify the version of the Plus API to use. The check supports versions 1-7.
     #
     # plus_api_version: <PLUS_API_VERSION>
 

nginx/datadog_checks/nginx/metrics.py

@@ -34,6 +34,8 @@
     'nginx.upstream.down': 'nginx.upstream.peers.health_checks.last_passed',
 }
 
+# NGNINX Plus metrics that are sent as both a count and gauge for backwards compatibility
+# The count metrics with have _count appended to their names
 METRICS_SEND_AS_COUNT = [
     'nginx.upstream.peers.responses.1xx',
     'nginx.upstream.peers.responses.2xx',
@@ -98,6 +100,7 @@
     'nginx.stream.upstream.peers.received',
     'nginx.stream.upstream.peers.sent',
     'nginx.stream.upstream.peers.unavail',
+    'nginx.stream.zone_sync.zone.records_total',
     'nginx.upstream.peers.fails',
     'nginx.upstream.peers.health_checks.checks',
     'nginx.upstream.peers.health_checks.fails',
@@ -106,3 +109,45 @@
     'nginx.upstream.peers.responses.total',
     'nginx.upstream.peers.unavail',
 ]
+
+
+# NGNINX Plus metrics that are sent as only a count.
+# These metrics will not have _count appended to their names
+COUNT_METRICS = [
+    'nginx.location_zone.responses.total',
+    'nginx.location_zone.discarded',
+    'nginx.location_zone.received',
+    'nginx.location_zone.requests',
+    'nginx.location_zone.responses.1xx',
+    'nginx.location_zone.responses.2xx',
+    'nginx.location_zone.responses.3xx',
+    'nginx.location_zone.responses.4xx',
+    'nginx.location_zone.responses.5xx',
+    'nginx.location_zone.responses.code',
+    'nginx.location_zone.responses.total',
+    'nginx.location_zone.sent',
+    'nginx.resolver.requests.addr',
+    'nginx.resolver.requests.name',
+    'nginx.resolver.requests.srv',
+    'nginx.resolver.responses.formerr',
+    'nginx.resolver.responses.noerror',
+    'nginx.resolver.responses.notimp',
+    'nginx.resolver.responses.nxdomain',
+    'nginx.resolver.responses.refused',
+    'nginx.resolver.responses.servfail',
+    'nginx.resolver.responses.timedout',
+    'nginx.resolver.responses.unknown',
+    'nginx.limit_req.delayed_dry_run',
+    'nginx.limit_req.delayed',
+    'nginx.limit_req.passed',
+    'nginx.limit_req.rejected_dry_run',
+    'nginx.limit_req.rejected',
+    'nginx.limit_conn.passed',
+    'nginx.limit_conn.rejected',
+    'nginx.limit_conn.rejected_dry_run',
+    'nginx.stream.limit_conn.passed',
+    'nginx.stream.limit_conn.rejected',
+    'nginx.stream.limit_conn.rejected_dry_run',
+    'nginx.server_zone.responses.code',
+    'nginx.upstream.peers.responses.code',
+]

nginx/datadog_checks/nginx/nginx.py

@@ -12,7 +12,7 @@
 from datadog_checks.base import AgentCheck, ConfigurationError, to_native_string
 from datadog_checks.base.utils.time import get_timestamp
 
-from .metrics import METRICS_SEND_AS_COUNT, VTS_METRIC_MAP
+from .metrics import COUNT_METRICS, METRICS_SEND_AS_COUNT, VTS_METRIC_MAP
 
 if PY3:
     long = int
@@ -48,14 +48,33 @@ def fromisoformat(ts):
     "stream/zone_sync": ["stream", "zone_sync"],
 }
 
+PLUS_API_V6_STREAM_ENDPOINTS = {
+    "stream/limit_conns": ["stream", "limit_conns"],
+}
+
+PLUS_API_V5_ENDPOINTS = {
+    "http/location_zones": ["location_zones"],
+    "resolvers": ["resolvers"],
+}
+
+PLUS_API_V6_ENDPOINTS = {
+    "http/limit_reqs": ["limit_reqs"],
+    "http/limit_conns": ["limit_conns"],
+}
+
 TAGGED_KEYS = {
     'caches': 'cache',
+    'codes': 'code',
+    'limit_conns': 'limit_conn',
+    'limit_reqs': 'limit_req',
+    'location_zones': 'location_zone',
+    'resolvers': 'resolver',
     'server_zones': 'server_zone',
     'serverZones': 'server_zone',  # VTS
-    'upstreams': 'upstream',
-    'upstreamZones': 'upstream',  # VTS
     'slabs': 'slab',
     'slots': 'slot',
+    'upstreams': 'upstream',
+    'upstreamZones': 'upstream',  # VTS
     'zones': 'zone',
 }
 
@@ -111,7 +130,11 @@ def check(self, _):
             # since we can't get everything in one place anymore.
 
             if self.use_plus_api_stream:
-                plus_api_chain_list = chain(iteritems(PLUS_API_ENDPOINTS), self._get_plus_api_stream_endpoints())
+                plus_api_chain_list = chain(
+                    self._get_plus_api_endpoints(),
+                    self._get_plus_api_stream_endpoints(),
+                )
+
             else:
                 plus_api_chain_list = chain(iteritems(PLUS_API_ENDPOINTS))
 
@@ -158,11 +181,16 @@ def check(self, _):
                     if name is None:
                         continue
 
-                if name in METRICS_SEND_AS_COUNT:
+                if name in COUNT_METRICS:
                     func_count = funcs['count']
-                    func_count(name + "_count", value, tags)
-                func = funcs[metric_type]
-                func(name, value, tags)
+                    func_count(name, value, tags)
+                else:
+                    if name in METRICS_SEND_AS_COUNT:
+                        func_count = funcs['count']
+                        func_count(name + "_count", value, tags)
+
+                    func = funcs[metric_type]
+                    func(name, value, tags)
 
             except Exception as e:
                 self.log.error('Could not submit metric: %s: %s', repr(row), e)
@@ -205,10 +233,21 @@ def _nest_payload(self, keys, payload):
 
         return {keys[0]: self._nest_payload(keys[1:], payload)}
 
+    def _get_plus_api_endpoints(self):
+        endpoints = iteritems(PLUS_API_ENDPOINTS)
+
+        if int(self.plus_api_version) >= 5:
+            endpoints = chain(endpoints, iteritems(PLUS_API_V5_ENDPOINTS))
+        if int(self.plus_api_version) >= 6:
+            endpoints = chain(endpoints, iteritems(PLUS_API_V6_ENDPOINTS))
+        return endpoints
+
     def _get_plus_api_stream_endpoints(self):
         endpoints = iteritems(PLUS_API_STREAM_ENDPOINTS)
         if int(self.plus_api_version) >= 3:
             endpoints = chain(endpoints, iteritems(PLUS_API_V3_STREAM_ENDPOINTS))
+        if int(self.plus_api_version) >= 6:
+            endpoints = chain(endpoints, iteritems(PLUS_API_V6_STREAM_ENDPOINTS))
         return endpoints
 
     def _get_plus_api_data(self, endpoint, nest):
@@ -297,7 +336,6 @@ def _flatten_json(cls, metric_base, val, tags):
         Recursively flattens the nginx json object. Returns the following: [(metric_name, value, tags)]
         """
         output = []
-
         if isinstance(val, dict):
             # Pull out the server as a tag instead of trying to read as a metric
             if 'server' in val and val['server']: