SarutobiDocumentation

Nommer ses events

Quatre règles. Elles ne servent pas l'esthétique : chacune évite une façon précise de rendre le dashboard illisible dans six mois.

1. Un verbe au passé, en snake_case

sarutobi.capture("article_shared");   // ✓
sarutobi.capture("filter_applied");   // ✓
sarutobi.capture("account_created");  // ✓

sarutobi.capture("Partager");         // ✗ pas un état de fait
sarutobi.capture("clickButton");      // ✗ décrit le geste, pas ce qui s'est produit

Un nom d'event décrit ce qui s'est passé, pas ce que l'utilisateur a touché. « Un article a été partagé » reste vrai si vous remplacez le bouton par un menu.

2. Jamais d'identifiant dans le nom

sarutobi.capture("article_shared", { article_id: "a1b2c3" });  // ✓
sarutobi.capture("article_shared_a1b2c3");                     // ✗

Un identifiant dans le nom fait exploser la dimension : au lieu d'une ligne « article_shared : 1 240 », vous obtenez 1 240 lignes à un exemplaire, et plus aucun total n'est calculable.

3. Des valeurs à faible cardinalité

Le dashboard signale les propriétés dépassant cent valeurs distinctes comme inexploitables, plutôt que de les afficher sur cent lignes. Une propriété doit répondre à « combien » ou « lequel », jamais à « qui ».

{ placement: "hero", variant: "primary" }  // ✓ agrégeable
{ click_id: "a1b2c3" }                      // ✗ unique à chaque appel

Un identifiant reste utile pour retrouver un cas précis dans vos propres journaux : envoyez-le si vous en avez besoin, mais sachez qu'il ne produira aucune statistique.

4. Jamais de donnée personnelle

Même chose pour les URL : évitez /profil/[email protected]. Préférez un segment opaque, ou excluez le chemin depuis les réglages du site.

Sur un site sensible, beforeSendpermet d'ajouter un filtre défensif qui supprime les clés suspectes avant l'envoi.

Types acceptés

Les valeurs de propriétés peuvent être des chaînes, nombres, booléens ou null. Un tableau ou un objet imbriqué est ignoré : Postgres saurait les stocker, mais le dashboard ne saurait pas les agréger, donc autant refuser franchement.

Trente-deux clés au maximum par event, cinq cent douze caractères par valeur — au-delà, la valeur est tronquée et la clé écartée.