Actions リアルタイムログ

Auth0 Dashboard の Actions リアルタイムログパネルを使用して、Actions、Custom Database スクリプト、Custom Social Connections の実行中のカスタムコードからライブのコンソール出力と例外をストリーミングし、デバッグします。

Actions リアルタイムログ機能では、アカウント内のカスタムコードのすべてのログがリアルタイムで表示されます。これには、console.log の出力と例外がすべて含まれます。これらのログは、Actions、Custom Database スクリプト、Custom Social Connections のデバッグ時に役立ちます。

Actions リアルタイムログを使用する際は、機微な情報をログに記録しないよう注意してください。たとえば、Actions、Custom Database スクリプト、または Custom Social Connections への入力として関数が受け取るパラメーターには、明示的または暗黙的な機微情報が含まれている場合があります。オブジェクト全体をログに記録すると、リアルタイムログで機微な情報が漏えいするおそれがあります。

Auth0 は、このような行為を強く非推奨としています。ログに記録するオブジェクトの内容を十分に確認し、機微な情報が記録されないようにするとともに、あらゆる種類の機微な情報を明示的にログへ出力することも避けてください。

​

使用方法

カスタムコードのリアルタイムログを表示するには、次の手順に従ってください。

1. Auth0 Dashboard > Monitoring > Actions Logs に移動します。
2. ストリームが接続されるまで待ちます。接続は自動的に試行されます。
3. 接続されると、ログエントリが発生に応じてメインパネルに表示されます。

​

機能

Actions のリアルタイムログパネルでは、システムの動作をリアルタイムで監視できます。これにより、Dashboard を通じて実行された Actions の状況をその場で確認できるため、問題の特定や処理の成功確認、あるいはシステムの挙動のリアルタイムな観察がしやすくなります。この機能で現在利用できる機能の詳細な一覧については、以下を参照してください。

​

リアルタイムログストリーミング

ログエントリは、Actions によって生成されるとリアルタイムでストリーミングされます。各 Action の実行に応じて、対応するログエントリがログパネルに自動的に表示されるため、ページを更新する必要はありません。

​

接続ステータス

パネルの上部には、ブラウザーとログストリーム間の現在の接続ステータスが表示されます。これにより、ログを受信中かどうかを確認できます。一般的なステータスは次のとおりです。

状態	説明
ログストリームに接続中…	接続を確立しようとしています。
接続済み	正常に接続され、ログを受信しています。
切断済み	現在、ストリームに接続されていません。

​

検索機能

パネル上部の検索バーを使って、ログエントリを絞り込めます。次の条件で検索できます。

• キーワードまたはフレーズ
• 特定のエラーコード
• 完全一致のログメッセージ

大量のログから、特定の Action や問題に関するものを探す際に特に便利です。

​

オプションメニュー (…)

ログパネルの右上にあるOptionsメニューをクリックすると、追加の操作を利用できます。

• Local Time: ログエントリのタイムスタンプ表示を、サーバーの既定時刻 (多くの場合は UTC) と、ユーザーのローカルブラウザー時刻との間で切り替えます。
• Download: 現在表示されているログを JSON ファイルとしてダウンロードできるため、オフラインでの分析、共有、保存に利用できます。
• Clear Logs: 表示ウィンドウに現在表示されているすべてのログエントリを消去します。これはシステムストレージ上のログを削除するものではなく、現在の表示だけが対象です。

​

一番下までスクロール

新しい項目が追加されて表示範囲外にある場合、ログパネルに一番下までスクロールボタンが表示されます。これをクリックすると最新のログ項目に移動し、常に最新のアクティビティを確認できます。

​

Action をデバッグする

次の例では、汎用的な Hello World Action を作成し、実行して、Actions リアルタイムログ で結果を確認する方法を説明します。

1. Write Your First Action の手順に従い、以下のコード例を使って Post Login Action を作成します。

   /**
   * PostLogin フローの実行中に呼び出されるハンドラー。
   *
   * @param {Event} event - ユーザーと、そのユーザーがログインしているコンテキストの詳細。
   * @param {PostLoginAPI} api - ログインの動作を変更するために使用できるメソッドを提供するインターフェース。
   */
   exports.onExecutePostLogin = async (event, api) => {
     console.log('Hello World!');
   };
   
   /**
   * この action が外部リダイレクト後に再開されるときに呼び出されるハンドラー。onExecutePostLogin
   * 関数でリダイレクトを実行しない場合、この関数はそのまま無視してかまいません。
   *
   * @param {Event} event - ユーザーと、そのユーザーがログインしているコンテキストの詳細。
   * @param {PostLoginAPI} api - ログインの動作を変更するために使用できるメソッドを提供するインターフェース。
   */
   // exports.onContinuePostLogin = async (event, api) => {
   // };
   

2. 新しいタブを開き、Auth0 Dashboard > Monitoring > Actions Logs に移動します。

3. ストリームが接続されたら、Action Editor に切り替えてテストを実行します。

4. 結果が Actions リアルタイムログ にリアルタイムで表示されます。

​

サポートされているステートメント

次の表は、リアルタイムロギング機能でサポートされている JavaScript コンソールステートメントの一覧です。

ステートメント	説明	使用例
console.log()	一般的な情報を出力します。	基本的な情報メッセージ、変数の値。
console.info()	アプリケーションの進行状況や状態を示す情報メッセージを出力します。	正常に完了した操作やアプリケーションの節目の報告。
console.warn()	重大なエラーではないものの、潜在的な問題や想定外の状況を示します。	軽微な問題や非推奨機能の通知。
console.error()	アプリケーション内で発生したエラーを報告します。	失敗、例外、重大な問題の通知。
console.trace()	スタックトレースを表示し、現在の場所に至るまでの関数呼び出しの流れを示します。	複雑な呼び出しフローのデバッグや、問題の発生元の把握。

​

詳しくはこちら

• 最初のActionを書く