Client telemetry

[cchudant]

Description

Here are the info it collects:

For every event,

• uid is a unique id created by taking the sha256 of the hostname and username of the machine
• platform, composed of os, release, version, arch. Example:
  • os: Linux/Windows
  • release: 5.13.19-2-MANJARO on my machine
  • version: SMP PREEMPT Sun Sep 19 21:31:53 UTC 2021 on my machine (kernel/windows version)
  • arch: x86_64
• the time

Event list:

class ConnectEvent(Event):
    simulation: bool
    policy_allow_debug: Optional[bool]
    server_sgx_enabled: bool
    server_platform: str
    server_version: str
class SendModelEvent(Event):
    simulation: bool
    policy_allow_debug: Optional[bool]
    server_sgx_enabled: bool
    server_platform: str
    server_version: str
    sign: bool
class RunModelEvent(Event):
    simulation: bool
    policy_allow_debug: Optional[bool]
    server_sgx_enabled: bool
    server_platform: str
    server_version: str
    sign: bool

server_platform, server_platform and server_version are sent by the server to the client using the GetServerInfo call.

This builds upon #48, so i expect conflicts if #48 gets new commits.

Questions

• Should we remove the server-side telemetry?
• Are the infos I collect here enough / too much?
• I am making a call to amplitude every time the client connects/send_model/run_model
  • this makes me worry about performance, since we don't batch events, we send them one at a time at every request..
  • also, connect/send_model/run_model has to block until the amplitude request is fully sent, nothing is done in the background and it's fully synchronous
  • maybe there is a better way => an alternative is to send more info to the server when doing a request (like the client uid for example, client version, client platform..)
  • this may mean we don't have to do client-side telemetry, which imo is a better idea? what do you think
• I then need to update the documentation (docs / readme / everywhere we talk about telemetry)

These questions will need to get answered before I can make more progress :) @dhuynh95 @JoFrost

Related Issue

Closes #46

Type of change

• [x] This change requires a documentation update
• [x] This change affects the client
• [x] This change affects the server
• [ ] This change affects the API
• [ ] This change only concerns the documentation

How Has This Been Tested?

Tested locally and using the amplitude dashboard, and it works :)

Checklist:

• [ ] My code follows the style guidelines of this project
• [ ] I have performed a self-review of my code
• [ ] I have commented my code, particularly in hard-to-understand areas
• [ ] My changes generate no new warnings
• [ ] I have updated the documentation according to my changes