usage-monitoring.md

Usage monitoring

Telemetry Process

Telemetry is a database which provides the website traffic information to the users. This tool provides datapoints like number of visitors, their access style (devices) and the report type they have accessed, etc.

1. KPIs/Metrics captured:

a. Most Visited Landing Pages

b. Users Count

c. Average time spent on each page

d. Unique Users across Browser & Device Types

e. Roll-Up of users using (Daily, Weekly)

f. Click, Select, Download

2. Define Events, Dimensions & Schema

eventName : telemetry-event.data

date	timestamp	userId	pageName	pageEvent	pageEventName	deviceType	userLocation	browserType	timeSpent	timeIn	timeOut
24/04/23	13:00:11	cf797e0a-b857-47f1-b0d7-10bd83231421	teacher-attendance	click	download	web	Bengaluru	chrome
24/04/23	13:00:11	cf797e0a-b857-47f1-b0d7-10bd83231421	teacher-attendance	onload	pageLoad	mobile	Bengaluru	firefox	3213	13:10:02	13:13:02
24/04/23	13:00:11	cf797e0a-b857-47f1-b0d7-10bd83231421	pgi	click	apply	web	Bengaluru	chrome
24/04/23	13:00:11	cf797e0a-b857-47f1-b0d7-10bd83231421	teacher-attendance	click	cancel	mobile	Bengaluru	chrome
24/04/23	13:00:11	cf797e0a-b857-47f1-b0d7-10bd83231421	login	login

3. Workflow

The diagram explains about the flow of the telemetry works.

4. Visualize the reports.
5. Steps done for enabling telemetry

a. Create a python script for splitting up multi metrics into single metric (https://github.com/Sunbird-cQube/generator-ms/blob/release-v5.0.5/adapter/telemetry.py).

b. Add the telemetry details in config.json file (https://github.com/Sunbird-cQube/processing-ms/blob/release-v5.0.5/impl/c-qube/ingest/VSK/config.json).

c. Create nifi processor group to schedule for moving data and processing

d. Add new UI report

e. Add the logics in UI to capture the events

f. Create the grammars