Introduction<\/h2>\n\n\n
CPE has many metrics that are powerful for the analysis of trends and performance insights. Some sources of those metrics are applications or any of the RDK subsystems<\/span> and TR-069 values. An easy way to get some application metrics is through the log strings they write to log files. The conventional way of accessing this content has been through the upload of these files to servers and then processing the data from them<\/span><\/span>. However, this content has not been available to the range of operations engineers, analysts, managers, and others who want to search for and monitor issues. Moreover, the current response time is inadequate; a delay of 24 hours is excessive in many instances. To enhance timeliness, the ‘Telemetry’ component is created that enables devices to transmit specific metrics from designated logs and TR-069<\/span> at near-real-time intervals.<\/span><\/span><\/p>\n RDK Telemetry improved on the early practice where the RDK would simply bundle log files once a day and transfer the bundle to a file server. B<\/span>oth RDK-V and RDK-B devices provide telemetry with several key features: more real-time data, configurable metrics or events that the CPE should retrieve and send, improved upload frequency that made the timeliness of this data more relevant to analysts, more sources of metrics and events such as log files or TR-069 parameters, an improved cloud solution for analytics using big data solutions for receiving streams and storing data for reporting, and real-time metrics using terse key\/value pairs (e.g., {“Report”:[{“mac”:”AA:BB:CC:DD:EE:FF”},{“TelemetryEnabled”:”true”},{“CpuUsage”:”48″},{“Uptime”:”824″},{“FreeMem”:”2036476″},{“TotalMem”:”1212772″}]}.<\/span><\/p>\n<\/div>\n<\/div>\n<\/div>\n RDK telemetry data is sent periodically from every RDK device, with XConf sending certain parameters during bootup, specifying what parameters to gather and where to retrieve them from, such as logs or status information (e.g., CPU load, memory usage) using system commands. The CPE sends a request to the server with version and device details, and based on server rules, the telemetry agent retrieves telemetry markers from the server, gathers the required data from logs, and packages it into a JSON message. This message is then sent to a server where it is processed and updated in storage, with the server configuring how often it needs telemetry data.<\/span><\/p>\n The telemetry upload process is controlled through the dcm-log service<\/span><\/p>\nKey Features<\/h3>\n
\n
<\/div>\n<\/div>\n<\/div>\nArchitecture<\/h2>\n\n\n
![\"Telemetry_ProcessFlow\"](\"https:\/\/developer.rdkcentral.com\/documentation\/wp-content\/uploads\/sites\/16\/2024\/10\/Telemetry_ProcessFlow.png\" "\\"Telemetry_ProcessFlow\\"")
<\/div>\n<\/div>\nHow it works<\/h3>\n
![\"TelemetryWorkingProcedure\"](\"https:\/\/developer.rdkcentral.com\/documentation\/wp-content\/uploads\/sites\/16\/2024\/10\/TelemetryWorkingProcedure.png\" "\\"TelemetryWorkingProcedure\\"")
<\/div>\n<\/div>\n\n
<\/div>\n<\/div>\n<\/div>\nTelemetry <\/span>using community XConf server<\/span><\/span><\/h2>\n\n\n
XConf s<\/span>erver configuration procedure:<\/h3>\n
\n
\n
\n
\n