Versions Compared

Key

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

...

  • Sample 
        
        
  • As soon as the formula is saved , displays the device settings and Log upload settings options
       
  • Device settings

    Name

    RDKB_telemetry

    CheckOnReboot

    true

    Are active

    true

    Expression

    2 1 2 1 1

      

  • Defining the Upload repositories

    URL

    http://35.155.171.121:9093/admin/ux/#/uploadrepository

    Flow

    Xconf-server ->DCM -> Upload repositories

    Name

    RDKB_telemetry

    Description

    RDKB_telemetry

    URL

    tftp    : 35.155.171.121

    HTTP :  http://35.155.171.121/xconf/logupload.php

  • Log upload settings

    Name

    <Enter the name given during Log upload formula creation>

    Upload On Reboot

    true

    Number of Days

    1

    Are settings active

    true

    Upload Repository

    RDKB_telemetry

    Cron Expression

    2 1 1 1 1

  • Test Page

    URL

    http://35.155.171.121:9093/admin/ux/#/formulas/all

    Path

    Xconf-server-> DCM -> Test Page

          

Telemetry

  • Defining Telemetry profile

...

               

  • Create Targeting rule 

    URL

    http://35.155.171.121:9093/admin/ux/#/formulas/all

    Path

    Xconf-server-> Telemetry->Targeting rule -> Create

      

    1. Give the Unique rule name
    2. Select the rule. Here , used estbMacAddress as the rule
    3. Select the Bound profile (Telemetry Permanent Profile Name)

             Sample

        

  • Test Page

    URL

    http://35.155.171.121:9093/admin/ux/#/formulas/all

    Path

    Xconf-server-> Telemetry->Test Page

    1. To test whether the configured profile details are retrieved properly from xconf-server
    2. Give the rule specified in “Targeting Rule” section i.e., estbMacAddress here

                 

  • Sample:

...

  • Restart the dcm-log service using “systemctl restart dcm-log
  • To check the status of the service “systemctl status dcm-log
  • By triggering the service , rpi starts uploading the logs to the xconf-server
  • The log upload and Telemetry markers can be uploaded via tftp and http
  • The profile can be verified using curl, conf file , through logs and in server as below

1.  CURL

  • Syntax : curl -i 'http://<ip>:9092/loguploader/getSettings?estbMacAddress=<MAC>’

Sample: 1  TFTP

root@RaspberryPi-Gateway:~# ifconfig erouter0
erouter0  Link encap:Ethernet  HWaddr B8:27:EB:22:16:36
          inet addr:192.168.30.125  Bcast:0.0.0.0  Mask:255.255.255.0
          inet6 addr: fe80::ba27:ebff:fe22:1636/64 Scope:Link
          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
          RX packets:18748 errors:0 dropped:0 overruns:0 frame:0
          TX packets:3081 errors:0 dropped:0 overruns:0 carrier:0
          collisions:0 txqueuelen:1000
          RX bytes:2614475 (2.4 MiB)  TX bytes:590848 (577.0 KiB)

root@RaspberryPi-Gateway:~# curl -i 'http://35.155.171.121:9092/loguploader/getSettings?estbMacAddress=B8:27:EB:22:16:36'
HTTP/1.1 200 OK

Date: Fri, 31 Jan 2020 10:59:09 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Server: Jetty(9.2.1.v20140609)

{"urn:settings:GroupName":"RDKB_telemetry","urn:settings:CheckOnReboot":true,"urn:settings:CheckSchedule:cron":"2 1 2 1 1","urn:settings:CheckSchedule:DurationMinutes":0,"urn:settings:LogUploadSettings:Message":null,"urn:settings:LogUploadSettings:Name":"RDKB_telemetry","urn:settings:LogUploadSettings:NumberOfDays":0,"urn:settings:LogUploadSettings:UploadRepositoryName":"RDKB_telemetry","urn:settings:LogUploadSettings:RepositoryURL":"tftp://35.155.171.121","urn:settings:LogUploadSettings:UploadOnReboot":true,"urn:settings:LogUploadSettings:UploadImmediately":false,"urn:settings:LogUploadSettings:upload":true,"urn:settings:LogUploadSettings:UploadSchedule:cron":"2 1 1 1 1","urn:settings:LogUploadSettings:UploadSchedule:levelone:cron":null,"urn:settings:LogUploadSettings:UploadSchedule:leveltwo:cron":null,"urn:settings:LogUploadSettings:UploadSchedule:levelthree:cron":null,"urn:settings:LogUploadSettings:UploadSchedule:DurationMinutes":0,"urn:settings:VODSettings:Name":null,"urn:settings:VODSettings:LocationsURL":null,"urn:settings:VODSettings:SRMIPList":null,"urn:settings:TelemetryProfile":{"id":"72ac2ca9-b248-4a5e-b120-27ff37382564","telemetryProfile":[{"header":"Firewall","content":"starting firewall service","type":"FirewallDebug.txt","pollingFrequency":"1"}],"schedule":"3","expires":0,"telemetryProfile:name":"RDKB_tele","uploadRepository:URL":"35.155.171.121","uploadRepository:uploadProtocol":"TFTP"}}

Sample: 2  HTTP

root@RaspberryPi-Gateway:~# curl -i 'http://35.155.171.121:9092/loguploader/getSettings?estbMacAddress=B8:27:EB:22:16:36'
HTTP/1.1 200 OK

Date: Fri, 31 Jan 2020 12:15:26 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Server: Jetty(9.2.1.v20140609)

{"urn:settings:GroupName":"RDKB_telemetry","urn:settings:CheckOnReboot":true,"urn:settings:CheckSchedule:cron":"2 1 2 1 1","urn:settings:CheckSchedule:DurationMinutes":0,"urn:settings:LogUploadSettings:Message":null,"urn:settings:LogUploadSettings:Name":"RDKB_telemetry","urn:settings:LogUploadSettings:NumberOfDays":0,"urn:settings:LogUploadSettings:UploadRepositoryName":"RDKB_telemetry","urn:settings:LogUploadSettings:RepositoryURL":"http://35.155.171.121/xconf/logupload.php","urn:settings:LogUploadSettings:UploadOnReboot":true,"urn:settings:LogUploadSettings:UploadImmediately":false,"urn:settings:LogUploadSettings:upload":true,"urn:settings:LogUploadSettings:UploadSchedule:cron":"2 1 1 1 1","urn:settings:LogUploadSettings:UploadSchedule:levelone:cron":null,"urn:settings:LogUploadSettings:UploadSchedule:leveltwo:cron":null,"urn:settings:LogUploadSettings:UploadSchedule:levelthree:cron":null,"urn:settings:LogUploadSettings:UploadSchedule:DurationMinutes":0,"urn:settings:VODSettings:Name":null,"urn:settings:VODSettings:LocationsURL":null,"urn:settings:VODSettings:SRMIPList":null,"urn:settings:TelemetryProfile":{"id":"72ac2ca9-b248-4a5e-b120-27ff37382564","telemetryProfile":[{"header":"Firewall","content":"starting firewall service","type":"FirewallDebug.txt","pollingFrequency":"1"}],"schedule":"3","expires":0,"telemetryProfile:name":"RDKB_tele","uploadRepository:URL":"http://35.155.171.121/xconf/telemetry_upload.php","uploadRepository:uploadProtocol":"HTTP"}}


2. Configuration file

  • Once the profile details are successfully retrieved , the conf file will be created under /tmp which has the server configurations 
  • The telemetry markers are compared with the corresponding log files and if the match is found then the markers are uploaded to the http://35.155.171.121/xconf/upload/
  • Sample 1: tftp
    root@RaspberryPi-Gateway:~# cat /tmp/DCMSettings.conf

    urn:settings:GroupName=RDKB_telemetry
    urn:settings:CheckOnReboot=true
    urn:settings:CheckSchedule:cron=2 1 2 1 1
    urn:settings:CheckSchedule:DurationMinutes=0
    urn:settings:LogUploadSettings:Message=null
    urn:settings:LogUploadSettings:Name=RDKB_telemetry
    urn:settings:LogUploadSettings:NumberOfDays=0
    urn:settings:LogUploadSettings:UploadRepositoryName=RDKB_telemetry
    urn:settings:LogUploadSettings:RepositoryURL=tftp://35.155.171.121
    urn:settings:LogUploadSettings:UploadOnReboot=true
    urn:settings:LogUploadSettings:UploadImmediately=false
    urn:settings:LogUploadSettings:upload=true
    urn:settings:LogUploadSettings:UploadSchedule:cron=2 1 1 1 1
    urn:settings:LogUploadSettings:UploadSchedule:levelone:cron=null
    urn:settings:LogUploadSettings:UploadSchedule:leveltwo:cron=null
    urn:settings:LogUploadSettings:UploadSchedule:levelthree:cron=null
    urn:settings:LogUploadSettings:UploadSchedule:DurationMinutes=0
    urn:settings:VODSettings:Name=null
    urn:settings:VODSettings:LocationsURL=null
    urn:settings:VODSettings:SRMIPList=null
    "urn:settings:TelemetryProfile":{"id":"72ac2ca9-b248-4a5e-b120-27ff37382564","telemetryProfile":[{"header" : "Firewall","content" : "staring firewall service","type" : "FirewallDebug.txt","pollingFrequency":"1"}],"schedule":"3","expires":0,"telemetryProfile:name":"RDKB_tele,"uploadRepository:URL":"35.155.171.121","uploadRepository:uploadProtocol":"TFTP"}


    Sample 2:  http

    root@RaspberryPi-Gateway:~# cat /tmp/DCMSettings.conf

    urn:settings:GroupName=RDKB_telemetry
    urn:settings:CheckOnReboot=true
    urn:settings:CheckSchedule:cron=2 1 2 1 1
    urn:settings:CheckSchedule:DurationMinutes=0
    urn:settings:LogUploadSettings:Message=null
    urn:settings:LogUploadSettings:Name=RDKB_telemetry
    urn:settings:LogUploadSettings:NumberOfDays=0
    urn:settings:LogUploadSettings:UploadRepositoryName=RDKB_telemetry
    urn:settings:LogUploadSettings:RepositoryURL=http://35.155.171.121/xconf/logupload.php
    urn:settings:LogUploadSettings:UploadOnReboot=true
    urn:settings:LogUploadSettings:UploadImmediately=false
    urn:settings:LogUploadSettings:upload=true
    urn:settings:LogUploadSettings:UploadSchedule:cron=2 1 1 1 1
    urn:settings:LogUploadSettings:UploadSchedule:levelone:cron=null
    urn:settings:LogUploadSettings:UploadSchedule:leveltwo:cron=null
    urn:settings:LogUploadSettings:UploadSchedule:levelthree:cron=null
    urn:settings:LogUploadSettings:UploadSchedule:DurationMinutes=0
    urn:settings:VODSettings:Name=null
    urn:settings:VODSettings:LocationsURL=null
    urn:settings:VODSettings:SRMIPList=null
    "urn:settings:TelemetryProfile":{"id":"72ac2ca9-b248-4a5e-b120-27ff37382564","telemetryProfile":[{"header" : "Firewall","content" : "starting firewall service","type" : "FirewallDebug.txt","pollingFrequency":"1"}],"schedule":"3","expires":0,"telemetryProfile:name":"RDKB_tele","uploadRepository:URL":"http://35.155.171.121/xconf/telemetry_upload.php","uploadRepository:uploadProtocol":"HTTP"}

 3. Logs

  • Log file to monitor and analyze the files which are uploaded to server
  • /rdklogs/logs/dcmscript.log
    TFTP 


    HTTP


  • /rdklogs/logs/telemetry.log
    TFTP


    HTTP


4. Xconf-Server

           HTTP   
          Image Modified

Configuring more than one profile

...

  • Save
  • In Rpi , make sure that you stopped the rdkbLogMontior service , in order to stop the log rotation process (systemctl stop rdkbLogMonitor)
  • Now restart the dcm-log service using systemctl restart dcm-log
  • With successful response , tar file and JSON file gets uploaded to the xconf-server
  • Open the upload JSON file in the browser
  • We could see the profile entries with the number of times the specified marker has appeared in the file.

    Sample:

    {"searchResult":[{"Firewall":"1"},{"Wifihealth_1":"2"},{"Wifihealth_2":"2"},{"Profile":"RDKB"},{"mac":"B8:27:EB:22:16:36"},{"erouterIpv4":"192.168.30.125"},{"erouterIpv6":"null"},{"PartnerId":"RDKM"},{"AccountId":"Unknown"},{"Version":"rdkb-generic-broadband-image_default_20200224150713"},{"Time":"2020-02-26 12:23:51"}]}


    NOTE : JSON file holds only the number of times the particular marker has appeared in the respective log file. To see the complete log file, need to download the tar file uploaded and extract the files to see the complete logs or value of the parameters