JSSアプリにおけるデバッグログ
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
Sitecore JSS NPMパッケージやサンプルは デバッグモジュール を使ってデバッグ情報を出力します。
このモジュールはdebug() 関数を公開しており、これはconsole.log() 文の拡張版です。console.logとは異なり、本番コードではコメントアウトやdebug() 呼び出しを削除する必要がなく、環境変数を使って必要に応じて本番環境でデバッグログを簡単に有効化できます。
すべてのSitecore JSSログはルート名前空間sitecore-jssのもとで整理されています。ログはデフォルトでオフにされており、DEBUG環境変数を使って条件付きでオンにすることができます。
!注デバッグログにはサーバー側のコードのみが含まれているため、ブラウザでデバッグログを有効にしてもメリットはありません。
利用可能なすべてのデバッグログを出力するには、DEBUG環境変数をsitecore-jss:*に設定してください。アスタリスク*はワイルドカードとして使われます。
DEBUG=sitecore-jss:*
例えばレイアウトサービスログなど、特定のログメッセージカテゴリのみを選択的に表示することもできます。
DEBUG=sitecore-jss
または、レイアウトサービスログ以外のすべてを表示するには、- プレフィックスを使うことができます:
DEBUG=sitecore-jss:*,-sitecore-jss
名前空間
以下の表は利用可能なすべての名前空間と、該当するSitecore JSS npmパッケージおよびサンプルアプリケーションを一覧にしています。
名前空間
パッケージ/サンプルアプリ
概要
sitecore-jss
sitecore-jss, Nextjs
デフォルトのフェッチラッパー(GraphQLRequestClientおよびAxiosDataFetcher)に対するHTTPリクエストおよびレスポンスログです。
sitecore-jss
sitecore-jss, Nextjs, Node-headless-ssr-experience-edge
辞書サービス実装(GraphQLDictionaryServiceおよびRestDictionaryService)のためのトレースログ。
sitecore-jss
sitecore-jss, Nextjs, Node-headless-ssr-experience-edge
レイアウトサービス実装のためのトレースロギング(GraphQLLayoutServiceおよびRestLayoutService)。
sitecore-jss
sitecore-jss-nextjs, nextjs
Sitecoreエディタ統合のためのNext.jsミドルウェアのトレースログ。
sitecore-jss
sitecore-jss-nextjs, nextjs
サイトマップサービス(GraphQLSitemapService)Next.js GraphQLトレースログ。
高度なオプション
Node.jsで動作する際、以下の環境変数を使ってデバッグログの挙動を変える追加の環境変数をいくつか設定できます:
名称
概要
DEBUG
特定のデバッグ名片を有効化・無効化します。
DEBUG_HIDE_DATE
デバッグ出力から日付を非表示(非TTY)してください。デフォルトはfalseです。
DEBUG_COLORS
デバッグ出力で色を使うかどうか。デフォルトはtrueです。
DEBUG_DEPTH
物体検査の深度。デフォルトは2。
DEBUG_MULTILINE
複数行のきれいな印刷で検査されたオブジェクト。デフォルトは偽(単行)。
DEBUG_SHOW_HIDDEN
検査対象のオブジェクトに隠れたプロパティを表示します。デフォルトはfalseです。