Accès anticipéSur invitation, et les SDK ne sont pas encore publiés.Demander une invitation
Aller au contenu
Docs

Clés

Les clés d'ingestion ne font qu'écrire et sont publiques par conception ; les clés serveur, de lecture et d'administration restent sur un serveur.

Une clé (key) appartient à un projet et a l'une de quatre portées. Son préfixe indique laquelle.

PortéePréfixeNom dans le tableau de bordCe qu'elle permetOù elle vit
Ingestionlyr_ing_Send eventsAjouter des événements, rien d'autreDans votre app ou votre page web
Serveurlyr_srv_Send events from a serverAjouter des événements, rien d'autre. Ses événements sont vérifiés.Votre backend uniquement. Gardez-la secrète.
Lecturelyr_read_Read eventsInterroger les événementsUn serveur ou un script. Gardez-la secrète.
Administrationlyr_adm_Full accessEnvoyer des événements et les interroger, pour les tâches d'administrationUn serveur. Gardez-la secrète.

Une clé de lecture interroge les événements de son projet via l'API de lecture : depuis un script, un notebook ou un agent sur un serveur. Elle lit tout ce que contient le projet, elle ne va donc jamais dans une app ni dans une page web.

Une clé serveur envoie des événements depuis votre backend : depuis le SDK Node, Python, Go ou JVM, ou avec curl. Comme une clé d'ingestion, elle ne peut pas lire, mais c'est un secret : les événements qu'elle envoie sont marqués vérifiés, parce que seuls vos serveurs la détiennent, et le quota journalier d'une adresse ne s'applique pas à elle. Elle ne va jamais dans une app ni dans une page web. Les apps et les pages web utilisent la clé d'ingestion.

Pourquoi une clé d'ingestion peut être publique

Une clé d'ingestion est livrée dans le binaire de votre app ou dans votre page web : partez du principe que n'importe qui peut la lire. Ce n'est pas un problème, car elle ne peut qu'ajouter des événements à son projet : elle ne peut rien lire, modifier ni supprimer. Le projet dans lequel un événement atterrit est toujours déterminé par la clé, jamais par l'événement. Pour limiter les abus, chaque projet a une limite de débit (60 000 événements par minute par défaut), et un lot qui la dépasse reçoit 429. Une adresse ne peut en outre envoyer avec elle qu'un quota journalier, une fraction du mois de l'organisation.

En contrepartie : quiconque détient la clé d'ingestion peut envoyer des événements semblables à ceux de votre app, ils ne sont donc pas vérifiés, sauf s'ils viennent de votre app Apple et qu'Apple le prouve avec App Attest, ou de votre app Android et que le téléphone le prouve avec Key Attestation. Ces événements-là ne comptent pas non plus dans le quota journalier.

Les clés ne s'affichent qu'une fois

Lyrelog ne stocke qu'un hash SHA-256 de chaque clé. Vous voyez la clé une seule fois, à sa création : copiez-la à ce moment-là. Une clé perdue ne se récupère pas ; créez-en une autre.

Créer et révoquer

Les clés se trouvent sur la page API keys du projet : Settings, puis API keys, ou ⌘ K et API keys. Seuls les propriétaires peuvent les créer et les révoquer.

  • Un projet a au plus 20 clés actives. Révoquez-en une pour en créer une autre.
  • Les clés n'expirent pas : une clé fonctionne jusqu'à sa révocation, ou jusqu'à la suppression de son projet.
  • Créer une clé Send events from a server, Read events ou Full access demande une connexion récente (dans les 10 dernières minutes). Pas les clés Send events.
  • Quand quelqu'un quitte une organisation ou en est retiré, les clés de lecture et d'accès complet qu'il a créées sont révoquées. Les clés d'ingestion restent, parce que des apps déjà distribuées envoient avec elles. Les clés serveur restent aussi, parce que vos serveurs envoient avec elles : si la personne partie en a vu une, révoquez-la et remplacez-la.
  • Tous les membres de l'organisation voient la liste des clés et la date de dernière utilisation de chacune.

Une clé révoquée cesse aussitôt de fonctionner ; comptez jusqu'à une minute. Un SDK qui reçoit 401 ou 403 arrête d'envoyer jusqu'au redémarrage de l'app, et conserve ses événements en file d'attente.