RDK-57197: Add Analytics sendEvent.appId and update documentation (#280)

Author: adrianM27

apis/Analytics/IAnalytics.h

@@ -43,6 +43,7 @@ namespace Exchange {
         // @param cetList: List of CETs
         // @param epochTimestamp: Epoch timestamp of the event
         // @param uptimeTimestamp: Uptime timestamp of the event
+        // @param appId: Durable App Id string
         // @param eventPayload: Payload of the event
 
         virtual Core::hresult SendEvent(const string& eventName /* @in */,
@@ -52,6 +53,7 @@ namespace Exchange {
                                    IStringIterator* const& cetList /* @in */,
                                    const uint64_t epochTimestamp /* @in */,
                                    const uint64_t uptimeTimestamp /* @in */,
+                                   const string& appId /* @in */,
                                    const string& eventPayload /* @in */ ) = 0;
     };
 }

docs/apis/AnalyticsPlugin.md

@@ -36,6 +36,11 @@ The table below lists configuration options of the plugin.
 | classname | string | Class name: *org.rdk.Analytics* |
 | locator | string | Library name: *libWPEFrameworkAnalytics.so* |
 | autostart | boolean | Determines if the plugin shall be started automatically along with the framework |
+| configuration | object |  |
+| configuration.loggername | string | Logger name used by backend |
+| configuration.loggerversion | string | Logger version used by backend |
+| configuration?.eventsmap | string | <sup>*(optional)*</sup> Optional path to json file with array of mapped events name |
+| configuration.backendlib | string | Name of backend library |
 
 <a name="Methods"></a>
 # Methods
@@ -46,13 +51,13 @@ Analytics interface methods:
 
 | Method | Description |
 | :-------- | :-------- |
-| [sendEvent](#sendEvent) | Send event |
+| [sendEvent](#sendEvent) | Enqueue an event to be sent to the SIFT analytics backend |
 
 
 <a name="sendEvent"></a>
 ## *sendEvent*
 
-Send 
+Enqueue an event to be sent to the SIFT analytics backend.
 
 ### Events
 
@@ -71,4 +76,50 @@ No Events
 | params.cetList[#] | string |  |
 | params?.epochTimestamp | integer | <sup>*(optional)*</sup> Timestamp for the START of this event, epoch time, in ms UTC |
 | params?.uptimeTimestamp | integer | <sup>*(optional)*</sup> Timestamp for the START of this event, uptime of the device, in ms. ONLY to be used when Time quality is not good |
-| params.eventPayload | object | The payload of the event |
+| params?.appId | string | <sup>*(optional)*</sup> Durable App ID string |
+| params.eventPayload | object | Custom payload of the event in JSON format. User defined colection of objects and keys. May be an empty object |
+| params.eventPayload.keyOrObject | string | User defined custom key or object |
+
+### Result
+
+| Name | Type | Description |
+| :-------- | :-------- | :-------- |
+| result | string | On success null will be returned |
+
+### Example
+
+#### Request
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 42,
+    "method": "org.rdk.Analytics.sendEvent",
+    "params": {
+        "eventName": "app_summary",
+        "eventVersion": "1.0.0",
+        "eventSource": "epg",
+        "eventSourceVersion": "1.0.0",
+        "cetList": [
+            "cet1"
+        ],
+        "epochTimestamp": 1721906631000,
+        "uptimeTimestamp": 35000,
+        "appId": "app-id-app1",
+        "eventPayload": {
+            "keyOrObject": "value1"
+        }
+    }
+}
+```
+
+#### Response
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 42,
+    "result": "null"
+}
+```
+

tools/json_generator/output/Analytics/Analytics.json

@@ -4,7 +4,7 @@
     "info": {
         "title": "Analytics API",
         "class": "Analytics",
-        "description": "The `Analytics` plugin allows sending analytics events to dedicated backends."
+        "description": "The `Analytics` plugin allows sending analytics events to dedicated backends. Currently the SIFT backend is supported."
     },
     "common": {
         "$ref": "../common/common.json"
@@ -48,18 +48,26 @@
             "type": "integer",
             "example": 35000
         },
+        "appId":{
+            "summary": "Durable App ID string",
+            "type": "string",
+            "example": "app-id-app1"
+        },
         "eventPayload":{
-            "summary": "The payload of the event",
+            "summary": "Custom payload of the event in JSON format. User defined colection of objects and keys. May be an empty object",
             "type": "object",
-            "example": {
-                "key1": "value1",
-                "key2": "value2"
+            "properties": {
+                "keyOrObject": {
+                    "summary": "User defined custom key or object",
+                    "type": "string",
+                    "example": "value1"
+                }
             }
         }
     },
     "methods": {
         "sendEvent":{
-            "summary": "Send event",
+            "summary": "Enqueue an event to be sent to the SIFT analytics backend",
             "params": {
                 "type":"object",
                 "properties": {
@@ -84,6 +92,9 @@
                     "uptimeTimestamp":{
                         "$ref": "#/definitions/uptimeTimestamp"
                     },
+                    "appId":{
+                        "$ref": "#/definitions/appId"
+                    },
                     "eventPayload":{
                         "$ref": "#/definitions/eventPayload"
                     }
@@ -97,7 +108,9 @@
                 ]
             },
             "result": {
-                "$ref": "#/common/result"
+                "summary": "On success null will be returned",
+                "type": "string",
+                "example": "null"
             }
         }
     }

tools/json_generator/output/Analytics/AnalyticsPlugin.json

@@ -1,13 +1,47 @@
 {
-    "$schema": "https://raw.githubusercontent.com/rdkcentral/rdkservices/main/Tools/json_generator/schemas/plugin.schema.json",
-    "info": {
-      "title": "Analytics Plugin",
-      "callsign": "org.rdk.Analytics",
-      "locator": "libWPEFrameworkAnalytics.so",
-      "status": "development",
-      "description": "The `Analytics` plugin allows to send analytics events to dedicated backends."
-    },
-    "interface": {
-      "$ref": "Analytics.json#"
-    }
+  "$schema":"https://raw.githubusercontent.com/rdkcentral/rdkservices/main/Tools/json_generator/schemas/plugin.schema.json",
+  "info":{
+     "title":"Analytics Plugin",
+     "callsign":"org.rdk.Analytics",
+     "locator":"libWPEFrameworkAnalytics.so",
+     "status":"development",
+     "description":"The `Analytics` plugin allows to send analytics events to dedicated backends"
+  },
+  "configuration":{
+     "type":"object",
+     "properties":{
+        "configuration":{
+           "type":"object",
+           "properties":{
+              "loggername":{
+                 "description":"Logger name used by backend",
+                 "type":"string"
+              },
+              "loggerversion":{
+                 "description":"Logger version used by backend",
+                 "type":"string"
+              },
+              "eventsmap":{
+               "description":"Optional path to json file with array of mapped events name",
+               "type":"string"
+              },
+              "backendlib":{
+               "description":"Name of backend library",
+               "type":"string"
+              }
+           },
+           "required":[
+              "loggername",
+              "loggerversion",
+              "backendlib"
+           ]
+        }
+     },
+     "required":[
+        "configuration"
+     ]
+  },
+  "interface":{
+     "$ref":"Analytics.json#"
+  }
 }