スクリプトログ
空間インスタンス内でClusterScriptが実行されると、スクリプトからの$.log()
によるメッセージや、システムの状態・警告など様々な情報が生まれます。
これらをスクリプトログと呼び、デバッグに役立てることができます。
ログの収集範囲
デフォルトでは、ログを表示しているデバイスがオーナーであるログのみが収集されます。
デベロッパーメニューで「ログをすべて表示」を有効にすると、空間インスタンス内の全てのログを収集します。
アイテムの名前は32文字まで表示されます。
短時間に大量のログが出力されたり、ログが長かったりする場合、一部のログが表示されない場合があります。
アプリ内でのログの確認
アプリ内でログを確認できます。「ログを開く」をクリックすると.logファイルを既定のプログラムで開きます。
Creator Kit内でのログの確認
CreatorKitの「Cluster > ClusterScript Log Console」を選択するとコンソールが起動しClusterScriptのログの監視を開始します。
ClusterScript Log Console ウィンドウでは以下の操作ができます。
Clear
表示されているログをクリアします。 クリアした内容はログファイルからは削除されません。
Load
表示したいログファイルを読み込みます。 初期状態ではファイルパスにある既定のログファイルが読み込まれている状態になります。
インクリメンタル検索
テキストボックスに文字を入力するとログを絞り込むことができます。 虫眼鏡アイコンをクリックするとメニューが表示され、検索の対象とする項目(ログのメッセージ/アイテム名)を切り替えられます。
Pause Log
チェックボックスを有効にするとログの更新を一時停止します。
Open Log
ログファイルを .log に関連付けられたアプリケーションで開きます。
ログファイル
ログファイルにはより詳細なメタデータが構造化ログとして記録されています。 ファイルは以下のパスに存在します。
- Windows:
%userprofile%\AppData\LocalLow\Cluster, Inc_\cluster\ClusterScriptLog.log
- Mac:
~/Library/Application Support/Cluster, Inc_/cluster/ClusterScriptLog.log
ファイルの各行はログエントリ一つに相当するJSONを含んでいます。
dvid
(string): スクリプトが実行されたデバイスを空間インスタンス内で一意に識別する識別子tsdv
(number): ログが出力されたデバイス時刻 (Unix-time, second)origin
(object): ログを出力する元となったアイテム情報type
(string): ログの種類message
(string): ログメッセージ
ログファイルの形式は将来変更される可能性があります。