Code-Clean-Up and documentation

Author: Chris Wiechmann

.github/workflows/traffic-monitor-api.yml

@@ -21,7 +21,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x]
+        node-version: [12.x]
 
     steps:
     - uses: actions/checkout@v2

README.md

@@ -16,6 +16,8 @@ Once the data is indexed by Elasticsearch it can be used by different clients. T
 ## Option 1 - Using the existing Traffic-Monitor
 One option is to use the existing API-Gateway Traffic-Monitor. That means, you use the same tooling as of today, but the underlying implementation of the Traffic-Monitor API is now pointing to Elasticsearch instead of the internal OPSDB hosted by each API-Gateway instance. This improves performance damatically, as Elasticsearch can scale across multiple machines if required and other dashboards can be created for instance with Kibana.  
 The glue between Elasticsearch and the API-Gateway Traffic-Monitor is an API-Builder project, that is exposing the same Traffic-Monitor API, but it is implemented using Elasticsearch instead of the OPSDB. The API-Builder is available as a ready to use Docker-Image and preconfigured in the docker-compose file.  
+Optionally you can import the API-Builder API into your API-Management system to apply additional security and by that secure access to your Elasticsearch instance.  
+
 Finally, the Admin-Node-Manager has to be configured to use the API-Builder API instead of the internal implementation.
 
 API-Builder exposing Traffic-Monitor API:  
@@ -108,11 +110,15 @@ docker-compose up -d
 ````
 Of course, the components can also run on different machines or on a Docker-Orchestration framework such as Kubernetes.
 
-## Stop cluster
+### Stop cluster
 ````
 docker-compose down
 ````
 
+### Import API-Builder Traffic-Monitor API
+To secure access to your Elasticsearch instance you can import the API Builder REST-API into your API-Manager. You can access the Swagger/OpenAPI definition here:  
+http://docker-host:8889/apidoc/swagger.json?endpoints/trafficMonitorApi
+
 ## Troubleshooting
 #### Check processes/containers are running
 From within the folder where the docker-compose.yml file is located execute: 

elk-traffic-monitor-api/apis/testapi.js

@@ -1,8 +1,16 @@
 {
   "swagger": "2.0",
   "info": {
-    "title": "Monitoring API API",
-    "version": "1.0"
+    "title": "Traffic Monitor API",
+    "version": "1.0",
+    "description": "This API is defining a subset of the Axway API-Gateway Admin-Node-Manager API ([Official Docs](http://apidocs.axway.com/swagger-ui/index.html?productname=apigateway&productversion=7.7.0&filename=api-gateway-swagger.json)) with the purpose to replace the implementation with an Elasticsearch datasource instead of the API-Gateway internal OPSDB.",
+    "license": {
+      "name": "Apache 2.0"
+    },
+    "contact": {
+      "name": "Chris Wiechmann",
+      "email": "[email protected]"
+    }
   },
   "host": "example.com",
   "paths": {
@@ -54,9 +62,11 @@
             "type": "string"
           }
         ],
-        "x-flow": "monitoringApiApi-getRouterServiceOpsSearchByServiceID"
+        "summary": "Seach requests to build Traffic-Overview table",
+        "description": "This endpoint is used by the API-Gateway Traffic-Monitor to search for processed requests and create the Requests-Table.",
+        "operationId": "search",
+        "x-flow": "trafficMonitorApi-search"
       },
-      "x-flow": "monitoringApiApi-getRouterServiceOpsSearchByServiceID",
       "parameters": [
         {
           "name": "serviceID",
@@ -65,33 +75,6 @@
           "required": true
         }
       ]
-    },
-    "/router/service/{serviceID}/ops/stream/{correlationId}/*circuitpath": {
-      "get": {
-        "responses": {
-          "200": {
-            "description": "",
-            "schema": {
-              "type": "object",
-              "properties": {}
-            }
-          }
-        }
-      },
-      "parameters": [
-        {
-          "name": "serviceID",
-          "in": "path",
-          "type": "string",
-          "required": true
-        },
-        {
-          "name": "correlationId",
-          "in": "path",
-          "type": "string",
-          "required": true
-        }
-      ]
     }
   },
   "basePath": "/elk/v1/api"