Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

STB has lots of metrics that would be powerful for analysis of trends and performance insights. Some sources of those metrics are applications (subsystems) and SNMP/TR-069 values. An easy way to get some application metrics is through the log strings they write to log files. To date, the only means of getting at this content has been through the daily uploading of these files to file servers. Then, custom tools index like Sphinx have been indexing the text content. Ad Ad-hoc searches and a few reports give engineers access to the content.

...

All of these features have been big improvements over the earlier log file transfers.

Key Features

  • RDK telemetry data is send from every RDK device on a specific interval
  • Ability to generate critical matrix using the configured parameters
  • Leverages logs, different system status information and snmp commands
  • Uses key-value pairs for data upload

draw.io Diagram
diagramNameTelemetry diagram.drawio
revision1

RDK telemetry data is sent from every RDK device periodically. During bootup, Xconf sends certain parameters (matrix info which it likes to gather). It sends what parameter and where to reteive it from. 

eg: parameters are be derived from log, status information (cpu load / mem usage) using system commands or via snmp commands 

STB sends request to server with version, device details etc. Based on server rules, telemetry agent retrieves the telemetry markers from server. Based on that information, it retrieves data from log / snmp etc. Finally telemetry agent packages all these data to json message and sends to a server which gets processed and updated in splunk. Server can configure how often it needs telemetry data. 


How it works

draw.io Diagram
diagramNameHow it works.drawio
revision1


The telemetry upload process is controlled through dcm-log service

  1. DCMscript.sh communicates with Xconf server and fetches the predefined markers
  2. Using the markers, DCM Script will prepare a sorted map file for the log lookup, creates a DCA Agent cron job.
  3. Cron job retrieves data from the device
  4. From the retrieved data, it will create a JSON formatted message.
  5. JSON format data will be uploaded to server