Versions Compared

Old Version 5

changes.mady.by.user Abhija Jayan

Saved on

compared with

New Version 6

changes.mady.by.user Abhija Jayan

Saved on

Key

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

...

How to setup the telemetry upload setup

...

Server Prerequisites

VM :  Ubuntu 20.04 +

Given below is the VM Configuration for the RDKM reference setup, the configs needs to be modified as per the requirement

 VM Configuration

  • RAM : 16GB
  • Disk space :  128 GB
  • Ubuntu : 20.04.6 LTS )

Install Java

  1. Run the following commands from the command line
Code Block
$ sudo apt update
$ sudo apt install openjdk-8-jdk

      2. Check Java installation by running the below command

Code Block
$ java -version

      3. The output should look something like this:

Code Block
openjdk version "1.8.0_252"
OpenJDK Runtime Environment (build 1.8.0_252-8u252-b09-1ubuntu1-b09)
OpenJDK 64-Bit Server VM (build 25.252-b09, mixed mode)

...

Install Maven

  1. Install Maven using the command below:
Code Block
sudo apt-get -y install maven

     2. Verify the Apache Maven version using the following command:

Code Block
mvn -version

Checkout and create war

Check out the code from  : https://github.com/rdkcentral/telemetry-data-collector

...

     

Elasticsearch configuration in application.properties

There are  upload APIS for RDKB and RDKV devices separately in the microservice. So we need to  setup elastic search URL and indexes corresponding to rdkb and rdkv in  telemetry-collector\src\main\resources\application.properties. Sample application.properties with reference setup Elastic search given. Change the elastic search URL corresponding to your elastic search-Kibana setup

Code Block
rdkv.index=rdkv-telemetry
rdkb.index=rdkb-telemetry
elasticsearch.url=http://52.71.72.93:9200/  <Change this accordingly>


server.port=8080

      2.   Go to telemetry-collector and run the below maven command

Code Block
mvn clean install

     3. War file- telemetry-collector.war will be created in the folder - telemetry-collector\target 

Install Tomcat 9

  1. Download Tomcat 9 from the Apache Tomcat Archive with the below given step
Code Block
wget -c https://downloads.apache.org/tomcat/tomcat-9/v9.0.85/bin/apache-tomcat-9.0.85.tar.gz

       2. Extract the Tomcat archive to the directory in which you want to deploy the Automatics Tools

Code Block
sudo tar -xvf apache-tomcat-9.0.85.tar.gz -C /opt/automatics/

 Deployment of the war  

  1. Copy the telemetry-collector.war file to the apache-tomcat/webapps folder.
  2. Navigate to apache-tomcat/bin directory and start the server by executing command.
Code Block
./startup.sh

     3. Sample output is given below

Image Removed


...

Elastic Search -  Kibana Setup


Server Prerequisites

VM :  Ubuntu 20.04 +

You can either deploy the EK setup in the same VM or use another VM. For reference setup, we have used two separate  ubuntu server instances

...

  • RAM : 16GB
  • Disk space :  300 GB
  • Ubuntu : 20.04.6 LTS 


Install Java

  1. Run the following commands from the command line

...

Configure Kibana for the dashboard



Create required index for RDKB and RDKV as per the requirement


  1. We need to create index for RDKV and RDKB as per the requirement
  2. To create an index from the command line, run the below given curl command for creating RDKB telemetry index in elastic search DB
Code Block
curl -X PUT "localhost:9200/rdkb-telemetry" -H 'Content-Type: application/json' -d'
{
  "mappings": {
    "properties": {
      "Time": {
        "type": "date" ,
         "format": "yyyy-MM-dd HH:mm:ss"
      }
    }
  }
}


'

     To create RDKV index in elastic search DB, run the following command


Code Block
curl -X PUT "localhost:9200/rdkv-telemetry" -H 'Content-Type: application/json' -d'
{
  "mappings": {
    "properties": {
      "Time": {
        "type": "date" ,
         "format": "yyyy-MM-dd HH:mm:ss"
      }
    }
  }
}
'


     3. To create an index from the  Kibana 

  •   Click on menu

    Image Added


  • Go to DevTools under 'Management tools'

    Image Added


  • Go to 'Console' tab

Image Added


  • Paste the below code and click on the execute button to create index for RDKB


Code Block

PUT /rdkb-telemetry
{
  "mappings": {
    "properties": {
      "Time": {
        "type": "date" ,
         "format": "yyyy-MM-dd HH:mm:ss"
      }
    }
  }
}


  • Paste the below code and click on the execute button to create index for RDKB


Code Block

PUT /rdkv-telemetry
{
  "mappings": {
    "properties": {
      "Time": {
        "type": "date" ,
         "format": "yyyy-MM-dd HH:mm:ss"
      }
    }
  }
}

Image Added


Configuring the index for use in the dashboard


  1. Go to the menu Stack management →Index patterns. Click on 'Create index pattern'

Image Added


   2.  If you want to setup RDKB telemetry dashboard, add name as rdkb-telemetry, Select 'Time' from the drop down menu, You will get a message like this - 'Your index pattern matches 1 source.' Click on 'Create index pattern'


If you want to setup RDKV telemetry dashboard, add name as rdkv-telemetry, Select 'Time' from the drop down menu, You will get a message like this - 'Your index pattern matches 1 source.' Click on 'Create index pattern'.


Image Added


Telemetry collector microservice application

Server Prerequisites

VM :  Ubuntu 20.04 +


Given below is the VM Configuration for the RDKM reference setup, the configs needs to be modified as per the requirement

 VM Configuration

  • RAM : 16GB
  • Disk space :  128 GB
  • Ubuntu : 20.04.6 LTS )

Install Java

  1. Run the following commands from the command line
Code Block
$ sudo apt update
$ sudo apt install openjdk-8-jdk

      2. Check Java installation by running the below command

Code Block
$ java -version

      3. The output should look something like this:

Code Block
openjdk version "1.8.0_252"
OpenJDK Runtime Environment (build 1.8.0_252-8u252-b09-1ubuntu1-b09)
OpenJDK 64-Bit Server VM (build 25.252-b09, mixed mode)


War creation

Install Maven

  1. Install Maven using the command below:
Code Block
sudo apt-get -y install maven


     2. Verify the Apache Maven version using the following command:

Code Block
mvn -version


Checkout and create war


Check out the code from  : https://github.com/rdkcentral/telemetry-data-collector

Code Block
     
Elasticsearch configuration in application.properties
There are  upload APIS for RDKB and RDKV devices separately in the microservice. So we need to  setup elastic search URL and indexes corresponding to rdkb and rdkv in  telemetry-collector\src\main\resources\application.properties. Sample application.properties with reference setup Elastic search given. Change the elastic search URL corresponding to your elastic search-Kibana setup
 Code Block
rdkv.index=rdkv-telemetry
rdkb.index=rdkb-telemetry
elasticsearch.url=http://52.71.72.93:9200/  <Change this accordingly>


server.port=8080

      2.   Go to telemetry-collector and run the below maven command

 Code Block
mvn clean install

     3. War file- telemetry-collector.war will be created in the folder - telemetry-collector\target 

Install Tomcat 9

  1. Download Tomcat 9 from the Apache Tomcat Archive with the below given step
 Code Block
wget -c https://downloads.apache.org/tomcat/tomcat-9/v9.0.85/bin/apache-tomcat-9.0.85.tar.gz

       2. Extract the Tomcat archive to the directory in which you want to deploy the Automatics Tools
 Code Block
sudo tar -xvf apache-tomcat-9.0.85.tar.gz -C /opt/automatics/

 Deployment of the war  

  1. Copy the telemetry-collector.war file to the apache-tomcat/webapps folder.
  2. Navigate to apache-tomcat/bin directory and start the server by executing command.
 Code Block
./startup.sh
     3. Sample output is given below
Image Added

     4. Logs can be found in the file -  apache-tomcat<>/logs/catalina.out