Feature Validation : Xconf Server

Pre-requisite

• Access to Raspberry Pi terminal.
• Access to Xconf server from browser https://xconf.rdkcentral.com:9093/admin/ 
  • For Admin mode(read and writ permission) -> username : admin, password: RdkXcadm$2120
  • For User mode(only read mode) -> username: user ,password: RdkXcusr@2210          

• Disable log rotation in RPI using below command. (This is optional)
  • systemctl disable rdkbLogMonitor
  • reboot 

Admin UI: Common Configuration

• Define Environments

           Flow:  Xconf-server -> Common -> Environments
           Click on Create Button.

           Click on Create, Enter the ID and Description fields, click on Save.
           ID : <Unique Identifier>  ; Description : <Description>

• Define Models

          Flow: Xconf-server -> Common -> Models
          Click on Create, Enter the ID and Description fields, click on Save.

• Define Mac List

          Flow: Xconf-server -> Common -> MAC Lists -> Create -> Add your Device MAC address -> Save.

• Define IP List

          Flow: Xconf-server -> Common -> IP Lists -> Create-> Create -> Add your device IP address -> Save.

Feature Validation: LogUpload

• In Raspberry Board, add the server details for log upload.
• Configure the Bellow details to dcm.properties and comment out the other details .

            File :  /etc/dcm.properties

           LOG_SERVER=xconf.rdkcentral.com
           DCM_LOG_SERVER=https://xconf.rdkcentral.com/xconf/logupload.php
           DCM_LOG_SERVER_URL=https://xconf.rdkcentral.com:9092/loguploader/getSettings
           DCM_SCP_SERVER=xconf.rdkcentral.com
           DCM_LA_SERVER_URL=https://xconf.rdkcentral.com/xconf/logupload.php

• In Xconf UI Change Application to stb in top right corner of the window.

• Defining the Upload repositories

          Flow: Xconf-server -> DCM -> Upload repository -> create ->save
          Name: <Unique Identifier>
          Description: <Unique Identifier>
          URL:  HTTP: http://35.161.239.220/xconf/telemetry_upload.php

• Defining the formula

           Flow: Xconf-server -> DCM -> Formulas -> Create
           Name: <unique name for log upload>
           Description: <Short description for log upload>
           Percentage: 100
           Build condition:  estbMacAddress IS <MAC Address> OR estbIP IS <IP Address> 
                                    (or)  estbMacAddress IS <MAC Address>  AND model is <Model Name>   (Model name is already configured under Common Tab)

• As soon as the formula is saved, then a ‘define Settings’ tab with ‘Create Device Settings’, ‘Create log settings’, Create VOD settings’ will be available.

• Click on 'Create Device Settings' tab and edit the Device Settings.

• Click on ‘Create Log Update setting’ and Edit the Log upload Setting (Create schedule & add the upload repository created beforehand).

           Name: Enter the name given during Log Upload Formula Creation.
           Note: The formula will be effective only if we select 'Are Settings Active' option to 'true' in 'Create Device Settings' and 'Log Upload settings'.

Verification at Xconf UI.

• Test Page for Log Upload
  Flow: Xconf-Server -> DCM ->Test Page 

• Parameters: give a parameter that will match the one of the formulas that you have created.
  • estbMacAddress < MAC Address> or
  • estbIP <IP Address>
  • model <Model Name>

Log Upload: Client End Verification (In RPI)

• Remove already existing DCM Settings config files under /tmp
             rm -rf /tmp/DCM*
• Restart the log upload service in Raspberry Pi using the command
            systemctl restart CcspTelemetry.service
            root@RaspberryPi-Gateway:~# systemctl restart CcspTelemetry.service
• Verify through CURL command
             curl -i 'https://xconf.rdkcentral.com:9092/loguploader/getSettings?estbIP=<IP ADDRESS>'
             or
             curl -i 'https://xconf.rdkcentral.com:9092/loguploader/getSettings?estbMacAddress=<MAC-Address>'

• Sample Output:

• On successful Log upload, conf file will be created under /tmp directory. This file contains the details of log upload settings which are already configured in the server.
            File : /tmp/DCMSettings.conf

• Verify the logs in /rdklogs/logs/dcmscript.log file
• The log file contains the details of
  • Service status, tftp details, reboot flag , check on reboot flag ,
  • Upload settings details – location, protocol.
• Shows list of files which are to be uploaded to the server as a tar file (logs will be zipped and creates a tar file on every bootup/service restart), Backup folder details (/rdklogs/logs/PreviousLogs_backup)
• HTTP request processing status.   
• Log files are stored in .tgz format and markers are stored in <mac_address>-TELE-<date>.json

• Json response on server

• Log files are stored in .tgz format and markers are stored in <mac_address>-TELE-<date>.json

• Attaching sample file :  B8_27_EB_22_16_36-Logs-11-10-21-07-00AM.tgz

Feature Validation: Telemetry

• Telemetry configuration can be done by adding a permanent profile which contains below objects
  • Upload repository
  • Profile options (Header, content, frequency etc.)
• Creating a targeting rule which is basically mapping the profile to a set of MAC/IP/Device etc
• Note: DCM settings should be already done for the devices that you are going to set telemetry configuration.

• Create a new Telemetry Profile.
  Flow: X-conf-server -> Telemetry -> Permanent Profiles -> Create button

• The permanent profile must have the below entries
  • Name of the RPI device profile
  • Upload Repository (HTTP/TFTP, HTTP : http://35.161.239.220/xconf/telemetry_upload.php)
  • Telemetry profile Entries(We can add multiple telemetry profiles using “+” button.
  • In the Telemetry Permanent Profile page, there will be a 5th column that allows a component name to be entered. The component name is optional and may be present for only some of the entries in the Telemetry profile.

• Once you save the permanent profile, you will get a message overlay ‘Profile added to the pending changes’. Then go to Changes -> select the profile you create -> Click on “Approve selected changes”.

• Then the permanent profile will be listed under Telemetry - > Permanent profiles.
• Creating targeting rules for RPI
  • Flow: X-conf-server -> Telemetry -> Targeting rules -> Create
  • Name : Name of the Targeting Rule
  • Rule : ex : estbMacAddress IS <MAC Address>
  • Bound Profile : Choose the Permanent Profile

• Verification of telemetry test page.
  After creating the permanent profile and targeting rules, go to Telemetry->Test page and give a parameter that will match the one of the rules that you have created. Then matched rule will be displayed like below.

• Verification via curl command
  The same url used for logupload verification can be used here too, the response will have telemetry settings data like below (urn:settings:TelemetryProfile)   
  curl -i 'https://xconf.rdkcentral.com:9092/loguploader/getSettings?estbMacAddress=<MAC-Address>'

         Sample Output

• Server configuration that we set in Xconf server is copied to /tmp/DCMSettings.conf file.

• Logs and Telemetry markers are uploaded via HTTP to the xconf server https://xconf.rdkcentral.com/xconf/upload/
• Log files are stored in .tgz format and markers are stored in <mac_address>-TELE-<date>.json
• Sample Log is as below

• root@RaspberryPi-Gateway:/rdklogs/logs# root@RaspberryPi-Gateway:/rdklogs/logs# tail -f telemetry.log 211110-06:10:14.269011 dca: Using Direct commnication •    Sample number of proUPdel1:42 Upload protocol telemetry is:HTTP before HTTP upload number of httpdeli:42 HTTPTELEMETRYURL:http://35.161.239.220/xconf/telemetry_upload.php ------CURL_CMD:curl --tlsv1.2 -w '%{http_code}\n' -H "Accept: application/json" -H "Content-type: application/json" -X POST -d @/nvram/rtl_json.txt 'http://35.161.239.220/xconf/telemetry_upload.php' --connect-timeout 30 -m 30 number of proUPdel2:42 Upload protocol logupload is:HTTP before HTTP log upload HTTPLOGUPLOADURL:http://35.161.239.220/xconf/logupload.php upload log file is:11-10-21-06-08AM.tgz ------CURL_CMD2:curl -w '%{http_code}\n' -F filename=@/rdklogs/logs//PreviousLogs/B8:27:EB:22:16:36-Logs-11-10-21-06-08AM.tgz 'http://35.161.239.220/xconf/logupload.php' --connect-timeout 100 -m 100 http code in telemetry is :200 HTTP telemetry curl upload succeded!!!!!!!!!!!!!!!!! http_code is :200 HTTP log upload succeded!!!!!!!!!!!!!!!!! number of proUPdel2:42 Upload protocol logupload is:HTTP before HTTP log upload HTTPLOGUPLOADURL:http://35.161.239.220/xconf/logupload.php upload log file is:11-10-21-06-08AM.tgz ------CURL_CMD2:curl -w '%{http_code}\n' -F filename=@/rdklogs/logs//PreviousLogs/B8:27:EB:22:16:36-Logs-11-10-21-06-08AM.tgz 'http://35.161.239.220/xconf/logupload.php' --connect-timeout 100 -m 100 http_code is :200 HTTP log upload succeded!!!!!!!!!!!!!!!!! Done Uploading Logs and removing rtl_json.txt file Done Uploading Logs and removing rtl_json.txt file

• Telemetry Log Markers

• Content of json Response

• All the Logs will be updated as .tgz format in xconf server.

Feature Validation: Telemetry2_0

Pre- requisites for enabling Telemetry2_0

Telemetry Version: 2.0.1 (by default telemetry version as 1)

• Configure the below details to dcm.properties and comment out the other details .
  File:  /etc/dcm.properties
  LOG_SERVER=xconf.rdkcentral.com
  DCM_LOG_SERVER=https://xconf.rdkcentral.com/xconf/logupload.php
  DCM_LOG_SERVER_URL=https://xconf.rdkcentral.com:9092/loguploader/getSettings
  DCM_SCP_SERVER=xconf.rdkcentral.com
  DCM_LA_SERVER_URL=https://xconf.rdkcentral.com/xconf/logupload.php

• Below are the steps for enabling telemetry 2.0.1 in RPI

1. dmcli eRT setv Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.Telemetry.Enable bool true
2. dmcli eRT setv Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.Telemetry.Version string 2.0.1
3. dmcli eRT setv Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.Telemetry.ConfigURL string https://xconf.rdkcentral.com:9092/loguploader/getT2Settings
4. touch /nvram/enable_t2_debug
5. reboot the device
6. pidof "telemetry2_0" - check the running status of telemetry2
7. T2 DataModel will be loaded

• Below screenshot for enabling the T2 process of version 2.0.1 in RPI

• After reboot the device

• Telemetry 2.0 Report Profiles
  Telemetry 2 adds support for RDK Components to send their telemetry data to the T2 component for reporting. This allows for moving away from the CPU-intensive process of searching through log files for telemetry strings.
  Telemetry 2.0 allows for an RDK device to be updated with a set of T2 profiles at any time.

• T2 DataModel

          There are 2 parameters under T2 report profiles,

• DMCLI SET Command for T2 Report Profile

• DMCLI GET

• Telemetry 2.0 Report Profiles Generation in xconf,
  Flow: xconf Server UI -> Telemetry -> Telemetry 2.0 Profiles -> create

• Once you save the Telemetry 2.0 profile, you will get a message overlay ‘Profile added to the pending changes’. Then go to Changes -> select the profile you create -> Click on “Approve selected changes”.

• Create Telemetry 2.0 Targeting Rule
  Flow: Xconf Server -> Telemetry > Telemetry 2.0 Rules > create

• Verification
  Flow: Xconf -Server -> Telemetry > Telemetry 2.0 Test page

• Telemetry Profiles
  Sample SingleTelemetryProfiles
  https://xconf.rdkcentral.com:9092/loguploader/getTelemetryProfiles?estbMacAddress=B8:27:EB:22:16:36

• Log Verification in RPI
  Path: rdklogs/logs/
  file: telemetry2_0.txt.0

• Verification via curl command
  curl -i 'https://xconf.rdkcentral.com:9092/loguploader/getTelemetryProfiles?estbMacAddress=B8:27:EB:22:16:36'

Feature Validation: Remote Feature Control (RFC)

• Configuration In RPI
  configure the xconf server URL in below path
   File: /etc/rfc.properties     
   URL : RFC_CONFIG_SERVER_URL=https://xconf.rdkcentral.com:9092/featureControl/getSettings

• Verify the existing(default) value of TR181 parameters

            root@RaspberryPi-Gateway:~# dmcli eRT getv   Device.X_Comcast_com_ParentalControl.ManagedSites.Enable Device.X_Comcast_com_ParentalControl.ManagedServices.Enable
            CR component name is: eRT.com.cisco.spvtg.ccsp.CR
            subsystem_prefix eRT.
            getv from/to component(eRT.com.cisco.spvtg.ccsp.pam): Device.X_Comcast_com_ParentalControl.ManagedSites.Enable
            Execution succeed.
            Parameter    1 name: Device.X_Comcast_com_ParentalControl.ManagedSites.Enable
            type:       bool,    value: false
            Parameter    2 name: Device.X_Comcast_com_ParentalControl.ManagedServices.Enable
            type:       bool,    value: true

• Xconf Server UI Configuration
  Change Application to stb in top right corner of the window.