new SSLverver metrics

Author: aroraharsh23

Dockerfile

@@ -1,7 +1,7 @@
 FROM alpine:latest
 RUN apk update
 RUN apk add python py-pip
-RUN apk add curl
+RUN apk add curl iputils
 RUN pip install prometheus_client requests pyyaml retrying
 COPY version/VERSION /exporter/
 COPY exporter.py /exporter/

README.md

@@ -86,15 +86,15 @@ In config.yaml, '--validate-cert' option should be set to 'yes', and certificate
 <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.3``` 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.4``` will need to be pulled using;
 ```
-docker pull quay.io/citrix/citrix-adc-metrics-exporter:1.4.3
+docker pull quay.io/citrix/citrix-adc-metrics-exporter:1.4.4
 ```
 **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.3 [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.4 [flags] --config-file=/exporter/config.yaml
 ```
 where the flags are:
 
@@ -117,7 +117,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.3 --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.4 --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.
 
@@ -139,7 +139,7 @@ In config.yaml, '--validate-cert' option should be set to 'yes', and certificate
 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.3 --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.4 --target-nsip=10.0.0.1 --port=8888 --config-file=/exporter/config.yaml
 ``` 
 Cert validation options can also be provided using environment variables using NS_VALIDATE_CERT, NS_CACERT_PATH. Thoughconfig file input is the preferred method.
 
@@ -168,7 +168,7 @@ metadata:
 spec:
   containers:
     - name: exporter
-      image: quay.io/citrix/citrix-adc-metrics-exporter:1.4.3
+      image: quay.io/citrix/citrix-adc-metrics-exporter:1.4.4
       args:
         - "--target-nsip=10.0.0.1"
         - "--port=8888"
@@ -241,7 +241,7 @@ metadata:
 spec:
   containers:
     - name: exporter
-      image: quay.io/citrix/citrix-adc-metrics-exporter:1.4.3
+      image: quay.io/citrix/citrix-adc-metrics-exporter:1.4.4
       args:
         - "--target-nsip=10.0.0.1"
         - "--port=8888"
@@ -329,6 +329,10 @@ Sl. No. |     STATS                 | NS nitro name
 8       | Service stats             | "service"
 9       | Service group stats       | "services"
 10      | Bandwidth Capacity stats  | "nscapacity"
+11      | SSL vserver stats         | "sslvserver"
+12      | System info stats         | "system"
+13      | System cpu stats          | "systemcpu"
+14      | aaa stats                 | "aaa"
 
 
 Exporting Additional Stats which are not Included by Default:

exporter.py

@@ -292,13 +292,17 @@ def __init__(self, nsip, metrics, username, password, protocol,
         self.k8s_cic_prefix = k8s_cic_prefix
         self.ns_cert = ns_cert
         self.ns_session = requests.Session()
+        self.current_session = False
 
     # Collect metrics from Citrix ADC
     def collect(self):
         nsip = self.nsip
         data = {}
-        self.ns_session_login()
 
+        if self.current_session:
+            return
+
+        self.ns_session_login()
         for entity in self.metrics.keys():
             logger.info('Collecting metric %s for %s' % (entity, nsip))
             try:
@@ -425,15 +429,19 @@ def get_svc_grp_services_stats(self):
         if servicegroup_list_ds:
             servicegroup_data = []
             for servicegroups_ds in servicegroup_list_ds['servicegroup']:
-                _manual_servicegroup_name = servicegroups_ds['servicegroupname']
-                url = '%s://%s/nitro/v1/stat/servicegroup/%s?statbindings=yes' % (self.protocol, self.nsip, _manual_servicegroup_name)
+                _servicegroup_name = servicegroups_ds['servicegroupname']
+                url = '%s://%s/nitro/v1/stat/servicegroup/%s?statbindings=yes' % (self.protocol, self.nsip, _servicegroup_name)
                 data_tmp = self.get_entity_stat(url)
                 if data_tmp:
                     if 'servicegroupmember' in data_tmp['servicegroup'][0]:
                     # create a list with stats of all services bound to NS of all servicegroups
                         for individual_svc_binding_data in data_tmp['servicegroup'][0]['servicegroupmember']:
                             # manually adding stats of a particular service
-                            individual_svc_binding_data['_manual_servicegroup_name'] = _manual_servicegroup_name
+                            individual_svc_binding_data['_servicegroup_name'] = _servicegroup_name
+                            svcgroupname = individual_svc_binding_data['servicegroupname']
+                            if svcgroupname.find('?'):
+                                servername = svcgroupname.split('?')[1]
+                            individual_svc_binding_data['server_name'] = servername
                             servicegroup_data.append(individual_svc_binding_data)
             return servicegroup_data
 
@@ -521,6 +529,7 @@ def ns_session_login(self):
                 if data['errorcode'] == 0 :
                     logger.info("ADC Session Login Successful")
                     ns_login = True
+                    self.current_session = True
                 else:
                     logger.error("ADC Session Login Failed")
             except requests.exceptions.RequestException as err:
@@ -543,6 +552,7 @@ def ns_session_logout(self):
                 if response.status_code == 201 or response.status_code == 200:
                      ns_logout = True
                      self.ns_session.close()
+                     self.current_session = False
                      logger.info("ADC Session Logout Successful")
                      break
                 else:
@@ -598,7 +608,7 @@ def ns_session_logout(self):
 
     # Get cert validation args provided 
     ns_cert = get_cert_validation_args(args, ns_protocol) 
-       
+
     requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
     requests.packages.urllib3.disable_warnings(SubjectAltNameWarning)
 

metrics.json

@@ -209,10 +209,11 @@
         ],
 
         "labels": [
-            ["_manual_servicegroup_name", "citrixadc_servicegroup_name"],
+            ["_servicegroup_name", "citrixadc_servicegroup_name"],
             ["servicetype", "citrixadc_service_type"],
             ["state", "citrixadc_service_state"],
-            ["primaryipaddress", "citrixadc_service_ip"]
+            ["primaryipaddress", "citrixadc_service_ip"],
+            ["server_name", "citrixadc_server_name"]
         ]
     },
 
@@ -523,5 +524,38 @@
             ["type", "citrixadc_k8s_ing_lb_type"],
             ["state", "citrixadc_k8s_ing_lb_state"]
         ]
+    },
+
+     "sslvserver": {
+        "counters": [
+            ["sslctxtotdecbytes", "citrixadc_sslvserver_decrypt_bytes_total"],
+            ["sslctxtotencbytes", "citrixadc_sslvserver_encrypt_bytes_total"],
+            ["sslctxtothwdec_bytes", "citrixadc_sslvserver_decrypt_hardware_bytes_total"],
+            ["sslctxtothwencbytes", "citrixadc_sslvserver_encrypt_hardware_bytes_total"],
+            ["sslctxtotsessionnew", "citrixadc_sslvserver_session_new_total"],
+            ["sslctxtotsessionhits", "citrixadc_sslvserver_session_hits_total"],
+            ["ssltotclientauthsuccess", "citrixadc_sslvserver_auth_success_total"],
+            ["ssltotclientauthfailure", "citrixadc_sslvserver_auth_failure_total"]
+        ],
+
+        "gauges": [
+            ["vslbhealth", "citrixadc_sslvserver_health"],
+            ["actsvcs", "citrixadc_sslvserver_active_services"],
+            ["sslclientauthsuccessrate", "citrixadc_sslvserver_auth_success_rate"],
+            ["sslclientauthfailurerate", "citrixadc_sslvserver_auth_failure_rate"],
+            ["sslctxencbytesrate", "citrixadc_sslvserver_encrypt_bytes_rate"],
+            ["sslctxdecbytesrate", "citrixadc_sslvserver_decrypt_bytes_rate"],
+            ["sslctxhwencbytesrate", "citrixadc_sslvserver_hw_encrypt_bytes_rate"],
+            ["sslctxhwdec_bytesrate", "citrixadc_sslvserver_hw_decrypt_bytes_rate"],
+            ["sslctxsessionnewrate", "citrixadc_sslvserver_session_new_rate"],
+            ["sslctxsessionhitsrate", "citrixadc_sslvserver_session_hits_rate"]
+        ],
+
+        "labels": [
+            ["vservername", "citrixadc_sslvserver_name"],
+            ["type", "citrixadc_sslvserver_type"],
+            ["primaryipaddress", "citrixadc_sslvserver_ip"],
+            ["state", "citrixadc_sslvserver_state"]
+        ]
     }
 }