nebula-logger-console

Nebula Logger Console の使用方法

Console とは

Logger Console は、Nebula Logger に同梱されている Salesforce Lightning アプリです。本番環境で何かが起きるたびにログ管理用カスタムオブジェクト（Log__c、LogEntry__c、LogEntryTag__c、LoggerScenario__c、LoggerTag__c）に対して SOQL を手書きしなくても、管理者、サポートエンジニア、開発者がログを閲覧できる専用の場所を提供します。

• アプリ API 名：LoggerConsole。
• ナビゲーション項目には、Log__c、LogEntry__c、LoggerScenario__c、LoggerTag__c、LogEntryTag__c が含まれます。
• ユーティリティバー（LoggerConsoleUtilityBar FlexiPage）には、コンソールを離れずに有効な階層レコードを編集できる Logger Settings パネルが表示されます。

標準リストビュー

Nebula Logger には、ログ管理用の 5 つすべてのカスタムオブジェクトに幅広いリストビューが用意されているため、初期調査のほとんどでカスタムビューを作成する必要はありません。

• Log__c：AllLogs、AllOpenLogs、AllClosedLogs、AllResolvedLogs、AllLogsWithERROREntries、AllLogsWithERRORorWARNEntries、AllAsynchronousLogs、AllBatchLogs、AllChildLogs、AllImpersonatedLogs、AllRESTLogs、LogsToPurgeSoon、MyAssignedLogs、MyAssignedOpenLogs、MyGeneratedLogs。
• LogEntry__c：All、AllERRORLogEntries、AllERRORandWARNLogEntries、AllApexLogEntries、AllComponentLogEntries、AllFlowLogEntries、AllHttpRequestLogEntries、AllHttpResponseLogEntries、AllRestRequestLogEntries、AllRestResponseLogEntries、AllExceptionLogEntries、AllImpersonatedLogEntries、AllOmniStudioLogEntries、MyGeneratedLogEntries。
• LogEntryTag__c：All、AllImpersonatedLogEntryTags。
• LoggerScenario__c：All、MyAssignedLoggerScenarios。
• LoggerTag__c：All。

インシデントを調査するときは、組み込みのビューから始め、カスタムリストビューを新規作成する前に列フィルターで絞り込んでください。

レコードページ

Nebula Logger には、ユーザー向けのログ管理オブジェクトごとに専用の FlexiPage が用意されています。LogEntryTag__c ジャンクションはレコードページから閲覧できますが、ログ管理フォルダーには独自の FlexiPage がありません。標準のレコードページレイアウトで表示されます。

ログレコードページ

Log__c レコードページ（LogRecordPage FlexiPage）には、次の情報が表示されます。

• 標準の Log__c 項目（トランザクション ID、保存方法、ユーザー、シナリオ、タグ、合計数）。
• 関連する LogEntry__c リスト（ログ内の時系列順）。
• 重要度をひと目で把握するためのロールアップ数（TotalERRORLogEntries__c、TotalWARNLogEntries__c など）。
• 親ログのトランザクション ID が設定されている場合は、関連する子ログ（Apex ロギングスキルに記載されている親子ログの関連付けパターンを参照）。

ログエントリレコードページ

LogEntry__c レコードページ（LogEntryRecordPage FlexiPage）には、次の情報が表示されます。

• メッセージ、ログレベル、発生元の種別／API 名、タイムスタンプ。
• .setRecord(...) を使ってエントリが作成された場合は、関連レコード ID とレコードの JSON スナップショット。
• エントリが例外に起因する場合は、スタックトレースと例外項目。
• エントリに適用されたタグ（LogEntryTag__c ジャンクション経由）。

ログエントリタグレコードページ

LogEntryTag__c レコードページ（LogEntryTagRecordPage FlexiPage）には、タグジャンクションの 1 行が表示されます。適用対象の LogEntry__c と、適用される LoggerTag__c を確認できます。直接開くことはほとんどありません。タグの調査は通常、LogEntry__c または LoggerTag__c の関連リストから行います。ただし、AllImpersonatedLogEntryTags を使って偽装ユーザーのタグ付け操作を監査する場合には便利です。

Logger シナリオレコードページ

LoggerScenario__c レコードページ（LoggerScenarioRecordPage FlexiPage）には、Logger.setScenario(...) を呼び出したトランザクション後に永続化されたシナリオの状態と、そのシナリオを使用した関連 Log__c レコードが表示されます。「シナリオ X のもとで実行されたトランザクションと、フォローアップの担当者」を確認するために使用します。

Logger タグレコードページ

LoggerTag__c レコードページ（LoggerTagRecordPage FlexiPage）には、タグカタログのエントリと、それに関連付けられた LogEntryTag__c ジャンクションが表示されます。つまり、このタグが現在付与されているすべてのログエントリを確認できます。タグ分類の使用状況を監査するときや、タグカタログ内の誤字・重複を見つけるときに使用します。

ホームページとライブストリーミング

コンソールのホームページ（LoggerHomePage FlexiPage）には、運用に関する主なツールが配置されています。

• logEntryEventStream - LogEntryEvent__e プラットフォームイベントをサブスクライブし、公開されたログエントリをリアルタイムで表示します。テストシナリオの実行中に、非同期保存処理によってレコードが永続化されるのを待たずに、ログが記録されていることを確認する最速の方法です。
• logBatchPurge - ログのパージバッチをオンデマンドで実行し、件数を報告します。
• loggerSettings - ユーティリティバーで公開されている設定エディターと同じものを、全画面キャンバスで表示します。
• loggerHomeHeader - リリースノート、GitHub、ドキュメントへのクイックリンクを備えたナビゲーションヘッダーです。
• Log__c、LogEntry__c、LogEntryTag__c、LoggerScenario__c、LoggerTag__c 全体の最近のアクティビティを示す、埋め込みレポートとダッシュボードです。

これらを組み合わせることで、管理者は1ページで「現在、ログ記録は正常に動作しているか。どのような状態か」を確認できます。

代表的なワークフロー

特定のエラーを調査する

1. AllERRORLogEntries リストビューを開きます。
2. 対象の時間範囲で絞り込みます。
3. LogEntry__c レコードを開きます。リンクされた Log__c にはトランザクション全体が表示されます。Log__c の関連リストには、そのトランザクション内のすべてのエントリが順番に表示されます。
4. トランザクションが非同期チェーンの一部である場合は、ParentLog__c を上にたどって親トランザクションを確認します。

ユーザーのセッションを調査する

1. AllLogs リストビューを開きます。
2. LoggedBy__c と時間範囲で絞り込みます。
3. StartTime__c で並べ替え、ユーザーのトランザクションを順番に確認します。

再現中にログが記録されていることを確認する

1. Logger Console のホームページ（LoggerHomePage）を開きます。
2. Log Entry Event Stream コンポーネントを見つけます。
3. 別のタブでシナリオを再現します。
4. LogEntryEvent__e プラットフォームイベントが公開され、エントリが表示されるのを確認します。エントリの表示が止まったら、非同期保存が完了しており、Log__c、LogEntry__c、LogEntryTag__c、LoggerScenario__c、LoggerTag__c に保存されたレコードをクエリできます。

関連スキル

• nebula-logger-instrumentation - ここに表示されるログエントリの記録方法です。
• nebula-logger-purging-and-retention - これらのビューでレコードが表示される期間について説明します。