詳細なログ記録
詳細なログ出力は、Braze SDKからの詳細かつ低レベルな情報を提供する。これにより、SDKの初期化方法、サーバーとの通信方法、プッシュ通知、アプリ内メッセージ、コンテンツカードといったメッセージングチャネルの処理方法が可視化される。
何かが期待通りに動作しない場合——例えばプッシュ通知が届かない、アプリ内メッセージが表示されない、ユーザーデータが同期されない——詳細ログは根本原因の識別に役立つ。推測する代わりに、SDKが各ステップで何をしているかを正確に確認できる。
手動で詳細ログのイネーブルメントをせずにデバッグしたい場合、SDKデバッガーを使ってBrazeダッシュボード内で直接デバッグセッションを作成できる。
詳細ログを記録するタイミング
必要な時に詳細ログを有効にしろ:
- SDKの初期化を確認する:SDKが正しいAPIキーとエンドポイントで正しく起動することを確認せよ。
- メッセージ配信のトラブルシューティング:プッシュトークンが登録されているか、アプリ内メッセージがトリガーされているか、コンテンツカードが同期されているかを確認する。
- ディープリンクをデバッグする:SDKがプッシュ通知、アプリ内メッセージ、またはコンテンツカードからのディープリンクを受信し、開封することを確認せよ。
- セッショントラッキングを検証する:セッションの開始と終了が予定通りであることを確認する。
- 接続の問題を診断する:SDKとBrazeサーバー間のネットワークリクエストとレスポンスを検査する。
詳細ログ記録のイネーブルメント
詳細ログは開発者およびテスト環境でのみ使用することを意図している。本番環境へアプリを公開する前に詳細ログ記録を無効化し、機密情報が漏洩するのを防ぐこと。
メソッドApplication.onCreate()内で他のSDK呼び出しを行う前に詳細ログ記録をイネーブルにすると、最も完全な出力を取得できる。
コードでは:
1
BrazeLogger.setLogLevel(Log.VERBOSE);
1
BrazeLogger.logLevel = Log.VERBOSE
In braze.xml:
1
<integer name="com_braze_logger_initial_log_level">2</integer>
詳細ログのイネーブルメントを確認するには、Logcat出力で`V/Brazeverbose`を検索する。以下に例を示します。
1
2077-11-19 16:22:49.591 ? V/Braze v9.0.01 .bo.app.d3: Request started
詳細については、Android SDKのロギングを参照せよ。
初期化時に、オブジェクトBraze.Configurationのログ.debugレベルを に設定する。
1
2
3
4
5
6
let configuration = Braze.Configuration(
apiKey: "<BRAZE_API_KEY>",
endpoint: "<BRAZE_ENDPOINT>"
)
configuration.logger.level = .debug
let braze = Braze(configuration: configuration)
1
2
3
4
BRZConfiguration *configuration = [[BRZConfiguration alloc] initWithApiKey:@"<BRAZE_API_KEY>"
endpoint:@"<BRAZE_ENDPOINT>"];
[configuration.logger setLevel:BRZLoggerLevelDebug];
Braze *braze = [[Braze alloc] initWithConfiguration:configuration];
レベル.debugは最も詳細な出力を示すため、トラブルシューティングに推奨される。詳細については、SWIFT SDKのロギングを参照せよ。
URLパラメータとして`add?brazeLogging=true`を追加するか、SDK初期化時にロギングのイネーブルメントを行う。
1
2
3
4
braze.initialize('YOUR-API-KEY', {
baseUrl: 'YOUR-SDK-ENDPOINT',
enableLogging: true
});
初期化後にログ記録のオンオフを切り替えることもできる。
1
braze.toggleLogging();
ログはブラウザの開発者の開発ツールのコンソールタブに表示される。詳細については、Web SDKのログ記録を参照せよ。
- [Braze] > [Braze 構成] の順に移動して、[Braze 構成設定] を開きます。
- 「Show Braze Android 設定」ドロップダウンを選択する。
- SDKログレベルフィールドに「.」と入力する
0。
SDK設定時にログレベルを設定する:
1
2
const configuration = new Braze.BrazeConfiguration('YOUR-API-KEY', 'YOUR-SDK-ENDPOINT');
configuration.logLevel = Braze.LogLevel.Verbose;
ログの収集
詳細ログ記録のイネーブルメント後、トラブルシューティング対象の問題を再現し、プラットフォームのコンソールまたはデバッグツールからログを収集する。
Android StudioでLogcatを使ってログをキャプチャする:
- デバイスを接続するか、エミュレータを起動する。
- Android Studioで、下部のパネルからLogcatを開け。
- または
V/Brazeでフィルターをかけて、D/BrazeBraze SDKの出力を分離する。 - 問題を再現する。
- 関連するログをコピーして、テキストファイルに保存する。
MacOSのコンソールアプリを使ってログをキャプチャする:
- 詳細ログ記録を有効にした状態で、アプリを端末にインストールせよ。
- デバイスをMacに接続せよ。
- コンソールアプリを開封し、デバイスのサイドバーから自分のデバイスを選ぶ。
- 検索バーで
BrazeKitまたはBrazeでフィルターをかける。 - 問題を再現する。
- 関連するログをコピーして、テキストファイルに保存する。
ブラウザの開発者ツールを使え:
- ブラウザの開発者ツールを開封(通常はF12キーかCmd+Option+Iキーだ)。
- コンソールタブに移動する。
- 問題を再現する。
- コンソールの出力をコピーして、テキストファイルに保存しろ。
Brazeサポート向けにログを収集する際は、アプリ起動前からログ記録を開始し、問題発生後も十分に経過するまで継続すること。これにより、一連の出来事の全容を把握できる。
冗長なログを読む
詳細ログは一貫した構造に従っているため、SDKの動作を追跡するのに役立つ。特定のチャネルのログ出力を学習する方法、具体的には確認すべきキーエントリや一般的なトラブルシューティングパターンについては、「詳細ログの読み方」を参照せよ。
Brazeサポートとのログ共有
SDKに関する問題でBrazeサポートに連絡する際は、以下の情報を含めてください:
- 詳細なログファイル:アプリ起動前から問題発生までの完全なログ記録。
- 再現ステップ:問題をトリガーするアクションの明確な説明。
- 期待される動作と実際の動作:君が予想していたことと、実際に起きたこと。
- SDKバージョン:使用しているBraze SDKのバージョン。
- プラットフォームとOSのバージョン:例えば、iOS 18.0、Android 14、あるいはChrome 120といったものだ。
GitHub でこのページを編集