RDK-57197: Analytics backend as ext dynamic lib (#6306) (#6325)

* RDK-57197: Analytics backend as an external lib

* RDK-57197: Analytics align L2 tests

* RDK-57197: Analytics update documentation

Author: adrianM27

.github/workflows/L2-tests-R4-4-1.yml

@@ -280,11 +280,7 @@ jobs:
           -DRDK_SERVICE_L2_TEST=ON
           -DDS_FOUND=ON
           -DPLUGIN_ANALYTICS=ON
-          -DPLUGIN_ANALYTICS_SIFT_BACKEND=ON
-          -DPLUGIN_ANALYTICS_SIFT_2_0_ENABLED="true"
-          -DPLUGIN_ANALYTICS_SIFT_MAX_RANDOMISATION_WINDOW_TIME=15
-          -DPLUGIN_ANALYTICS_SIFT_STORE_PATH="/tmp/AnalyticsSiftStore"
-          -DPLUGIN_ANALYTICS_SIFT_URL="127.0.0.1:12345"
+          -DPLUGIN_ANALYTICS_BACKEND_LIBRARY_NAME="libWPEFrameworkAnalyticsBackendMock.so"
           -DPLUGIN_ANALYTICS_EVENTS_MAP="/tmp/AnalyticsEventsMap.json"
           &&
           cmake --build build/rdkservices -j8

Analytics/Analytics.conf.in

@@ -5,25 +5,8 @@ startuporder = "@PLUGIN_ANALYTICS_STARTUPORDER@"
 
 configuration = JSON()
 
-configuration.add("deviceosname", "@PLUGIN_ANALYTICS_DEVICE_OS_NAME@")
 configuration.add("eventsmap", "@PLUGIN_ANALYTICS_EVENTS_MAP@")
+configuration.add("loggername", "@PLUGIN_ANALYTICS_LOGGER_NAME@")
+configuration.add("loggerversion", "@PLUGIN_ANALYTICS_LOGGER_VERSION@")
+configuration.add("backendlib", "@PLUGIN_ANALYTICS_BACKEND_LIBRARY_NAME@")
 
-if boolean("@PLUGIN_ANALYTICS_SIFT_BACKEND_ENABLED@"):
-    sift = JSON()
-    sift.add("schema2", "@PLUGIN_ANALYTICS_SIFT_2_0_ENABLED@")
-    sift.add("commonschema", "@PLUGIN_ANALYTICS_SIFT_COMMON_SCHEMA@")
-    sift.add("env", "@PLUGIN_ANALYTICS_SIFT_ENV@")
-    sift.add("productname", "@PLUGIN_ANALYTICS_SIFT_PRODUCT_NAME@")
-    sift.add("loggername", "@PLUGIN_ANALYTICS_SIFT_LOGGER_NAME@")
-    sift.add("loggerversion", "@PLUGIN_ANALYTICS_SIFT_LOGGER_VERSION@")
-    sift.add("platformdefault", "@PLUGIN_ANALYTICS_SIFT_PLATFORM_DEFAULT@")
-    sift.add("maxrandomisationwindowtime", "@PLUGIN_ANALYTICS_SIFT_MAX_RANDOMISATION_WINDOW_TIME@")
-    sift.add("maxeventsinpost", "@PLUGIN_ANALYTICS_SIFT_MAX_EVENTS_IN_POST@")
-    sift.add("maxretries", "@PLUGIN_ANALYTICS_SIFT_MAX_RETRIES@")
-    sift.add("minretryperiod", "@PLUGIN_ANALYTICS_SIFT_MIN_RETRY_PERIOD@")
-    sift.add("maxretryperiod", "@PLUGIN_ANALYTICS_SIFT_MAX_RETRY_PERIOD@")
-    sift.add("exponentialperiodicfactor", "@PLUGIN_ANALYTICS_SIFT_EXPONENTIAL_PERIODIC_FACTOR@")
-    sift.add("storepath", "@PLUGIN_ANALYTICS_SIFT_STORE_PATH@")
-    sift.add("eventslimit", "@PLUGIN_ANALYTICS_SIFT_STORE_EVENTS_LIMIT@")
-    sift.add("url", "@PLUGIN_ANALYTICS_SIFT_URL@")
-    configuration.add("sift", sift)

Analytics/Analytics.config

@@ -7,31 +7,9 @@ set (startuporder ${PLUGIN_ANALYTICS_STARTUPORDER})
 endif()
 
 map()
-    kv(deviceosname ${PLUGIN_ANALYTICS_DEVICE_OS_NAME})
     kv(eventsmap, ${PLUGIN_ANALYTICS_EVENTS_MAP})
+    kv(loggername, ${PLUGIN_ANALYTICS_LOGGER_NAME})
+    kv(loggerversion, ${PLUGIN_ANALYTICS_LOGGER_VERSION})
+    kv(backendlib, ${PLUGIN_ANALYTICS_BACKEND_LIBRARY_NAME})
 end()
 ans(configuration)
-
-
-if(PLUGIN_ANALYTICS_SIFT_BACKEND_ENABLED)
-    map()
-    kv(schema2 ${PLUGIN_ANALYTICS_SIFT_2_0_ENABLED})
-    kv(commonschema ${PLUGIN_ANALYTICS_SIFT_COMMON_SCHEMA})
-    kv(env ${PLUGIN_ANALYTICS_SIFT_ENV})
-    kv(productname ${PLUGIN_ANALYTICS_SIFT_PRODUCT_NAME})
-    kv(loggername ${PLUGIN_ANALYTICS_SIFT_LOGGER_NAME})
-    kv(loggerversion ${PLUGIN_ANALYTICS_SIFT_LOGGER_VERSION})
-    kv(platformdefault ${PLUGIN_ANALYTICS_SIFT_PLATFORM_DEFAULT})
-    kv(maxrandomisationwindowtime, ${PLUGIN_ANALYTICS_SIFT_MAX_RANDOMISATION_WINDOW_TIME})
-    kv(maxeventsinpost, ${PLUGIN_ANALYTICS_SIFT_MAX_EVENTS_IN_POST})
-    kv(maxretries, ${PLUGIN_ANALYTICS_SIFT_MAX_RETRIES})
-    kv(minretryperiod, ${PLUGIN_ANALYTICS_SIFT_MIN_RETRY_PERIOD})
-    kv(maxretryperiod, ${PLUGIN_ANALYTICS_SIFT_MAX_RETRY_PERIOD})
-    kv(exponentialperiodicfactor, ${PLUGIN_ANALYTICS_SIFT_EXPONENTIAL_PERIODIC_FACTOR})
-    kv(storepath, ${PLUGIN_ANALYTICS_SIFT_STORE_PATH})
-    kv(eventslimit, ${PLUGIN_ANALYTICS_SIFT_STORE_EVENTS_LIMIT})
-    kv(url, ${PLUGIN_ANALYTICS_SIFT_URL})
-    end()
-    ans(siftobject)
-    map_append(${configuration} sift ${siftobject})
-endif()

Analytics/Analytics.json

@@ -48,6 +48,11 @@
             "type": "integer",
             "example": 35000
         },
+        "appId":{
+            "summary": "Durable App ID string",
+            "type": "string",
+            "example": "app-id-app1"
+        },
         "eventPayload":{
             "summary": "Custom payload of the event in JSON format. User defined colection of objects and keys. May be an empty object",
             "type": "object",
@@ -87,6 +92,9 @@
                     "uptimeTimestamp":{
                         "$ref": "#/definitions/uptimeTimestamp"
                     },
+                    "appId":{
+                        "$ref": "#/definitions/appId"
+                    },
                     "eventPayload":{
                         "$ref": "#/definitions/eventPayload"
                     }

Analytics/AnalyticsPlugin.json

@@ -5,112 +5,35 @@
      "callsign":"org.rdk.Analytics",
      "locator":"libWPEFrameworkAnalytics.so",
      "status":"development",
-     "description":"The `Analytics` plugin allows to send analytics events to dedicated backends. Currently the SIFT backend is supported."
+     "description":"The `Analytics` plugin allows to send analytics events to dedicated backends"
   },
   "configuration":{
      "type":"object",
      "properties":{
         "configuration":{
            "type":"object",
            "properties":{
-              "deviceosname":{
-                 "description":"Device OS name",
+              "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"
               },
-              "sift":{
-                 "type":"object",
-                 "properties":{
-                    "schema2":{
-                       "description":"If true, enables Sift 2.0 schema, otherwise uses Sift 1.0 schema",
-                       "type":"boolean"
-                    },
-                    "commonschema":{
-                       "description":"Sift schema common schema",
-                       "type":"string"
-                    },
-                    "env":{
-                       "description":"Sift schema environment",
-                       "type":"string"
-                    },
-                    "productname":{
-                       "description":"Sift schema product name",
-                       "type":"string"
-                    },
-                    "loggername":{
-                       "description":"Sift schema logger name",
-                       "type":"string"
-                    },
-                    "loggerversion":{
-                       "description":"Sift schema logger version",
-                       "type":"string"
-                    },
-                    "platformdefault":{
-                       "description":"Sift schema platform default value",
-                       "type":"string"
-                    },
-                    "maxrandomisationwindowtime":{
-                       "description":"Sift uploader max randomisation window time of posting queued events in seconds",
-                       "type":"number"
-                    },
-                    "maxeventsinpost":{
-                       "description":"Sift uploader max events in single post",
-                       "type":"number"
-                    },
-                    "maxretries":{
-                       "description":"Sift uploader max retries posting events",
-                       "type":"number"
-                    },
-                    "minretryperiod":{
-                       "description":"Sift uploader min retry period seconds",
-                       "type":"number"
-                    },
-                    "maxretryperiod":{
-                       "description":"Sift uploader max retry period seconds",
-                       "type":"number"
-                    },
-                    "exponentialperiodicfactor":{
-                       "description":"Sift uploader exponential periodic factor for retry delay",
-                       "type":"number"
-                    },
-                    "storepath":{
-                       "description":"Sift store path to persistent queue with events",
-                       "type":"number"
-                    },
-                    "eventslimit":{
-                       "description":"Sift store events limit",
-                       "type":"number"
-                    },
-                    "url":{
-                       "description":"URL to Sift server endpoint",
-                       "type":"string"
-                    }
-                 },
-                 "required":[
-                    "schema2",
-                    "commonschema",
-                    "productname",
-                    "loggername",
-                    "loggerversion",
-                    "platformdefault",
-                    "maxrandomisationwindowtime",
-                    "maxeventsinpost",
-                    "maxretries",
-                    "minretryperiod",
-                    "maxretryperiod",
-                    "exponentialperiodicfactor",
-                    "storepath",
-                    "eventslimit",
-                    "url"
-                 ]
+              "backendlib":{
+               "description":"Name of backend library",
+               "type":"string"
               }
            },
            "required":[
-              "deviceosname",
-              "sift"
+              "loggername",
+              "loggerversion",
+              "backendlib"
            ]
         }
      },
@@ -121,4 +44,4 @@
   "interface":{
      "$ref":"Analytics.json#"
   }
-}
+}

Analytics/CHANGELOG.md

@@ -14,6 +14,9 @@ All notable changes to this RDK Service will be documented in this file.
 
     For more details, refer to versioning section under Main README.
 
+## [1.0.4] - 2025-06-12
+- Backend as an external dynamic library
+
 ## [1.0.3] - 2025-02-07
 ### Fixed
 - Fix hang on call to zdump

Analytics/CMakeLists.txt

@@ -20,41 +20,26 @@ set(MODULE_NAME ${NAMESPACE}${PLUGIN_NAME})
 
 set(VERSION_MAJOR 1)
 set(VERSION_MINOR 0)
-set(VERSION_PATCH 3)
+set(VERSION_PATCH 4)
 
 add_compile_definitions(ANALYTICS_MAJOR_VERSION=${VERSION_MAJOR})
 add_compile_definitions(ANALYTICS_MINOR_VERSION=${VERSION_MINOR})
 add_compile_definitions(ANALYTICS_PATCH_VERSION=${VERSION_PATCH})
 
 set(MODULE_VERSION ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH})
 
-option(PLUGIN_ANALYTICS_SIFT_BACKEND "Enable Sift backend" OFF)
-
 set(PLUGIN_ANALYTICS_STARTUPORDER "" CACHE STRING "To configure startup order of Analytics plugin")
 set(PLUGIN_ANALYTICS_AUTOSTART "false" CACHE STRING "Automatically start Analytics plugin")
-set(PLUGIN_ANALYTICS_DEVICE_OS_NAME "rdk" CACHE STRING "Device OS name")
 set(PLUGIN_ANALYTICS_EVENTS_MAP "" CACHE STRING "Optional path to events mapping file")
-
-set(PLUGIN_ANALYTICS_SIFT_BACKEND_ENABLED ${PLUGIN_ANALYTICS_SIFT_BACKEND} CACHE BOOL "Enable Sift backend configuration")
-set(PLUGIN_ANALYTICS_SIFT_2_0_ENABLED "false" CACHE STRING "Enable Sift 2.0 schema")
-set(PLUGIN_ANALYTICS_SIFT_COMMON_SCHEMA "entos/common/v1" CACHE STRING "Sift common schema")
-set(PLUGIN_ANALYTICS_SIFT_ENV "prod" CACHE STRING "Sift environment")
-set(PLUGIN_ANALYTICS_SIFT_PRODUCT_NAME "entos" CACHE STRING "Sift product name") #entos-immerse in Sift2.0
-set(PLUGIN_ANALYTICS_SIFT_LOGGER_NAME "Analytics" CACHE STRING "Sift logger name")
-set(PLUGIN_ANALYTICS_SIFT_LOGGER_VERSION "${MODULE_VERSION}" CACHE STRING "Sift logger version")
-set(PLUGIN_ANALYTICS_SIFT_PLATFORM_DEFAULT "entos:rdk" CACHE STRING "Sift platform default value")
-set(PLUGIN_ANALYTICS_SIFT_MAX_RANDOMISATION_WINDOW_TIME 300 CACHE STRING "Sift max randomisation window time of posting queued events")
-set(PLUGIN_ANALYTICS_SIFT_MAX_EVENTS_IN_POST 10 CACHE STRING "Sift max events in post")
-set(PLUGIN_ANALYTICS_SIFT_MAX_RETRIES 10 CACHE STRING "Sift max retries posting events")
-set(PLUGIN_ANALYTICS_SIFT_MIN_RETRY_PERIOD 1 CACHE STRING "Sift min retry period seconds")
-set(PLUGIN_ANALYTICS_SIFT_MAX_RETRY_PERIOD 30 CACHE STRING "Sift max retry period seconds")
-set(PLUGIN_ANALYTICS_SIFT_EXPONENTIAL_PERIODIC_FACTOR 2 CACHE STRING "Sift exponential periodic factor")
-set(PLUGIN_ANALYTICS_SIFT_STORE_PATH "/persistent/AnalyticsSiftStore" CACHE STRING "Sift store path")
-set(PLUGIN_ANALYTICS_SIFT_STORE_EVENTS_LIMIT 1000 CACHE STRING "Sift store events limit")
-set(PLUGIN_ANALYTICS_SIFT_URL "" CACHE STRING "Sift URL")
+set(PLUGIN_ANALYTICS_LOGGER_NAME "${PLUGIN_NAME}" CACHE STRING "Logger name")
+set(PLUGIN_ANALYTICS_LOGGER_VERSION "${MODULE_VERSION}" CACHE STRING "Logger version")
+set(PLUGIN_ANALYTICS_BACKEND_LIBRARY_NAME "" CACHE STRING "Analytics backend library name")
 
 message("Setup ${MODULE_NAME} v${MODULE_VERSION}")
 
+set(PLUGIN_ANALYTICS_INTERFACES_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/include/${NAMESPACE}/interfaces/analytics/")
+set(PLUGIN_ANALYTICS_LIBLOADER_DFL_DIR "${CMAKE_INSTALL_PREFIX}/lib/${STORAGE_DIRECTORY}/plugins/")
+
 find_package(${NAMESPACE}Plugins REQUIRED)
 find_package(${NAMESPACE}Definitions REQUIRED)
 find_package(CompileSettingsDebug CONFIG REQUIRED)
@@ -66,9 +51,17 @@ add_library(${MODULE_NAME} SHARED
 
 target_include_directories(${MODULE_NAME} PRIVATE Implementation)
 target_include_directories(${MODULE_NAME} PRIVATE Implementation/SystemTime)
+target_include_directories(${MODULE_NAME} PRIVATE Implementation/LocalStore)
+target_include_directories(${MODULE_NAME} PRIVATE Implementation/Backend)
+target_include_directories(${MODULE_NAME} PRIVATE Implementation/Interfaces)
 target_include_directories(${MODULE_NAME} PRIVATE ../)
 target_include_directories(${MODULE_NAME} PRIVATE ../helpers)
 
+file(GLOB PLUGIN_ANALYTICS_INTERFACES_HEADERS Implementation/Interfaces/I*.h)
+message(STATUS "Installing Analytics interfaces: ${PLUGIN_ANALYTICS_INTERFACES_HEADERS} into ${PLUGIN_ANALYTICS_INTERFACES_INSTALL_DIR}")
+install(FILES ${PLUGIN_ANALYTICS_INTERFACES_HEADERS}
+        DESTINATION ${PLUGIN_ANALYTICS_INTERFACES_INSTALL_DIR})
+
 add_subdirectory(Implementation/SystemTime)
 add_subdirectory(Implementation/LocalStore)
 add_subdirectory(Implementation/Backend)
@@ -78,14 +71,16 @@ set_target_properties(${MODULE_NAME} PROPERTIES
         CXX_STANDARD_REQUIRED YES)
 
 target_compile_definitions(${MODULE_NAME} PRIVATE MODULE_NAME=Plugin_${PLUGIN_NAME})
+target_compile_definitions(${MODULE_NAME} PRIVATE LIBLOADER_DFL_DIR="${PLUGIN_ANALYTICS_LIBLOADER_DFL_DIR}")
 
 target_link_libraries(${MODULE_NAME}
         PRIVATE
         CompileSettingsDebug::CompileSettingsDebug
         ${NAMESPACE}Plugins::${NAMESPACE}Plugins
         ${NAMESPACE}Definitions::${NAMESPACE}Definitions
         ${MODULE_NAME}Backends
-        ${MODULE_NAME}SystemTime)
+        ${MODULE_NAME}SystemTime
+        ${MODULE_NAME}LocalStore)
 
 if (RDK_SERVICE_L2_TEST)
     target_compile_definitions(${MODULE_NAME} PRIVATE MODULE_NAME=Plugin_${PLUGIN_NAME})
@@ -98,6 +93,8 @@ if (RDK_SERVICE_L2_TEST)
     else (TESTMOCKLIB_LIBRARIES)
         message ("Require ${TESTMOCKLIB_LIBRARIES} library")
     endif (TESTMOCKLIB_LIBRARIES)
+
+    add_subdirectory(Tests/AnalyticsBackendMock)
 endif (RDK_SERVICES_L2_TEST)
 
 install(TARGETS ${MODULE_NAME}