Passer au contenu principal
Un envoi réussi par le SDK montre que LogBrew a accepté la requête. Il ne montre pas que LogBrew a stocké le signal ni que vous pouvez le lire. Pour vérifier votre configuration, envoyez un signal de test et relisez-le. Une clé de lecture du projet permet à une personne, à un job de CI ou à un agent de codage de lire un projet sans connexion au compte. C’est une clé de projet, pas un identifiant de compte.

​
Types de clés de projet

Chaque clé de projet appartient à un seul projet. Son type définit ce qu’elle peut faire. Vous choisissez le type avec --kind quand vous exécutez logbrew projects keys create. Les types sdk, server, cli et browser sont des clés d’ingestion. Choisissez le type qui indique où la clé s’exécute. Utilisez browser pour du code qui s’exécute dans un navigateur. Ne placez jamais une clé de lecture dans du code de navigateur, une application mobile ou un bundle public. L’accès au compte est différent. logbrew login donne à la CLI l’accès de votre compte. N’utilisez jamais l’accès au compte comme configuration du SDK. Une clé de lecture ne permet pas de se connecter à la CLI ni au tableau de bord.

​
Relire votre signal de test

1

Créer une clé de lecture

Cette étape nécessite l’accès au compte. Exécutez logbrew status --json et vérifiez qu’il indique un accès authentifié au compte.
La CLI écrit la clé dans un nouveau fichier lisible par son seul propriétaire. Elle n’affiche jamais la clé ni le chemin du fichier. --ingest-key-file est l’option de fichier pour tous les types de clé. Le fichier de destination ne doit pas exister.Point de contrôle : le résultat contient status: "created" et ingest_key.kind: "read". Notez ingest_key.id. Vous en avez besoin pour révoquer la clé.
2

Envoyer un signal de test

Envoyez un log de test sûr depuis votre application avec la clé d’ingestion du projet. Suivez les étapes pour votre runtime dans le démarrage rapide ou le guide d’intégration du SDK. Pour tester aussi les problèmes, envoyez une erreur de test gérée.Point de contrôle : le SDK renvoie un statut 2xx. Cela montre que LogBrew a accepté la requête. Passez à l’étape suivante.
3

Relire le signal

Chargez la clé de lecture dans LOGBREW_TOKEN pour ce shell uniquement. Lisez ensuite le projet :
Chaque lecture renvoie uniquement les données du projet de la clé. Vous n’avez donc pas besoin de --project. Ajoutez --service, --environment ou --release pour cibler le signal de test.Point de contrôle : le log de test apparaît avec votre service, votre environnement et votre version. Une erreur de test apparaît comme un problème. Cela montre que LogBrew a stocké les signaux et que vous pouvez les lire.Quand vous avez terminé, exécutez unset LOGBREW_TOKEN. La CLI utilise alors de nouveau l’accès de votre compte.
4

Révoquer la clé de lecture

Révoquez la clé quand vous n’en avez plus besoin. Cette étape nécessite l’accès au compte. Retirez donc d’abord LOGBREW_TOKEN.
Point de contrôle : le résultat contient status: "revoked". La clé cesse de fonctionner à sa prochaine requête.

​
Donner un accès en lecture à un job de CI ou à un agent

Réservez une clé de lecture à un job de CI ou à un agent de codage qui lit un projet. Stockez la clé dans le gestionnaire de secrets du système de CI ou de l’environnement de l’agent. Rendez-la disponible sous LOGBREW_TOKEN. Ne mettez pas la clé dans un prompt, un dépôt ou la sortie d’une commande. Le job ou l’agent peut alors exécuter des lectures comme logbrew issues --json, logbrew issue "<issue_id>" --json et logbrew read trace "<trace_id>". Les commandes de projet, de clé et de compte nécessitent l’accès au compte. Les clients de l’API envoient la clé comme jeton bearer aux lectures de télémétrie de l’API de télémétrie. Utilisez une clé par job ou par agent. Vous pouvez alors révoquer une clé sans effet sur les autres.

​
Corriger une lecture qui échoue

Si la télémétrie manque toujours, utilisez les vérifications de la première télémétrie. Pour remplacer une clé d’ingestion, consultez Renouveler une clé d’ingestion.