ARC: Telemetry

This space is created to document the telemetry requirements of Android Registration Client.

Event Types:

1. Error

2. Start

3. Impression

4. Interact

5. End (success)

6. End (Failure)

Action Types:

1. Warning

2. Error

Kimd devices, number of users,

Age, location, exceptions, failed biometrics, biometrics quality,

Types of events to be captured

1. Start - for session start and any flow start

2. Impression - to capture the screen transition

3. Interact - to capture user actions like button clicks

4. Error - to capture any error

5. End - for session end and any flow end

6. Summary - for Tuvali

7. AppInfo - for capturing the device/app details

Refer below screenshot to check the sample flow of events

Open

Events structure

1. Initialise telemetry with config - this will be done at start of the application
   Data tracked in configuration

   { "env": "https://api.qa-triad.mosip.net", "authtoken": "", "appid": "T8H7CJG3FBLQ", "sid": "aVtGWoklTGMh1693393576457", "batchsize": 5, "host": "https://dataset-api.obsrv.mosip.net" "endpoint": "/obsrv/v1/data/mosip-dataset", "telemetryDebugEnabled": true, "enableValidation": true, "schemaBaseUrl": "http://mosip.io/telemetry/" }

2. Start event

   { "eid": "START", "ets": 1692958280000, "mid": "START:229ebf7711a0d19a8df962998992480a", "actor": {}, "sid": "fQyLnBqZOPFr1692958174221", "appid": "T8H7CJG3FBLQ", "edata": { "type": "what is the workflow we are starting the event for", "additionalParameters": {} } }

3. Impression event

   { "eid": "IMPRESSION", "ets": 1692958280000, "mid": "IMPRESSION:229ebf7711a0d19a8df962998992480a", "actor": {}, "sid": "fQyLnBqZOPFr1692958174221", "appid": "T8H7CJG3FBLQ", "edata": { "type": "what is the workflow", "subtype": "page name we are on", "additionalParameters": {} } }

4. Interact event

   { "eid": "INTERACT", "ets": 1692958280000, "mid": "INTERACT:229ebf7711a0d19a8df962998992480a", "actor": {}, "sid": "fQyLnBqZOPFr1692958174221", "appid": "T8H7CJG3FBLQ", "edata": { "type": "what is the workflow", "subtype": "TOUCH/SWIPE/GESTURE_what are we clicking on", "additionalParameters": {} } }

5. Error event

   { "eid": "ERROR", "ets": 1692958280000, "mid": "ERROR:229ebf7711a0d19a8df962998992480a", "actor": {}, "sid": "fQyLnBqZOPFr1692958174221", "appid": "T8H7CJG3FBLQ", "edata": { "type": "what is the workflow for which we got the error", "env": "https://api.qa-triad.mosip.net", "brandName": "realme", "modelName": "RX396", "osName": "Android", "osVersion": "11", "osApiLevel": "30", "isHardwareKeystoreSupported": "true", "buildNumber": "5", "injiVersion": "0.9.1", "tuvaliVersion": "v0.4.3-768a7fc", "dateTime": "Wed Sep 06 2023 14:11:37 GMT+0530", "zone": "Asia/Calcutta", "offset": -330, "preferredLanguage": "English", "errorId": "error id", "errorMessage": "error message", "stackTrace": "complete stack trace of the error", } }

6. End event

   { "eid": "END", "ets": 1692958280000, "mid": "END:229ebf7711a0d19a8df962998992480a", "actor": {}, "sid": "fQyLnBqZOPFr1692958174221", "appid": "T8H7CJG3FBLQ", "edata": { "type": "what is the workflow for this event", "status": "failure / success", "additionalParameters": {} } }

7. Summary Event
   Tuvali VC Transfer Debug report

8. AppInfo Event

   { "eid": "APPINFO", "ets": 1692958280000, "mid": "APPINFO:229ebf7711a0d19a8df962998992480a", "sid": "fQyLnBqZOPFr1692958174221", "actor": {}, "appid": "T8H7CJG3FBLQ", "edata": { "env": "https://api.qa-triad.mosip.net", "brandName": "realme", "modelName": "RX396", "osName": "Android", "osVersion": "11", "osApiLevel": "30", "isHardwareKeystoreSupported": "true", "buildNumber": "5", "injiVersion": "0.9.1", "tuvaliVersion": "v0.4.3-768a7fc", "dateTime": "Wed Sep 06 2023 14:11:37 GMT+0530", "zone": "Asia/Calcutta", "offset": -330, "preferredLanguage": "English" } }

Data which should not be captured in Telemetry

• User’s personal information (PII)

  • user id, name, device model name, device storage, signatures and certificates, device id

• Credentials related information