...

Architecture and a brief overview of the work flow

Advantages of the reference telemetry setup

1.Real-Time Monitoring: Telemetry dashboards provide real-time monitoring of systems and processes. This allows for immediate detection and response to any issues or anomalies, enhancing operational efficiency and reducing downtime.

2.Data Visualization: They convert complex data sets into easy-to-understand visual formats like graphs, charts, and maps. This aids in quicker comprehension and better decision-making by presenting data in a user-friendly manner.

3.Performance Analysis: By tracking various metrics and KPIs, telemetry dashboards enable detailed performance analysis. This can lead to insights into trends, patterns, and potential areas for improvement.

How to setup the telemetry upload system

Elastic Search -  Kibana Setup

Server Prerequisites

VM :  Ubuntu 20.04 +

• Telemetry is configured in the RDKB /RDKV devices with on xconf(Single profile telemetry) based telemetry or telemetry2 multiprofile based telemetry.
• The upload URL will be configured as the Telemetry-collector microservice URL , So data will be uploaded to the microservice from the boxes.
• Telemetry microservice is a springboot based microservice that will receive the telemetry data, parses it and sends the processed data to Elastic Search
• Elastic search DB is  where the data is stored, It  is deployed along with Kibana.
• Kibana is a data visualization tool and  user can analyze and filter out the data stored in Elasticsearch DB , with Kibana
• Kibana Admin user will create dashboards based on the requirements from the end user.

Advantages of the reference telemetry setup

1.Real-Time Monitoring: Telemetry dashboards provide real-time monitoring of systems and processes. This allows for immediate detection and response to any issues or anomalies, enhancing operational efficiency and reducing downtime.

2.Data Visualization: They convert complex data sets into easy-to-understand visual formats like graphs, charts, and maps. This aids in quicker comprehension and better decision-making by presenting data in a user-friendly manner.

3.Performance Analysis: By tracking various metrics and KPIs, telemetry dashboards enable detailed performance analysis. This can lead to insights into trends, patterns, and potential areas for improvement.

How to setup the telemetry upload system

Elastic Search -  Kibana Setup

Server Prerequisites

VM :  Ubuntu 20.04 +

You 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

...

      3. The output should look something like this:

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:

sudo apt-get -y install maven

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

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

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

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

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

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.

./startup.sh

     3. Sample output is given below

Image Removed

...

:

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:

sudo apt-get -y install maven

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

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

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

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

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

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.

./startup.sh

     3. Sample output is given below

Image Added

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

Telemetry upload APIS

The APis support upload of both telemetry (Single profile) and telemetry(Multi Profile) which are in different JSON schema/format

RDKB telemetry upload API : 

http://<Server IP/FQDN>:8080/telemetry-collector/rdkb-collector

RDKV telemetry upload API

http://<Server IP/FQDN>:8080/telemetry-collector/rdkv-collector

Reference setup details