updated version 1.4.7

Author: Harsh Arora

CHANGELOG.md

@@ -26,3 +26,9 @@ All notable changes to this project will be documented in this file.
 
 ### BugFixes:
  - Error handling modification
+
+
+## [1.4.7] - 2021-01-28
+### Added
+ - Added adc_probe_success metric to indicate successful/Failed scrape
+ - Added new metric "citrixadc_throughput_tx_mbits_rate"

README.md

@@ -100,15 +100,15 @@ For this:
 <summary>Usage as a Container</summary>
 <br>
 
-In order to use the exporter as a container, the image ```quay.io/citrix/citrix-adc-metrics-exporter:1.4.6``` will need to be pulled using;
+In order to use the exporter as a container, the image ```quay.io/citrix/citrix-adc-metrics-exporter:1.4.7``` will need to be pulled using;
 ```
-docker pull quay.io/citrix/citrix-adc-metrics-exporter:1.4.6
+docker pull quay.io/citrix/citrix-adc-metrics-exporter:1.4.7
 ```
 **NOTE:** It can also be build locally using ```docker build -f Dockerfile -t <image_name>:<tag> ./```
 
 Now, the exporter can be run using:
 ```
-docker run -dt -p <host_port>:<container_port> --mount type=bind,source=<host-path-for-config-file>,target=/exporter/config.yaml quay.io/citrix/citrix-adc-metrics-exporter:1.4.6 [flags] --config-file=/exporter/config.yaml
+docker run -dt -p <host_port>:<container_port> --mount type=bind,source=<host-path-for-config-file>,target=/exporter/config.yaml quay.io/citrix/citrix-adc-metrics-exporter:1.4.7 [flags] --config-file=/exporter/config.yaml
 ```
 where the flags are:
 
@@ -131,7 +131,7 @@ flag&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbs
 
 To setup the exporter as given in the diagram, the following command can be used:
 ```
-docker run -dt -p 8888:8888 --mount type=bind,source=/path/to/config.yaml,target=/exporter/config.yaml --name citrix-adc-exporter quay.io/citrix/citrix-adc-metrics-exporter:1.4.6 --target-nsip=10.0.0.1 --port=8888 --config-file=/exporter/config.yaml
+docker run -dt -p 8888:8888 --mount type=bind,source=/path/to/config.yaml,target=/exporter/config.yaml --name citrix-adc-exporter quay.io/citrix/citrix-adc-metrics-exporter:1.4.7 --target-nsip=10.0.0.1 --port=8888 --config-file=/exporter/config.yaml
 ```
 This directs the exporter container to scrape the 10.0.0.1 IP, and the expose the stats it collects on port 8888.
 
@@ -160,7 +160,7 @@ For this:
 Certificate should then be mounted at the '--cacert-path' provided. For instance, if cert is 'cacert.pem' and '--cacert-path' provided in 'config.yaml' is '/exporter/cacert.pem'
 
 ```
-docker run -dt -p 8888:8888 --mount type=bind,source=/path/to/config.yaml,target=/exporter/config.yaml --mount type=bind,source=/path/to/cacert.pem,target=/exporter/cacert.pem --name citrix-adc-exporter quay.io/citrix/citrix-adc-metrics-exporter:1.4.6 --target-nsip=10.0.0.1 --port=8888 --config-file=/exporter/config.yaml
+docker run -dt -p 8888:8888 --mount type=bind,source=/path/to/config.yaml,target=/exporter/config.yaml --mount type=bind,source=/path/to/cacert.pem,target=/exporter/cacert.pem --name citrix-adc-exporter quay.io/citrix/citrix-adc-metrics-exporter:1.4.7 --target-nsip=10.0.0.1 --port=8888 --config-file=/exporter/config.yaml
 ``` 
 **NOTE:** If default port to connect with ADC is not 80/443 for HTTP/HTTPS respectively, then append --target-nsip with port. For instance, if port for ADC is 9080 then use: --target-nsip=10.0.0.1:9080
 
@@ -191,7 +191,7 @@ metadata:
 spec:
   containers:
     - name: exporter
-      image: quay.io/citrix/citrix-adc-metrics-exporter:1.4.6
+      image: quay.io/citrix/citrix-adc-metrics-exporter:1.4.7
       args:
         - "--target-nsip=10.0.0.1"
         - "--port=8888"
@@ -270,7 +270,7 @@ metadata:
 spec:
   containers:
     - name: exporter
-      image: quay.io/citrix/citrix-adc-metrics-exporter:1.4.6
+      image: quay.io/citrix/citrix-adc-metrics-exporter:1.4.7
       args:
         - "--target-nsip=10.0.0.1"
         - "--port=8888"

exporter.py

@@ -267,13 +267,16 @@ def __init__(self, nsip, metrics, username, password, protocol,
     def collect(self):
 
         if self.stats_access_pending or self.ns_session_pending:
+            yield self.populate_probe_status(self.FAILURE)
             return
 
         if not self.login():
+            yield self.populate_probe_status(self.FAILURE)
             return
 
         data = {}
         self.stats_access_pending = True
+        status = self.INVALID
         for entity in self.metrics.keys():
             logger.debug('Collecting metric {}'.format(entity))
             try:
@@ -283,6 +286,7 @@ def collect(self):
 
             if status == self.FAILURE:
                 self.ns_session_clear()
+                yield self.populate_probe_status(status)
                 return
 
             if entity_data:
@@ -298,6 +302,7 @@ def collect(self):
 
             if status == self.FAILURE:
                 self.ns_session_clear()
+                yield self.populate_probe_status(status)
                 return
 
         # Add labels to metrics and provide to Prometheus
@@ -390,6 +395,7 @@ def collect(self):
 
                 yield g
         self.stats_access_pending = False
+        yield self.populate_probe_status(status)
 
     # Function to fire nitro commands and collect data from NS
     def collect_data(self, entity):
@@ -677,6 +683,16 @@ def collect_lbvs_config(self):
             logger.error('Error in fetching lbvs config entries {}'.format(e))
             return self.FAILURE, None
 
+    def populate_probe_status(self, status):
+        label_names = []
+        label_names.append('nsip')
+        g = GaugeMetricFamily("citrixadc_probe_success", "probe_success", labels=label_names)
+        if status == self.FAILURE:
+            g.add_metric([self.nsip], int("0"))
+        else:
+            g.add_metric([self.nsip], int("1"))
+
+        return g
 
 def main():
     parser = argparse.ArgumentParser()

metrics.json

@@ -427,7 +427,8 @@
 
     "ns": {
         "gauges": [
-            ["rxmbitsrate", "citrixadc_throughput_rx_mbits_rate"]
+            ["rxmbitsrate", "citrixadc_throughput_rx_mbits_rate"],
+            ["txmbitsrate", "citrixadc_throughput_tx_mbits_rate"]
         ]
     },
 

version/VERSION

@@ -1 +1 @@
-1.4.6
+1.4.7