Telemetry Support in Turris Omnia - Design - 2020 M11

INTRODUCTION

Telemetry is a feature used in RDK broadband Gateway devices to extract and upload specific error logs or event logs from the Gateway to the Splunk server. These logs are used to remotely monitor the Gateways in the field.

The logs to be monitored and the frequency of capturing the logs can be configured from the Xconf server, in the form of a marker.

RDK-B Telemetry Architecture

`

Design consideration:

For the Telemetry feature, there are 2 servers maintained.

1. Xconf server – To store the configurations
2. Splunk server – To store the logs uploaded from the Gateways.

Telemetry data flow

1. Every Gateway is registered with the Xconf server. The Gateway executes “DCM script” on boot up. When the Gateway is connected to the server, it queries for the Configuration. Xconf server responds with the predefined markers which includes the information like the logs to be monitored, the log file name, polling frequency, etc.
2. The “DCM script” processes the markers and prepares a “sorted map file” for the log look up and then schedules a “dca agent” at every 1 minute.
3. The “dca agent” takes the “sorted map file” and the “Logs directory” as input and extracts the logs.
4. It then uploads the logs to the Splunk server periodically.

Marker

A marker provides the errors or events appearing in the RDK logs. These markers are predefined in the Xconf server. These markers are set based on the events or errors that need to be monitored for any device.

Each marker contains 4 fields:

• Header: This is a User defined field which describes the error or event.
• Content: This provides the error or event as it appears in the RDK logs.
• Type: This provides the log file name which may have the above error or event log.
• Frequency: This provides the skip frequency, that means the number of times we want to skip the above error / event. If this is “0”, each instance of the event is captured and none of them are skipped.

Marker example

{

    “header”: “WIFI_ERROR_WIFI_NOT_Registered”,

    “content”: “System Not Ready !!!! ‘com.cisco.spvtg.ccsp.wifi’ v1 NotRegistered”,

    “type”: “CRlog.txt.0”

    “frequency”: “0”

}

Limitations:

1. The Comcast Xconf server and Splunk server are not available.
   1. Instead of Comcast Xconf server CMF Xconf server is used.
   2. Instead of Splunk server, a TFTP/HTTP server is used.
   3. Turris will support only http protocol for upload. No tftp protocol support is provided yet
2. Please refer to user manual RDK Telemetry for Turris omnia reference platform for markers definition

Future Enhancements:

1. To add support for creating a cron job to schedule periodic log collection and upload.
2. To add log collection scheduling frequency settings in Xconf server.