Passer au contenu

Consignation prolixe

La journalisation détaillée fournit des informations précises et de bas niveau provenant du SDK Braze, vous permettant ainsi de comprendre comment le SDK s’initialise, communique avec les serveurs et traite les canaux de communication tels que les notifications push, les messages in-app et les cartes de contenu.

Lorsque quelque chose ne fonctionne pas comme prévu, par exemple lorsqu’une notification push n’arrive pas, qu’un message in-app ne s’affiche pas ou que les données utilisateur ne se synchronisent pas, les journaux détaillés vous aident à identifier la cause profonde. Au lieu de deviner, vous pouvez observer précisément ce que fait le SDK à chaque étape.

Quand utiliser la journalisation détaillée

Activez la journalisation détaillée lorsque vous avez besoin de :

  • Vérifier l’initialisation du SDK : Confirmer que le SDK démarre correctement avec la bonne clé API et le bon endpoint.
  • Résoudre les problèmes de distribution des messages : Vérifier si les jetons de notification push sont enregistrés, si les messages in-app sont déclenchés ou si les Content Cards sont synchronisées.
  • Déboguer les deep links : Vérifier que le SDK reçoit et ouvre les deep links provenant des notifications push, des messages in-app ou des Content Cards.
  • Valider le suivi des sessions : Confirmer que les sessions démarrent et se terminent comme prévu.
  • Diagnostiquer les problèmes de connectivité : Inspecter les requêtes et réponses réseau entre le SDK et les serveurs Braze.

Activer la journalisation détaillée

Activez la journalisation détaillée avant tout autre appel au SDK dans votre méthode Application.onCreate() pour capturer la sortie la plus complète.

Dans le code :

BrazeLogger.setLogLevel(Log.VERBOSE);
BrazeLogger.logLevel = Log.VERBOSE

Dans braze.xml :

<integer name="com_braze_logger_initial_log_level">2</integer>

Pour vérifier que la journalisation détaillée est activée, recherchez V/Braze dans la sortie Logcat. Par exemple :

2077-11-19 16:22:49.591 ? V/Braze v9.0.01 .bo.app.d3: Request started

Pour plus de détails, consultez la section Journalisation du SDK Android.

Définissez le niveau de journalisation sur .debug dans votre objet Braze.Configuration lors de l’initialisation.

let configuration = Braze.Configuration(
  apiKey: "<BRAZE_API_KEY>",
  endpoint: "<BRAZE_ENDPOINT>"
)
configuration.logger.level = .debug
let braze = Braze(configuration: configuration)
BRZConfiguration *configuration = [[BRZConfiguration alloc] initWithApiKey:@"<BRAZE_API_KEY>"
                                                                  endpoint:@"<BRAZE_ENDPOINT>"];
[configuration.logger setLevel:BRZLoggerLevelDebug];
Braze *braze = [[Braze alloc] initWithConfiguration:configuration];

Le niveau .debug est le plus détaillé et est recommandé pour la résolution des problèmes. Pour plus de détails, consultez la section Journalisation du SDK Swift.

Ajoutez ?brazeLogging=true comme paramètre d’URL, ou activez la journalisation lors de l’initialisation du SDK :

braze.initialize('YOUR-API-KEY', {
    baseUrl: 'YOUR-SDK-ENDPOINT',
    enableLogging: true
});

Vous pouvez également basculer la journalisation après l’initialisation :

braze.toggleLogging();

Les journaux apparaissent dans l’onglet Console des outils de développement de votre navigateur. Pour plus de détails, consultez la section Journalisation du SDK Web.

  1. Ouvrez les paramètres de configuration Braze en naviguant vers Braze > Braze Configuration.
  2. Sélectionnez le menu déroulant Show Braze Android Settings.
  3. Dans le champ SDK Log Level, saisissez 0.

Définissez le niveau de journalisation lors de la configuration du SDK :

const configuration = new Braze.BrazeConfiguration('YOUR-API-KEY', 'YOUR-SDK-ENDPOINT');
configuration.logLevel = Braze.LogLevel.Verbose;

Collecte des journaux

Après avoir activé la journalisation détaillée, reproduisez le problème que vous cherchez à résoudre, puis collectez les journaux depuis la console ou l’outil de débogage de votre plateforme.

Utilisez Logcat dans Android Studio pour capturer les journaux :

  1. Connectez votre appareil ou démarrez un émulateur.
  2. Dans Android Studio, ouvrez Logcat depuis le panneau inférieur.
  3. Filtrez par V/Braze ou D/Braze pour isoler la sortie du SDK Braze.
  4. Reproduisez le problème.
  5. Copiez les journaux pertinents et enregistrez-les dans un fichier texte.

Utilisez l’application Console sur macOS pour capturer les journaux :

  1. Installez l’application sur votre appareil avec la journalisation détaillée activée.
  2. Connectez votre appareil à votre Mac.
  3. Ouvrez l’application Console et sélectionnez votre appareil dans la barre latérale Devices.
  4. Filtrez les journaux par Braze ou BrazeKit dans la barre de recherche.
  5. Reproduisez le problème.
  6. Copiez les journaux pertinents et enregistrez-les dans un fichier texte.

Utilisez les outils de développement de votre navigateur :

  1. Ouvrez les outils de développement de votre navigateur (généralement F12 ou Cmd+Option+I).
  2. Accédez à l’onglet Console.
  3. Reproduisez le problème.
  4. Copiez la sortie de la console et enregistrez-la dans un fichier texte.

Lecture des journaux détaillés

Les journaux détaillés suivent une structure cohérente qui vous aide à suivre ce que fait le SDK. Pour apprendre à interpréter les sorties de journaux pour des canaux spécifiques, y compris les entrées clés à rechercher et les schémas courants de résolution des problèmes, consultez Lecture des journaux détaillés.

Partager les journaux avec le support Braze

Lorsque vous contactez le support Braze pour un problème lié au SDK, incluez les éléments suivants :

  1. Fichier de journal détaillé : une capture de journal complète, depuis le lancement de l’application jusqu’à la survenue du problème.
  2. Étapes de reproduction : une description claire des actions qui déclenchent le problème.
  3. Comportement attendu vs. comportement réel : ce que vous attendiez et ce qui s’est réellement produit.
  4. Version du SDK : la version du SDK Braze que vous utilisez.
  5. Plateforme et version du système d’exploitation : par exemple, iOS 18.0, Android 14 ou Chrome 120.
New Stuff!