search

cds-snc / covid-alert-server

Exposure Notification: Diagnosis Server implementation / Notification d’exposition : Mise en œuvre du serveur de diagnostic
Apache License 2.0
298 stars 31 forks source link

Update Documentation for Event Tracking #329

Closed CalvinRodo closed 3 years ago

CalvinRodo commented 3 years ago

Description

Add documentation for the OTK (One Time Key) events that are now being captured in the Covid Alert Server. The names of the events are not super intuitive and so some documentation will help with understanding what is being captured.

AC

stephenyates-gc commented 3 years ago

Requires translation to complete

CalvinRodo commented 3 years ago

Si vous souhaitez utiliser Prometheus, lisez les exigences de configuration à la fin.

Événements du serveur

Le serveur fait le suivi des événements suivants de façon agrégée par jour ou par heure, et par desserveur (Bearer Token).

OTKGenerated

Assure le suivi du nombre de clés à usage unique (OTK) générées lorsque le point d’extrémité /new-key-claim est appelé.

OTKClaimed

Assure le suivi du nombre de clés à usage unique (OTK) générées lorsque le point d’extrémité /claim-key est appelé. Événement réalisé lorsqu’une clé à usage unique est entrée dans l’application par un citoyen.

OTKUnclaimed

Assure le suivi du nombre de clés à usage unique (OTK) qui n’ont pas été réclamées et dont le délai est en deçà de la valeur de configuration config.AppConstants.OneTimeCodeExpiryInMinutes.

OTKExpired

Assure le suivi du nombre de clés à usage unique (OTK) qui ont expiré dans la base de données. Une clé expire lorsqu’elle a été réclamée mais que son délai dépasse config.AppConstants.EncryptionKeyValidityDays.

OTKExhausted

Suivi du nombre de clés à usage unique (OTK) dont le champ remaining_keys est 0 dans le tableau encryption_keys.

OTKRegenerated

Suivi du nombre de fois où le point d’extrémité /new-key-claim est appelé avec un hashID existant. Lorsque cela se produit, la clé à usage unique existante est supprimée, et une nouvelle clé à usage unique est générée.

OTKExpiredNoUploads

Suivi du nombre de clés à usage unique (OTK) qui ont été réclamées et qui ont expiré sans que les clés d’exposition temporaires (temporary exposure keys) ne soient téléversées.

OTKDurations

Suivi de la durée pendant laquelle les clés à usage unique (OTK) sont non réclamées. Valeur en nombre d’heures, arrondie à la hausse.

Prometheus

Pour utiliser Prometheus aux fins de mesures de performance, vous devrez l’exécuter dans votre environnement.