Sitecore JSS のデバッグログを有効化するには

samatsu 9/8/2022 302 N/A Sitecore JSS

Sitecore JSS で、JSS(JavaScript Rendering SDK)が提供するコードのデバッグログを出力する方法の覚書です。スターターテンプレートを使用して、Next.jsのアプリをセットアップした場合は、.envファイルの次のコードのコメントを解除してあげるだけでOKです。

#DEBUG=sitecore-jss:*
# Or be selective and show for example only layout service logs:
#DEBUG=sitecore-jss:layout
# Or everything BUT layout service logs:
#DEBUG=sitecore-jss:*,-sitecore-jss:layout

JSSでは、内部的にdebugパッケージを使用しているので、より一般的な使用方法は、npmのページからも確認できます。

SitecoreのDebug logging in JSS appsでも使用方法の確認を行えます。ただし、私は所見ではドキュメントを読んでもdebugパッケージのことを知らなくて意味がわからない部分がありました。なので、github上のsitecore-jssパッケージのソースコードを参照して、どのように使用しているのかを確認するとより理解が深まると思います。

もちろん、package.js の next:dev のスクリプト定義で、cross-env が使用されされているので、そこで、次のように設定することも可能です。

"next:dev": "cross-env DEBUG=sitecore-jss:*  ...

sitecore-jss:* とすると、sitecore jss のデバッグログ全体が有効になるので、例えば、Content Managementサーバーのエクスペリエンスエディターとのインテグレーションに関するデバッグログだけ有効化する場合は、sitecore-jss:editing のように名前空間をより厳密に指定できます。