トレース ロギングをセットアップする方法
目次
casso126jjp
目次
トレース ロギングをセットアップするには、以下の手順に従います。
- トレース ロギングをセットアップおよび有効化します。
- 以下のリストを確認することによってトレース ログに記録する内容を決定します。
- トレース ログ コンポーネントとサブコンポーネント
- トレース メッセージ データ フィールド
- データ フィールド フィルタ
- デフォルトのトレース設定ファイルを複製します。
- 記録するアイテムが含まれるように複製ファイルを変更します。
- エージェントを再起動します。
トレース ロギングの設定
トレース ロギングを使用するには、事前に、トレース ログ ファイルの名前、ロケーション、およびパラメータを指定して、トレース ロギングを設定しておく必要があります。これらの設定によって、ファイル自体のサイズおよび形式を制御します。トレース ロギングを設定したら、トレース ログ ファイルのコンテンツを別個に指定します。これにより、トレース ログ ファイル自体のパラメータを変更することなく、必要に応じて、トレース ログに含める情報のタイプを変更することができます。
トレース ロギングを設定するには、以下の手順に従います。
- Web サーバ上で WebAgentTrace.conf ファイルを見つけます。ファイルを複製します。注:IIS 用のSingle Sign-Onエージェントを実行しており、64 ビット システム(WoW64 モード)上の 32 ビット アプリケーションを保護している場合は、2 つの複製を作成します。Windows 64 ビット 動作環境には、32 ビットと 64 ビットのアプリケーションに異なるディレクトリがあります。
- エージェント設定オブジェクトまたはローカル設定ファイルを開きます。
- TraceFile パラメータに yes を設定します。注: Web サーバのローカル設定ファイル内でこのパラメータの値を Yes に設定すると、ポリシー サーバ上で定義されたあらゆるロギング設定を上書きします。たとえば、このパラメータの値が LocalConfig.conf ファイルで yes に設定されていると仮定します。たとえ対応するエージェント設定オブジェクトの AllowLocalConfig パラメータの値が no に設定されていたとしても、エージェントはログ ファイルを作成します。また、エージェント設定オブジェクト内の他の設定を上書きするために、LocalConfig.conf ファイル内の関連するロギング パラメータも設定できます。
- 以下のパラメータでトレース ログ ファイルの絶対パスを指定します。
- TraceFileNameトレース ログ ファイルの完全パスを指定します。デフォルト:デフォルトなし制限: このパラメータではファイル名を指定します。例:web_agent_home\log\trace.log
- TraceFileName3264 ビット Windows オペレーティング環境で稼働し、32 ビット アプリケーションを保護している IIS 用Single Sign-Onエージェントのトレース ファイルの完全パスを指定します。このパラメータを設定するのは、IIS 用Single Sign-Onエージェントが 64 ビット Windows オペレーティング環境にインストールされており 32 ビット Windows アプリケーションを保護している場合です。32 ビット アプリケーションは、64 ビット Windows オペレーティング環境では Wow64 モードで実行されます。トレース ロギングが有効であるが、このパラメータが設定されていない場合、IIS 用 Web エージェントはファイル名の末尾に _32 を追加します。デフォルト: デフォルトなし制限:Windows 64 ビット オペレーティング環境のみ。パスの最後にトレース ファイル名を指定します。例:(Windows 64 ビット オペレーティング環境で Wow64 モードを使用) web_agent_home\log\WebAgentTrace32.log
- WebAgentTrace.conf ファイルのコピー(手順 1 で作成)のフル パスを以下のパラメータに指定します。
- TraceConfigFile監視するコンポーネントとイベントを決定する WebAgentTrace.conf 設定ファイルの場所を指定します。デフォルト:デフォルトなし例:web_agent_home\config\WebAgentTrace.conf
- TraceConfigFile32監視するコンポーネントとイベントを決定する WebAgentTrace.conf 設定ファイルの場所を指定します。このパラメータを設定するのは、IIS 用Single Sign-Onエージェントが 64 ビット Windows オペレーティング環境にインストールされており 32 ビット Windows アプリケーションを保護している場合です。32 ビット アプリケーションは、64 ビット Windows オペレーティング環境では Wow64 モードで実行されます。ログ記録が有効であるが、このパラメータが設定されていない場合、IIS 用 Web エージェントはファイル名の末尾に _32 を追加します。デフォルト: デフォルトなし制限:Windows 64 ビット オペレーティング環境のみ。パスの最後に設定ファイル名を指定します。例: (Windows 64 ビット オペレーティング環境で Wow64 モードを使用)web_agent_home\config\WebAgentTrace32.conf
注:このファイルは、Web サーバを再起動するまで使用されません。 - エージェント設定オブジェクトまたはローカル設定ファイルに以下のパラメータを設定することで、トレース ログ ファイルの情報の形式を定義します。
- TraceAppendロギングが有効になるたびにファイル全体を書き直す代わりに、既存のログ ファイルの最後に新しいログ情報を追加します。デフォルト:No
- TraceFormatトレース ファイルがメッセージを表示する方法を指定します。以下のいずれかのオプションを選択します。
- default - 角かっこ[]を使用してフィールドを囲みます。
- fixed - 固定幅のフィールドに使用します。
- delim - 選択した文字を使用してフィールドを区切ります。
- xml - XML-like タグを使用します。Web エージェントには、DTD (Document Type Definition、文書タイプ定義)や、他のスタイルシートは付属していません。
デフォルト:default (角かっこ) - TraceDelimiterトレース ファイル内のフィールドを区切るカスタム文字を指定します。デフォルト:デフォルトなし例:|
- TraceFileSizeトレース ファイルの最大サイズを指定します(メガバイト単位)。この制限に到達すると、Web エージェントは新しいファイルを作成します。デフォルト:0 (新しいログ ファイルは作成されません)例:20 (MB)
- LogLocalTimeログがグリニッジ標準時(GMT)とローカル時間のどちらを使用するかを指定します。GMT を使用するには、この設定を no に変更します。このパラメータが存在しない場合は、デフォルト設定が使用されます。デフォルト:Yes
- Web エージェントが目的のアクティビティを監視するように、WebAgentTrace.conf ファイルを編集します。フレームワーク Web エージェントは、エージェント設定ファイルでローカルに設定されたログ パラメータの動的な設定をサポートしていません。したがって、パラメータを変更しても、Web サーバを再起動するまでは、その変更結果は有効になりません。しかし、ポリシー サーバ上のエージェント設定オブジェクト内でそれらのパラメータを設定した場合、ログに関するそれらの設定は保存され、動的に更新されます。注:IIS エージェントは、最初のユーザ要求が送信されてから、ログ ファイルを作成します。Apache 2.0 Web エージェントでは Apache サーバの起動時にログ ファイルが作成されます。
- Web エージェントで新しいトレース設定ファイルが使用されるよう、Web サーバを再起動します。
トレース ログ コンポーネントとサブコンポーネント
Single Sign-On
エージェントは、特定の Single Sign-On
コンポーネントを監視できます。コンポーネントを監視すると、そのコンポーネントに対するすべてのイベントがトレース ログに記録されます。各コンポーネントには 1 つ以上のサブコンポーネントがあり、エージェントはこれらも監視できます。エージェントに、コンポーネントに対するイベントを必ずしもすべて記録させる必要がない場合は、監視する必要があるサブコンポーネントのみを指定することができます。たとえば、Web サーバ上のエージェントに対するシングル サインオン メッセージのみを記録する場合は、WebAgent コンポーネントと SSO サブコンポーネントを指定します。
使用可能なコンポーネントとサブコンポーネントは、以下のとおりです。
- AgentFrameworkすべてのエージェント フレームワーク メッセージを記録します (フレームワーク エージェントにのみ適用されます)。使用可能なサブコンポーネントは、以下のとおりです。
- 管理
- フィルタ
- HighLevelAgent
- LowLevelAgent
- LowLevelAgentWP
- AffiliateAgent4.x のアフィリエイト エージェントに関連する Web エージェント メッセージを記録します。4.x のアフィリエイト エージェントは、Federation セキュリティ サービス(別途購入製品)の一部です (フレームワーク エージェントにのみ適用されます)。使用可能なサブコンポーネントは、以下のとおりです。
- RequestProcessing
- SAMLAgentSAML アフィリエイトエージェントに関連する Web エージェントメッセージです。(フレームワーク エージェントにのみ適用されます)。使用可能なサブコンポーネントは、以下のとおりです。
- RequestProcessing
- WebAgentすべての Web エージェント ログ メッセージを記録します。IIS 6.0 または Apache 2.0 エージェントを除くすべてのエージェントに適用されます。使用可能なサブコンポーネントは、以下のとおりです。
- AgentCore
- キャッシュ
- 認証
- レスポンス
- 管理
- SSO
- フィルタ
- Agent_Functionsすべてのエージェント API メッセージを記録します。使用可能なサブコンポーネントは、以下のとおりです。
- Init
- UnInit
- IsProtected
- ログイン
- ChangePassword
- 検証
- ログアウト
- 認証
- Audit
- FreeAttributes
- UpdateAttributes
- GetSessionVariables
- SetSessionVariables
- DeleteSessionVariables
- トンネル
- GetConfig
- DoManagement
- Agent_Con_Managerエージェント API の内部処理に関連するメッセージを記録します。使用可能なサブコンポーネントは、以下のとおりです。
- RequestHandler
- Cluster
- サーバ
- WaitQueue
- 管理
- 統計
トレース メッセージ データ フィールド
メッセージに含めるデータ フィールドを指定することにより、特定のコンポーネントの各トレース メッセージに何を含めるかを定義することができます。
データ フィールドの構文は、以下のとおりです。
textdata:data_field1,data_field2,data_field3
以下の例に、いくつかのデータ フィールドを示します。
textdata:message,date,time,user,agentname,IPAddr
メッセージによっては、フィールドに対するデータが存在しないこともあるため、フィールドが空になる場合もあります。たとえば、データ フィールドとして RealmOID を選択した場合、トレース メッセージによって、レルムの OID が表示される場合と表示されない場合があります。
使用可能なデータ フィールドは、以下のとおりです。
- メッセージ実際のトレース メッセージが含まれます。
- SrcFileトレース メッセージのソース ファイルと行番号が含まれます。
- Pidプロセス ID が含まれます。
- Tidスレッド ID が含まれます。
- Date日付が含まれます。
- Time時間が含まれます。
- PreciseTimeミリ秒単位までの時間が含まれます。
- 関数トレース メッセージが入っているコード内の関数が含まれます。
- [User]ユーザの名前が含まれます。
- ドメインSingle Sign-Onドメインが含まれます。
- RealmSingle Sign-Onレルムが含まれます。
- AgentName使用されているエージェント名が含まれます。
- TransactionIDトランザクション ID が含まれます。
- DomainOIDSingle Sign-Onドメイン OID が含まれます。
- IPAddrクライアント IP アドレスが含まれます。
- RequestIPAddrエージェントがあるサーバの IP を表示するトレース ファイルが含まれます。
- IPPortクライアント IP ポートが含まれます。
- CertSerial証明書シリアル番号が含まれます。
- SubjectDN証明書の所有者 DN が含まれます。
- IssuerDN証明書の発行者 DN が含まれます。
- SessionSpecSingle Sign-Onセッション仕様が含まれます。
- SessionIDSingle Sign-Onセッション ID が含まれます。
- UserDNユーザ DN が含まれます。
- Resource要求されたリソースが含まれます。
- アクション要求されたアクションが含まれます。
- RealmOIDレルム OID が含まれます。
- ResponseTimeCA Web エージェントまたは SDK エージェントと API アプリケーションに関連する、ポリシー サーバの平均レスポンス時間(ミリ秒単位)が含まれます。注:ResponseTime をトレース ログに出力するには、WebAgentTrace.conf ファイル、またはポリシー サーバ設定オブジェクト(ACO)に指定されたその他のファイルに、データ フィールド ResponseTime と一緒にコンポーネント Agent_Con_Manager を含めて、ポリシー サーバを再起動してください。Agent_Con_Manager コンポーネント、つまりエージェント API 接続マネージャは、ポリシー サーバからレスポンスを受け取るたびに ResponseTime を計算して、実行の平均を維持します。トレース ログで ResponseTime を見つけるには、[PrintStats]を検索してください。
トレース メッセージ データ フィールド フィルタ
特定の問題に焦点を当てるために、データ フィールドの値に基づいてフィルタを指定することによって、トレース ログの出力を絞り込むことができます。たとえば、index.html ページで問題が発生している場合、トレース設定ファイル内で Resource:==/html と指定することにより、html サフィックス(拡張子)を持つリソースのみをフィルタして抽出することができます。各フィルタは、ファイル内で個別の行を使用して記述する必要があります。
フィルタは、以下の構文を使用します。
data_field
:filter
使用可能なフィルタのタイプは、以下のとおりです。
- ==(完全一致)
- !=(等しくない)
フィルタは、以下の例に示すように、ブール ロジックを使用します。
Action:!=get(get 以外のすべてのアクション)
Resource:==/html(末尾が /html のすべてのリソース)
トレース ログのコンテンツの決定
WebAgentTrace.conf ファイルによって、トレース ログのコンテンツが決まります。トレース ログに表示するコンポーネントとデータ項目は、Web サーバ上の WebAgentTrace.conf ファイルの設定を変更することで制御できます。ファイル編集時には、次の要素が当てはまります。
- エントリは、大文字と小文字が区別されます。コンポーネント、データ フィールド、またはフィルタを指定する場合、その値は、WebAgentTrace.conf ファイルの命令内にあるオプションと正確に一致している必要があります。
- 設定行のコメントを解除します。
- 既存のエージェントの上に新しいエージェントをインストールする前に WebAgentTrace.conf ファイルを変更すると、ファイルは上書きされます。まず、ファイルの名前を変更するか、ファイルのバックアップを作成します。インストール後、変更を新しいファイルに統合することができます。
以下の手順に従います。
- WebAgentTrace.conf ファイルを開きます。注:元のファイルを複製し、コピーを変更することをお勧めします。コピーを変更することで、デフォルト設定が保存されます。
- 以下のステップに従って、コンポーネントとサブコンポーネントを追加します。
- エージェントのタイプと一致するセクションを見つけます。たとえば、サーバに Apache 2.0 エージェントがインストールされている場合は、以下の例のような行を探します。text# For Apache 2.0, Apache 2.2, IIS 7.0 and SunOne Web Agents
- そのセクションで以下の行を見つけます。text#components:
- 行をコメント解除します。次に、コロンの後に目的のコンポーネント名を追加します。コンポーネントが複数ある場合は、以下の例のように、カンマで区切ります。textcomponents: AgentFramework, HTTPAgent
- (任意)コンポーネント名の後ろに、目的のサブコンポーネントの名前を追加します。以下の例のように、サブコンポーネント名はスラッシュで区切ります。textcomponents: AgentFramework/Administration
- 以下のステップに従って、データ フィールドとフィルタを追加します。
- 該当するセクションで以下の行を見つけます。text#data:
- 行をコメント解除します。次に、コロンの後に目的のデータ フィールドを追加します。データ フィールドが複数ある場合は、以下の例のように、カンマで区切ります。textdata: Date, Time, Pid, Tid, TransactionID, Function, Message, IPAddr
- (オプション)データ フィールドの後ろに、コロン、ブール演算子、および目的の値を付けて、データ フィールドにフィルタを追加します。フィルタに指定する値は、完全に一致する必要があります。以下の例は、特定の IP アドレスのアクティビティをログに記録するフィルタを示しています。textIPAddr:==127.0.0.1注:2 つ以上のフィルタがある場合は、各フィルタをファイル内の別々の行に追加します。
- 変更を保存し、ファイルを閉じます。
- 変更を適用するために Web サーバを再起動します。トレース ログのコンテンツが決定されました。
保存されるトレース ログ ファイルの数の制限
Single Sign-On
エージェントが保持するトレース ログの数を制限できます。たとえば、エージェント ログを格納するシステム上のディスク空き容量を節約したい場合は、以下のパラメータを使用して、トレース ログの数を制限できます。TraceFilesToKeep
保持する
Single Sign-On
エージェント トレース ログ ファイルの数を指定します。以下の場合に新しいトレース ログが作成されます。- エージェントが起動したとき。
- トレース ログのサイズ制限(TraceFileSize パラメータの値で指定)に達したとき。
このパラメータの値を変更しても、保持数を超える既存のトレース ログは自動的に削除され
ません
。たとえば、システムに 500 個のトレース ログが格納されているときに、それらのファイルのうち 50 個のみを保持することを指定しても、エージェントは、残りの 450 個のトレース ログを削除しません
。このパラメータの値を 0 に設定すると、すべてのトレース ログが保持されます。
デフォルト
: 0以下の手順に従います。
- 既存のトレース ログをすべて、システムからアーカイブするか削除します。
- TraceAppend パラメータの値を no に設定します。
- TraceFilesToKeep パラメータの値を維持するトレース ログの数に変更します。
Agent Connection Manager のトレース ログによる詳細なエージェント接続データの収集
Web エージェントとポリシー サーバの間の接続に関する詳細情報を収集するために、Agent Collection Manager によって収集された情報が含まれているトレース ログ ファイルを作成します。
詳細な Web エージェント接続データを収集する方法
- エージェント設定オブジェクトまたはローカル設定ファイルを開きます。
- TraceFile パラメータの値を yes に設定します。注:Web サーバのローカル設定ファイル内でこのパラメータの値を yes に設定すると、ポリシー サーバ上で定義されたあらゆるロギング設定より優先されます。たとえば、LocalConfig.conf ファイル内でこのパラメータの値を yes に設定すると、ポリシー サーバ上の対応するエージェント設定オブジェクトで AllowLocalConfig パラメータの値を no に設定しても、ログ ファイルは生成されます。さらに、ポリシー サーバのトレース ログ設定をすべて上書きするには、LocalConfig.conf ファイル内の(ファイルの名前やサイズなどを定義する)関連するトレース ロギング パラメータを設定してください。
- TraceFileName パラメータの中で、エージェント接続データのトレース ログ ファイルの絶対パスを指定します。これは、トレース ログ出力を保持するファイルです。
- 以下のファイルの絶対パスに TraceConfigFile パラメータの値を設定します。web_agent_home/config/AgentConMgr.conf
- web_agent_homeSingle Sign-Onエージェントがインストールされているディレクトリを示します。デフォルト(Single Sign-OnWeb エージェントの Windows 32 ビット インストールのみ): C:\Program Files\CA\webagentデフォルト(Windows 64 ビット インストール [IIS 用Single Sign-OnWeb エージェントのみ]): C:\Program Files\CA\webagent\win64デフォルト(64 ビット システムで稼働している Windows 32 ビット アプリケーション[Wow64 と IIS 用Single Sign-OnWeb エージェントの組み合わせの場合のみ]): C:\Program Files (x86)\webagent\win32デフォルト(UNIX/Linux インストール): /opt/ca/webagent
- 以下のパラメータを設定することによって、エージェント接続データのトレース ログ ファイルの形式を指定します。
- TraceAppendロギングが有効になるたびにファイル全体を書き直す代わりに、既存のログ ファイルの最後に新しいログ情報を追加します。デフォルト:No
- TraceDelimiterトレース ファイル内のフィールドを区切るカスタム文字を指定します。デフォルト:デフォルトなし例:|
- TraceFileSizeトレース ファイルの最大サイズを指定します(メガバイト単位)。この制限に到達すると、Web エージェントは新しいファイルを作成します。デフォルト:0 (新しいログ ファイルは作成されません)例:20 (MB)
- TraceFormatトレース ファイルがメッセージを表示する方法を指定します。以下のいずれかのオプションを選択します。
- default - 角かっこ[]を使用してフィールドを囲みます。
- fixed - 固定幅のフィールドに使用します。
- delim - 選択した文字を使用してフィールドを区切ります。
- xml - XML-like タグを使用します。Web エージェントには、DTD (Document Type Definition、文書タイプ定義)や、他のスタイルシートは付属していません。
デフォルト:default (角かっこ) - LogLocalTimeログがグリニッジ標準時(GMT)とローカル時間のどちらを使用するかを指定します。GMT を使用するには、この設定を no に変更します。このパラメータが存在しない場合は、デフォルト設定が使用されます。デフォルト:Yes
- Web サーバを再起動すると、新しい設定が有効になります。Web エージェント接続に関する詳細情報が収集されます。注:Single Sign-On12.52 では、BusyHandleCount および FreeHandleCount 属性は使用されません。