Merge pull request #3 from heywood8/testing

Integration testing with amlen-server on github actions

Author: heywood8

.github/workflows/integration.yml

@@ -0,0 +1,29 @@
+name: Integration testing
+
+on: [push]
+
+jobs:
+  build:
+    name: integration-test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python3 -m pip install --upgrade pip
+        pip3 install -r requirements.txt
+    - name: Run exporter
+      run: |
+        /usr/bin/docker run -d -p 9089:9089 heywood8/amlen-server:1.0.0.1-20220622.1025_eclipse
+        /usr/bin/docker ps
+        sleep 10
+        python3 src/amlen_exporter.py --once > exporter_result.txt
+        cat exporter_result.txt
+        if grep Error exporter_result.txt; then exit 1; fi

.github/workflows/pylint.yml

@@ -5,6 +5,7 @@ on: [push]
 jobs:
   build:
     runs-on: ubuntu-latest
+    name: pylint
     strategy:
       matrix:
         python-version: ["3.8", "3.9", "3.10"]

.github/workflows/release.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Set up Python 3.
         uses: actions/setup-python@v4
         with:
-          python-version: '3.9-dev' 
+          python-version: '3.9-dev'
 
       - name: Install requirements.
         run: |
@@ -48,7 +48,7 @@ jobs:
         run: |
           echo $RELEASE_VERSION
           echo ${{ env.RELEASE_VERSION }}
-      
+
       - name: Compress action step
         uses: a7ul/[email protected]
         id: compress
@@ -93,11 +93,6 @@ jobs:
       - name: Set env
         run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
 
-      - name: Test
-        run: |
-          echo $RELEASE_VERSION
-          echo ${{ env.RELEASE_VERSION }}
-      
       - name: Compress action step
         uses: a7ul/[email protected]
         id: compress
@@ -116,4 +111,4 @@ jobs:
           asset_name: amlen_exporter-${{ env.RELEASE_VERSION }}.centos7-amd64.tar.gz
           tag: ${{ github.ref }}
           overwrite: true
-          body: "Release ${{ env.RELEASE_VERSION }}"
+          body: "Release ${{ env.RELEASE_VERSION }}"

README.md

@@ -1,4 +1,5 @@
 # amlen-prometheus-exporter
+
 Amlen (ex Messagesight) Prometheus exporter
 
 ## Installing with Ansible (recommended option)
@@ -27,3 +28,6 @@ sudo systemctl start amlen_exporter
 sudo systemctl enable amlen_exporter
 ```
 
+## Quickstart to run amlen-server (non-persistent)
+
+docker run -p 9089:9089 -d --name imaserver -d heywood8/amlen-server:1.0.0.1-20220622.1025_eclipse

requirements.txt

@@ -3,4 +3,5 @@ anybadge==1.7.0
 prometheus-client==0.8.0
 pyinstaller==3.6
 requests
-charset-normalizer==2.1.0
+charset-normalizer==2.1.0
+argparse==1.4.0

src/amlen_exporter.py

@@ -1,8 +1,8 @@
 ''' Amlen exporter for prometheus '''
-import json
-import sys
-import time
-import requests
+from json import loads
+from time import sleep
+from argparse import ArgumentParser
+from requests import get
 from prometheus_client import start_http_server, Metric, REGISTRY
 
 class JsonServerCollector():
@@ -12,9 +12,9 @@ def __init__(self, endpoint):
     def collect(self):
         ''' Collect metrics'''
         try:
-            response = json.loads(requests.get(self._endpoint, timeout=10).content.decode('UTF-8'))
-        except Exception as ex:
-            print(f'Cannot make a request to {self._endpoint} : {type(ex).__name__}')
+            response = loads(get(self._endpoint, timeout=10).content.decode('UTF-8'))
+        except Exception as unknown_exception:
+            print(f'Error: Cannot request {self._endpoint} : {type(unknown_exception).__name__}')
             return None
 
         metric = Metric('amlen_server_connections',
@@ -79,9 +79,9 @@ def __init__(self, endpoint):
     def collect(self):
         ''' Collect metrics'''
         try:
-            response = json.loads(requests.get(self._endpoint, timeout=10).content.decode('UTF-8'))
-        except Exception as ex:
-            print(f'Cannot make a request to {self._endpoint} : {type(ex).__name__}')
+            response = loads(get(self._endpoint, timeout=10).content.decode('UTF-8'))
+        except Exception as unknown_exception:
+            print(f'Error: Cannot request {self._endpoint} : {type(unknown_exception).__name__}')
             return None
         memory = response['Memory']
         metric = Metric('amlen_memory', 'Memory metrics', 'gauge')
@@ -126,10 +126,10 @@ def collect(self):
         metric = Metric('amlen_subscription_message',
                         'Messages in subscriptions', 'gauge')
         try:
-            response = json.loads(requests.get(self._endpoint, timeout=10, params={})
+            response = loads(get(self._endpoint, timeout=10, params={})
                                 .content.decode('UTF-8'))
-        except Exception as ex:
-            print(f'Cannot make a request to {self._endpoint} : {type(ex).__name__}')
+        except Exception as unknown_exception:
+            print(f'Error: Cannot request {self._endpoint} : {type(unknown_exception).__name__}')
             return None
         # Response example: { "Version":"v1", "Subscription":
         # [{"SubName":"DemoSubscription","TopicString":"DemoTopic",
@@ -172,8 +172,8 @@ def collect(self):
             yield metric
         except KeyError:
             print('Error collecting Subscription data: No Subscription key')
-        except Exception as ex:
-            print(f'Cannot create subscription metrics: {type(ex).__name__}')
+        except Exception as unknown_exception:
+            print(f'Error: Cannot create subscription metrics: {type(unknown_exception).__name__}')
         return None
 
 class JsonEndpointCollector():
@@ -185,7 +185,7 @@ def collect(self):
 
         try:
             params = {'StatType':'ReadMsgs', 'SubType':'History', 'Duration':6}
-            response = json.loads(requests.get(self._endpoint, timeout=10, params=params)
+            response = loads(get(self._endpoint, timeout=10, params=params)
                                   .content.decode('UTF-8'))
             metric = Metric('amlen_endpoint_message_rate',
                             'Messages per second', 'gauge')
@@ -195,7 +195,7 @@ def collect(self):
             metric.add_sample('amlen_endpoint_message_rate_incoming', {}, msg_rate)
             yield metric
 
-            response = json.loads(requests.get(self._endpoint, timeout=10).content.decode('UTF-8'))
+            response = loads(get(self._endpoint, timeout=10).content.decode('UTF-8'))
             endpoints = response['Endpoint']
 
             metric = Metric('amlen_endpoint', 'Endpoint counters', 'counter')
@@ -236,9 +236,9 @@ def collect(self):
             #yield metric
 
         except KeyError as keyerr:
-            print(f'Error collecting Endpoint data: No Endpoint key {keyerr}')
-        except Exception as ex:
-            print(f'Cannot make a request to {self._endpoint} : {type(ex).__name__}')
+            print(f'Error: collecting Endpoint data: No Endpoint key {keyerr}')
+        except Exception as unknown_exception:
+            print(f'Error: Cannot request {self._endpoint} : {type(unknown_exception).__name__}')
 
 
 class JsonInfoCollector():
@@ -248,10 +248,10 @@ def __init__(self, endpoint):
     def collect(self):
         ''' Collect metrics'''
         try:
-            response = json.loads(requests.get(self._endpoint, timeout=10)
+            response = loads(get(self._endpoint, timeout=10)
                               .content.decode('UTF-8'))
-        except Exception as ex:
-            print(f'Cannot make a request to {self._endpoint} : {type(ex).__name__}')
+        except Exception as unknown_exception:
+            print(f'Error: Cannot request {self._endpoint} : {type(unknown_exception).__name__}')
             return None
         metric = Metric('amlen_info', 'Status metrics counters', 'info')
         try:
@@ -275,14 +275,32 @@ def collect(self):
         yield metric
         return None
 
-
 if __name__ == '__main__':
     # Usage: json_exporter.py port endpoint
-    start_http_server(int(sys.argv[1]))
-    REGISTRY.register(JsonServerCollector(sys.argv[2]))
-    REGISTRY.register(JsonMemoryCollector(sys.argv[2]))
-    REGISTRY.register(JsonEndpointCollector(sys.argv[2]))
-    REGISTRY.register(JsonSubscriptionCollector(sys.argv[2]))
-    REGISTRY.register(JsonInfoCollector(sys.argv[2]))
-    while True:
-        time.sleep(1)
+    parser = ArgumentParser(description='Amlen Prometheus exporter')
+    parser.add_argument('port', type=int, nargs='?',
+                   default=9672,
+                   help='This exporters\' port. Default: 9672')
+    parser.add_argument('amlen_address', type=str, nargs='?',
+                   default='localhost:9089',
+                   help='Address of Amlen server. Default: localhost:9089')
+    parser.add_argument('--once', nargs='?', const=True, default=False,
+                   help='Run once instead of running server')
+    args = parser.parse_args()
+    start_http_server(args.port)
+    REGISTRY.register(JsonServerCollector(args.amlen_address))
+    REGISTRY.register(JsonMemoryCollector(args.amlen_address))
+    REGISTRY.register(JsonEndpointCollector(args.amlen_address))
+    REGISTRY.register(JsonSubscriptionCollector(args.amlen_address))
+    REGISTRY.register(JsonInfoCollector(args.amlen_address))
+    try:
+        selfrequest = get(f'http://localhost:{args.port}'
+                          , timeout=10).content.decode('UTF-8')
+    except Exception as ex:
+        print(f'Error: Cannot request localhost:{args.port} : {type(ex).__name__}')
+
+    if args.once:
+        print(selfrequest)
+
+    while not args.once:
+        sleep(1)