{"id":12129,"date":"2024-12-26T19:07:30","date_gmt":"2024-12-26T19:07:30","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/instrumenting_rdkb_components_to_use_telemetry2-0\/"},"modified":"2025-03-25T05:18:32","modified_gmt":"2025-03-25T05:18:32","slug":"instrumenting_rdkb_components_to_use_telemetry2-0","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/instrumenting_rdkb_components_to_use_telemetry2-0\/","title":{"rendered":"Instrumenting RDKB components to use Telemetry2.0"},"content":{"rendered":"\n
\n
\n
\n
\n

Introduction<\/h2><\/div>\n<\/div>\n<\/div>\n
\n
\n
\n

While migrating to Telemetry2.0 from DCA telemetry, the traditional log grepping is targetted to reduce as much as possible by instrumenting the  markers coming from RDKB components.To achieve this, RDKB components are supposed make required changes with the use of APIs from Telemetry 2.0 shared library (commonlib – https:\/\/code.rdkcentral.com\/r\/plugins\/gitiles\/rdk\/components\/generic\/telemetry\/+\/refs\/heads\/rdk-next\/source\/commonlib\/<\/a> )<\/span><\/p>

Brief Background:<\/strong><\/p>

In DCA telemetry, the markers fetched from xconf are grepped in log files and reported in json format to splunk server.<\/p>

The markers are of 3 types:<\/span><\/p>

  1. Split based markers. <\/li>
  2. Count based markers<\/li>
  3. TR-181 based markers.<\/li><\/ol>
    <\/colgroup>
    Marker Type<\/th>Sample configuration from xconf<\/th>Description with respect to sample configuration<\/th><\/tr>
    Split based markers<\/td>
    {\"header\":\"WIFI_ACS_1_split\",\"content\":\"WIFI_ACS_1:\",\"type\":\"wifihealth.txt\",\"pollingFrequency\":\"0\"}<\/pre><\/td>
    		Expects the value after content “WIFI_ACS_1:”<\/td><\/tr>
    Count based markers <\/td>
    {\"header\":\"RF_ERROR_IPV6PingFailed\",\"content\":\"Ping to IPv6 Gateway Address are failed\",\"type\":\"SelfHeal.txt.0\",\"pollingFrequency\":\"0\"}<\/pre><\/td>
    		Expects the occurance count of content “Ping to IPv6 Gateway Address are failed”<\/td><\/tr>
    TR-181 based markers<\/td>{“header” : “XDNS_split”,”content” : “Device.DeviceInfo.X_RDKCENTRAL-COM_EnableXDNS”,”type” : “<message_bus>”,”pollingFrequency”:”48″}<\/td>Markers whose type is configured as “<message_bus>”<\/td><\/tr><\/tbody><\/table> <\/div>


    In T2.0,  the aim is to instrument possible number of split and count based markers from component side. These are termed as event markers. Can be classified as one more type under the classification of  markers. Once a marker is instrumented from component side, its configuration on xconf will be changed  from the configured file name to “<event>” in   ‘type:’ section.<\/p>

    Example: {“header”:”WIFI_ACS_1_split”,”content”:”WIFI_ACS_1:”,”type”:<event>”,”pollingFrequency”:”0″}<\/span><\/p><\/div>\n<\/div>\n<\/div>\n

    \n
    \n
    \n
    <\/div>\n<\/div>\n<\/div>\n
    \n
    \n
    \n

    Overview of Instrumenting RDKB components with T2 shared library (commonlib) APIs:<\/strong><\/h2><\/div>\n<\/div>\n<\/div>\n
    \n
    \n
    \n
    \n\t
    <\/div>\n\t
    \n\t<\/a>\n\t\n<\/span><\/div>\n<\/div>

    Steps to instrument split based and count based markers from RDKB components side:<\/p>

    1. Check if that particular device Build have the Telemtry2.0 building capability<\/li>
    2. Include required headers <\/li>
    3. Compile the component with telemetry 2.0 support<\/li>
    4. Initialize the module with telemetry<\/li>
    5. Find the correct place to report a marker<\/li>
    6. Use appropriate APIs to report markers and values.<\/li>
    7. Must check notes<\/li><\/ol><\/div>\n<\/div>\n<\/div>\n
      \n
      \n
      \n
      1. To check if a particular device build have the Telemtry2.0 building capability
        1. Should have an entry in device based.xml file<\/li>
        2. “telemetry2_0” should be appeneded to DISTRO_FEATURES in machine configuration file. <\/span>NOTE: Distro feature will be removed soon, and this page will be updated to reflect that.<\/span><\/li><\/ol><\/li>
        3. Include required headers \/ declare enough sized telemetry buffer and send events to T2 with t2_event_s() api<\/span>
          1. NOTE: Now that T2.0 is present on all RDK-B platforms, there is no need to use the #if defined for the header or T2.0 API calls<\/span>
            1. #if defined(ENABLE_FEATURE_TELEMETRY2_0)<\/s>
              #include <telemetry_busmessage_sender.h>
              #endif<\/s><\/span>
              1. https:\/\/code.rdkcentral.com\/r\/plugins\/gitiles\/rdkb\/components\/opensource\/ccsp\/CcspWifiAgent\/+\/refs\/heads\/rdk-next\/include\/TR-181\/ml\/cosa_wifi_internal.h<\/a><\/li>
              2. https:\/\/code.rdkcentral.com\/r\/plugins\/gitiles\/rdkb\/components\/opensource\/ccsp\/CcspWifiAgent\/+\/refs\/heads\/rdk-next\/source\/TR-181\/sbapi\/wifi_monitor.c<\/a><\/li><\/ol><\/li><\/ol><\/li><\/ol><\/li>
              3. To compile a component with Telemetry2.0 if it is enabled for that device. NOTE: Distro feature will be removed soon, and this page will be updated to reflect that.<\/strong>
                1. Add depends to telemetry module.<\/li>
                2. Add Compile time (-DENABLE_FEATURE_TELEMETRY2_0) and linking time (-ltelemetry_msgsender) flags  to the recipe file.<\/li>
                3. Make sure that bb file has below line to avoid compilation errors.
                  1. CFLAGS_append = ” -I${STAGING_INCDIR}\/ccsp “<\/li>
                  2. Sample review: https:\/\/code.rdkcentral.com\/r\/plugins\/gitiles\/rdk\/components\/generic\/rdk-oe\/meta-rdk-broadband\/+\/refs\/heads\/rdk-next\/recipes-ccsp\/ccsp\/ccsp-wifi-agent.bb<\/a><\/li><\/ol><\/li><\/ol><\/li>
                  3. Initialize the module with telemetry
                    1. Initialization needs to be done only once at the very initial stage of application \/ module
                      1. Example: https:\/\/code.rdkcentral.com\/r\/plugins\/gitiles\/rdkb\/components\/opensource\/ccsp\/CcspCr\/+\/refs\/heads\/rdk-next\/source\/CrSsp\/ssp_main.c<\/a>
                        1. <\/ol><\/li><\/ol><\/li><\/ol><\/li>
                        2. Find the correct place to report a marker
                          1. Previously  in DCA telemetry, a marker is reported based on the xconf configured “content” string –  when the content string is found in corresponding configured filename configured under ‘type:’ section .
                            1. \/* Refer :  {“header”: “WIFI_INFO_Hotspot_client_connected<\/span>“, “content”: “Added case, Client with:<\/span>“, “type”: “Hotspotlog.txt.0<\/span>“,”pollingFrequency”:”0″} *\/<\/li><\/ol><\/li>
                            2. So, find the right place where the content string is being written to the corresponding log file in order to event a marker in T2.0.
                              1. https:\/\/code.rdkcentral.com\/r\/plugins\/gitiles\/rdkb\/components\/opensource\/ccsp\/hotspot\/+\/refs\/heads\/rdk-next\/source\/hotspotfd\/cosa_hotspot_dml.c<\/a> <\/span>(Line number 144 gives the idea) <\/span>CcspTraceInfo((“Added case, Client with MAC:%s will be addedn”, l_cMacAddr));<\/span><\/li><\/ol><\/li>
                              2. Once the place is decided, use the right API to report Marker and values. 
                                1. For markers without “_split” suffix, the marker data is just a count of the number of times the marker is received.  In this case, the <\/span>t2_event_d<\/em> <\/span>API can be used because the marker data passed to the API is not important.<\/span>
                                  1. Example:  t2_event_d(“WIFI_INFO_Hotspot_client_connected”, 1);<\/em> <\/span>in https:\/\/code.rdkcentral.com\/r\/plugins\/gitiles\/rdkb\/components\/opensource\/ccsp\/hotspot\/+\/refs\/heads\/rdk-next\/source\/hotspotfd\/cosa_hotspot_dml.c<\/a><\/span><\/li><\/ol><\/li>
                                  2. For markers with “_split” suffix, the marker data is important, so use the API most appropriate to the marker data.  For instance, if the marker data is a string, use <\/span>t2_event_s<\/em>.  But if marker data is numeric, use one of <\/span><\/span>t2_event_d<\/em> <\/span>or<\/span> <\/span>t2_event_f<\/em>.  Also note that testing must ensure the string used for marker data matches the string expected by legacy telemetry.<\/span>
                                    1. Example : <\/span>t2_event_s(“acs_split”, pStr);<\/em> <\/span>in <\/span>https:\/\/code.rdkcentral.com\/r\/plugins\/gitiles\/rdkb\/components\/opensource\/ccsp\/CcspTr069Pa\/+\/refs\/heads\/rdk-next\/source-embedded\/DslhManagementServer\/ccsp_management_server_pa_api.c#767<\/a><\/span><\/li><\/ol><\/li><\/ol><\/li><\/ol><\/li>
                                    2. Use appropriate APIs to event markers and values<\/span>
                                      1. In RDKB we have logs coming from both scripts and component’s code (code in C). From which markers are reported\/grepped.<\/li>
                                      2. List of APIs :
                                        1. To report markers from components