ログの有効化
このページでは、CSP アクティビティを記録するログを有効化する方法を説明します。このログは、CSP ベースの Web アプリケーションをトラブルシューティングする際に役立ちます。
ログの有効化と無効化
ログを有効化するには、ターミナルで以下のコマンドを入力します。
Set ^%ISCLOG = 2^ISCLOG グローバルでログ情報を表示できます。
ログを無効にするには、以下のコマンドのいずれかを使用できます。
Set ^%ISCLOG = 0
Kill ^%ISCLOGログ・レベル
参考のために、ログ・レベルを以下に示します。
-
0 — InterSystems IRIS® データ・プラットフォームはログ記録を実行しません。
-
1 — InterSystems IRIS は例外的なイベントのみをログ記録します (エラー・メッセージなど)。
-
2 — InterSystems IRIS は詳細な情報をログ記録します (method ABC invoked with parameters X,Y,Z and returned 1234 など)。
-
3 — InterSystems IRIS は HTTP 要求から受け取ったデータなど、未処理の情報をログ記録します。
-
5 — InterSystems IRIS は OAuth 2.0 情報をログ記録します。
ISCLog の詳細
ISCLOG では、一部のエントリは以下のようにイベント・ログ・ヘッダと一致します。
| ISCLOG | イベント・ログ |
|---|---|
| Job | Cache-PID |
| SessionId | Session-ID |
| Tag | Request-ID |
以下の表に、ISCLOG のフィールドと定義を示します。
| フィールド | 定義 |
|---|---|
| %category |
CSPServer ： cspServer、cspServer2、%request、%response からログが記録されます。 |
|
CSPSession ： セッションを処理する %session および cspServer と cspServer2 の一部からログが記録されます。これにより、セッションのライフサイクルの監視が可能になります。 |
|
|
CSPLicense ： ライセンスを処理する cspServer および cspServer2 の一部からログが記録されます。 |
|
|
Gateway Request ： ゲートウェイ要求を処理する GatewayMgr、GatewayRegistry、ゲートウェイ要求ハンドラ、および cspServer2 の一部からログが記録されます。 |
|
| %level |
1 = 例外およびエラー。 |
|
2 = CSPSession 情報。CSPLicense 情報。cspServer からの情報 ： %response、%session、および %request の設定後の要求処理の一部。これには、認証、ライセンスの処理、リダイレクト、および CSPpage の呼び出しが含まれます。 |
|
|
3 = cspServer2 からの情報 ： %response、%session、%request、および Web ゲートウェイとのハンドシェイク/データ転送を設定する要求の処理の一部。 |
|
| %job | ISCLOG 要求が行われたときの $job の値。イベント・ログのヘッダの Cache-PID フィールドと一致します。 |
| %sessionid |
利用可能な場合に入力されます。ISCLOG 要求が行われたときの sessionid の値。イベント・ログのヘッダの Session-ID フィールドと一致します。 |
| %tag | CSP サーバの場合、タグにはゲートウェイからの要求 ID が含まれます (利用可能な場合)。これは、イベント・ログのヘッダの Request-ID フィールドと一致します。その他のロガーでは、この値は任意の値に設定される可能性があります。
ISCLOG エントリの作成者が使用できます。Web ゲートウェイによって送信される要求の ID を格納します。ISCLOG エントリの生成のためのフィルタとして使用できます。 Set ^%ISCLOG("Tag","mytagvalue1")=1 Set ^%ISCLOG("Tag","mytagvalue2")=1 タグが付いていないか、"mytagvalue1" または "mytagvalue2" のタグが付いた ISCLOG 要求のみが記録されます。 |
| %routine | 現在実行中のルーチンの名前。 |
| %message | 以下の "メッセージ形式" を参照してください。 |
メッセージ形式
メッセージは、現在実行中のタグ・ラベルまたはメソッドの名前で開始されます。この名前は角括弧で囲まれます。例えば、[MyMethod] rest of messages のようになります。
CSPSession カテゴリ内のメッセージには、メソッド名の後に CSPSession-Id=sessid も含まれます。これが必要なのは、セッション・イベントはセッションが作成される前か、セッションが破棄された後 (つまり、ISCLOG エントリ内の SessionId フィールドは空) に記録できるためです。
[MyMethod] CSPSession-Id: 12ty34ui22
GatewayRegistry カテゴリ内のメッセージには、メソッド名の後に CSPID=cspid も含まれます (利用可能な場合)。これにより、ゲートウェイ要求ハンドラを介して API 呼び出しからの個々のゲートウェイ要求を追跡することが可能になります。
[MyMethod]CSPID:334r43345 rest of message
