Démarrage rapide
Créez un projet, copiez sa clé d'ingestion, envoyez un premier événement et retrouvez-le dans le tableau de bord.
Lyrelog est un service hébergé, en accès anticipé sur invitation. Demandez un accès sur
lyrelog.com ; le lien d'invitation vous permet de créer votre compte. Le
tableau de bord se trouve sur app.lyrelog.com, et les apps envoient
leurs événements à https://ingest.lyrelog.com.
Nommez votre premier projet
Une fois votre compte créé, le tableau de bord s'ouvre sur Welcome. Donnez un nom au projet et indiquez ce qui envoie ses événements : une app iOS ou macOS, un site web, un service Node, Python ou Go, ou n'importe quoi d'autre en HTTP. Ce choix détermine l'extrait de code affiché ensuite et la plateforme du projet.
Créez un projet par app. Si l'app a aussi un site web et un backend, ils peuvent tous envoyer au même projet (voir Plateformes). Les projets suivants se créent depuis Projects puis New project. Seul un propriétaire de l'organisation peut créer des projets.
Copiez la clé d'ingestion
Juste après la création du projet, Lyrelog affiche sa clé d'ingestion, lyr_ing_..., et les
lignes à coller dans votre app. Copiez la clé tout de suite : seule une empreinte (hash)
en est conservée, elle ne peut donc plus être affichée. Si vous la perdez, créez-en une nouvelle
sur la page API keys du projet.
La clé d'ingestion peut seulement envoyer des événements, jamais les lire : elle peut donc être embarquée sans risque dans une app. Voir Clés. Un backend doit plutôt envoyer avec une clé serveur (Send events from a server, sur la page API keys), dont les événements sont vérifiés.
Envoyez un premier événement
Les SDK ne sont pas encore publiés
Les SDK pour Swift, Android, React Native, Flutter, JavaScript, Python, Go et la JVM ne peuvent pas encore être installés. Pour l'instant, envoyez votre premier événement avec curl, ou depuis n'importe quel langage par l'API HTTP.
Dans un terminal macOS ou Linux (la commande utilise uuidgen et date), remplacez
lyr_ing_... par votre clé et lancez :
curl -X POST https://ingest.lyrelog.com/v1/events:batch \
-H "Authorization: Bearer lyr_ing_..." \
-H "Content-Type: application/x-ndjson" \
--data-binary "{\"event_id\":\"$(uuidgen | tr A-Z a-z)\",\"ts\":\"$(date -u +%Y-%m-%dT%H:%M:%SZ)\",\"message\":\"hello_lyrelog\",\"resource\":{\"environment\":\"production\"}}"Chaque événement a besoin d'un nouvel UUID comme event_id et de l'heure actuelle comme ts.
Un événement dont le ts est plus ancien que la durée de conservation du projet, ou en avance
de plus d'un jour, n'est pas perdu : il est stocké à son heure d'arrivée, et l'heure envoyée va
dans l'attribut _lyrelog_ts_clamped. La réponse indique combien de lignes ont été stockées :
{"accepted":1,"rejected":[]}Une autre réponse ? Voir Aucun événement n'arrive.
Regardez-le arriver
La page Welcome attend le premier événement et vous prévient quand il arrive. Ouvrez le
projet depuis cette page : la page Events affiche hello_lyrelog. Cliquez dessus pour voir
l'événement complet.
Il n'y est pas ?
Le tableau de bord affiche un environnement à la fois et s'ouvre sur celui du projet par
défaut, production. Les SDK envoient development depuis un build lancé depuis Xcode, depuis
le simulateur, depuis une page sur localhost, et depuis Node sauf si NODE_ENV=production
est défini : vos premiers événements envoyés par un SDK sont donc sous development.
Choisissez-le, ou All environments, dans la barre du haut. La commande curl ci-dessus
définit "environment":"production" ; un événement envoyé sans resource.environment est
lui aussi stocké sous production. Voir Environnements.
Lisez-le depuis un script (facultatif)
Sur la page API keys du projet, choisissez New key, réglez What it can do sur
Read events, et copiez la clé lyr_read_.... Créer une clé de lecture vous demande de vous
reconnecter si votre dernière connexion date de plus de 10 minutes. Gardez-la sur un serveur :
elle lit tous les événements du projet.
export LYRELOG_READ_KEY=lyr_read_...
curl -s -G https://app.lyrelog.com/v1/events \
-H "Authorization: Bearer $LYRELOG_READ_KEY" \
--data-urlencode "message=hello_lyrelog"Voir l'API de lecture.
Ensuite
Apps
Web et serveurs
Tout le reste
- Découvrez ce qui fait un bon événement : Événements.
- Quelque chose ne marche pas : Aucun événement n'arrive.