RDK Remote debugger - Diagnostic Debug Data Collection Tool

Intro

As a Field Triage Engineer and Developer responsible for debugging field issues, having the ability to collect diagnostic/ debug data from the device without requiring SSH access would be beneficial. The Triage Engineer can use WebPA communication to initiate the data reporting process and retrieve the report from the S3 log service

Architecture

• Please refere https://github.com/rdkcentral/remote_debugger/tree/develop

Use case diagram

• rdbg

Samples

• Upload scripts location

  • /lib/rdk/uploadRRDLogs.sh
    /rdklogger/uploadRDKBLogs.sh

• Report generation location

  • /tmp/rrd

• Log files

  • /rdklogs/logs/remote-debugger.log.0 

• static json file location

  • Path in CPE
       /etc/rrd/remote_debugger.json
    Path in code base
       https://github.com/rdkcentral/remote_debugger/blob/develop/remote_debugger.json

• Datamodel command

  • dmcli eRT setv Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.RDKRemoteDebugger.IssueType string "Device.Uptime"

Removed existing rdm in rdkb builds

• meta-cmf/recipes-core/packagegroups/packagegroup-rdk-ccsp-broadband.bbappend # Comment out or remove the line: RDEPENDS_packagegroup-rdk-ccsp-broadband_append = " rdm"

Distro

• rrd to be enabled

RFC

• DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.RDKRemoteDebugger.Enable

Enable service from yocto

• remote-debugger.service 

Image install

• Install remote debugger & rdm-agent in monolithic image

Code base

• remote debugger

  • Source repo

    • https://github.com/rdkcentral/remote_debugger/tree/develop

  • meta layer

    • https://github.com/rdkcentral/meta-rdk/blob/develop/recipes-extended/remotedebugger/remotedebugger.bb

• rdm agent

  • Source repo

    • https://github.com/rdkcentral/rdm-agent/tree/develop

  • meta layer

    • https://github.com/rdkcentral/meta-rdk/blob/develop/recipes-support/rdmagent/rdmagent.bb

  • Dependencies

    • https://github.com/rdkcentral/common_utilities
    • https://code.rdkcentral.com/r/plugins/gitiles/rdk/components/generic/rdk-oe/meta-rdk/+/refs/heads/rdk-next/recipes-common/utils/commonutilities_git.bb
    • to be moved to common area - https://github.com/rdkcentral/meta-rdk-video/blob/develop/recipes-common/utils/commonutilities_git.bb

  • Additional changes

    • rdm_downloadutils.c 
      
      #ifdef IARMBUS_SUPPORT 
      #include "rdmMgr.h" 
      #else 
      #define RDM_PKG_INVALID_INPUT 11
      #endif 

Dependencies removal

• remove utopia dependencies from remote debugger service file

Roles and responsibilities of ISP

• Develop your own triaging tool on top of webpa/usp/tr69