UNDER CONSTRUCTION !!

Architecture and working principle

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 setup

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

$ sudo apt update
$ sudo apt install openjdk-8-jdk

      2. Check Java installation by running the below command

$ java -version

      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)

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

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

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

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 :  300 GB
• Ubuntu : 20.04.6 LTS 

Install Java

1. Run the following commands from the command line

$ sudo apt update
$ sudo apt install openjdk-8-jdk

      2. Check Java installation by running the below command

$ java -version

      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 NGINX

1. Install Nginx by running the following command from command line:

sudo apt-get install nginx

     2. If prompted, type y and hit Enter for the process to finish.

Install ElasticSearch

Elastic repositories enable access to all the open-source software in the ELK stack. To add them, start by importing the GPG key.

1 . Enter the following into terminal window to import the PGP key for Elastic:

wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -

2.The system should respond with OK,

3. Next, install the apt-transport-https package:

sudo apt-get install apt-transport-https

4. Add the Elastic repository to your system’s repository list:

echo "deb https://artifacts.elastic.co/packages/7.x/apt stable main" | sudo tee –a /etc/apt/sources.list.d/elastic-7.x.list

5. Prior to installing Elasticsearch, update the repositories by entering:

sudo apt-get update

6. Install Elasticsearch with the following command:

sudo apt-get install elasticsearch

7. Elasticsearch uses a configuration file to control how it behaves. Edit the file.

sudo nano /etc/elasticsearch/elasticsearch.yml

8. You should see a configuration file with several different entries and descriptions. Scroll down to find the following entries:

#network.host: 192.168.0.1
#http.port: 9200

9.Uncomment the lines by deleting the hash (#) sign at the beginning of both lines and replace 192.168.0.1 with localhost.

network.host: localhost

http.port: 9200

10 . Just below, find the Discovery section. We are adding one more line, as we are configuring a single node cluster:

discovery.type: single-node

11. By default, JVM heap size is set at 1GB. It is recommended setting it to no more than half the size of your total memory. Open the following file for editing:

sudo nano /etc/elasticsearch/jvm.options

12. Find the lines starting with -Xms and -Xmx  and set the value. In reference setup we set it as 4gb

13. Start the Elasticsearch service by running a systemctl command: 

It may take some time for the system to start the service. There will be no output if successful.

sudo systemctl start elasticsearch.service