Merge pull request #61 from telefonicaid/task/common_metrics_api

Task/common metrics api

ChangeLog

@@ -3,7 +3,8 @@ CHANGES
 
 1.5.0
 
-FEATURE: Support keystone groups in a Service, including role assignments
+FEATURE: Metrics API [#58]
+FEATURE: Support keystone groups in a Service, including role assignments [#56]
 
 
 1.4.2

README.md

@@ -21,7 +21,7 @@ A tipical scenario for IoT Platform can be [scenario_test](https://pdihub.hi.ine
 - Assign/unassign roles to users in a service
 - Create/List Trust Tokens
 - Activate / deactivate IoT Modules
-- Retrieve statistics about API usage
+- Retrieve statistics and metrics about API usage
 
 Orchestrator is based mainly on:
 - Python

apiary.apib

@@ -977,3 +977,83 @@ In the cases where "serviceId" is part of URL "SERVICE_NAME" field at body can b
       {
          "level": "DEBUG"
       }
+
+## Metrics [/v1.0/admin/metrics]
+
+The following metrics are collected by the component:
++ incomingTransactions: number of requests consumed by the component.
++ incomingTransactionRequestSize: total size (bytes) in requests associated to incoming transactions
++ incomingTransactionResponseSize: total size (bytes) in responses associated to incoming transactions
++ incomingTransacionError: number of incoming transactions resulting in error.
++ serviceTime: average time to serve a transaction.
+
+### Get current metrics [GET]
+
++ Parameters
+  + reset (optional, `string`) ... ["true", "false"]
++ Response 200 (application/json)
+    + Body
+       {
+          "service": {
+            "service1": {
+                "subservs": {
+                    "subserv1": {},
+                    "subserv2": {}
+                },
+                "sum": {}
+            },
+            "service2": {
+               "subservs": {
+                   "subserv1": {},
+                   "subserv2": {}
+                },
+                "sum": {}
+            }
+          },
+          "sum": {
+            "incomingTransactions": 25,
+            "incomingTransactionRequestSize": 3456,
+            "incomingTransactionResponseSize": 435,
+            "incomingTransacionError": 2,
+            "serviceTime": 0.48,
+            "outgoingTransactions": 46,
+            "outgoingTransactionRequestSize": 323361,
+            "outgoingTransactionResponseSize": 2343,
+            "outgoingTransacionError": 10
+          }
+       }
+
+
+### Reset current metrics [DELETE]
++ Parameters
++ Response 204 (application/json)
+    + Body
+       {
+          "service": {
+            "service1": {
+                "subservs": {
+                    "subserv1": {},
+                    "subserv2": {}
+                },
+                "sum": {}
+            },
+            "service2": {
+               "subservs": {
+                   "subserv1": {},
+                   "subserv2": {}
+                },
+                "sum": {}
+            }
+          },
+          "sum": {
+            "incomingTransactions": 25,
+            "incomingTransactionRequestSize": 3456,
+            "incomingTransactionResponseSize": 435,
+            "incomingTransacionError": 2,
+            "serviceTime": 0.48,
+            "outgoingTransactions": 46,
+            "outgoingTransactionRequestSize": 323361,
+            "outgoingTransactionResponseSize": 2343,
+            "outgoingTransacionError": 10
+          }
+       }

src/orchestrator/api/urls.py

@@ -42,7 +42,8 @@
                                     SubServiceIoTAService_RESTView,
                                     IOTModuleActivation_RESTView,
                                     OrchVersion_RESTView,
-                                    OrchLogLevel_RESTView
+                                    OrchLogLevel_RESTView,
+                                    OrchMetrics_RESTView
                                     )
 
 
@@ -69,4 +70,5 @@
      url(r'^service/(?P<service_id>\w+)/trust[/]?$', Trust_RESTView.as_view(), name='new_trust_rest_view'),
      url(r'^version[/]?$', OrchVersion_RESTView.as_view(), name='orch_version_rest_view'),
      url(r'^admin/log?$', OrchLogLevel_RESTView.as_view(), name='orch_loglevel_rest_view'),
+     url(r'^admin/metrics?$', OrchMetrics_RESTView.as_view(), name='orch_metrics_rest_view'),
 )