エラー ログとトレース ログ

目次
sm1252sp1jjp
目次
Web エージェントのパフォーマンスを監視したり、Web エージェントとポリシー サーバの通信状態を確認したりする場合は、Web エージェントのロギング機能を使用します。ロギング機能は、パフォーマンスを分析して問題をトラブルシューティングすることを目的として、プロセスの動作に関する正確で包括的な情報を提供します。
ログとは、プログラムを実行している間に発生したイベントからなる記録のことです。1 つのログは、一連のログメッセージによって構成されています。各ログメッセージは、プログラムを実行している間に発生した何らかのイベントについて記述しています。ログメッセージは、ログファイルに書き込まれます。
注:
IIS エージェントは、最初のユーザ要求が送信されてから、ログ ファイルを作成します。Apache 2.0 Web エージェントでは Apache サーバの起動時にログ ファイルが作成されます。
Web エージェントは、以下のログ ファイルを使用します。
  • エラー ログ
    プログラム レベルおよび操作レベルのエラーが含まれます。たとえば、エージェントがポリシー サーバと通信できない場合を示します。このログの詳細出力のレベルはカスタマイズできません。エラー ログに含まれるメッセージのタイプは、以下のとおりです。
    • エラーメッセージ
      プログラム レベルのエラーが含まれます。これらは、プログラムの不適切または異常な動作、あるいはネットワーク障害のような何らかの外部の問題に起因すると考えられる機能障害を示しています。動作レベルのエラーもあります。このエラーのタイプは、ファイルを開く、またはユーザを認証するなどの動作の成功を妨げる障害を意味します。
    • 情報メッセージ
      何らかのイベントが発生したことをユーザまたは管理者に知らせることを目的とするメッセージです。つまり、サーバの起動や停止、または何らかのアクションが実施されたことを意味します。
    • 警告メッセージ
      通常とは異なる状況やイベント、または潜在的な問題を示唆している状況やイベントについて、ユーザまたは管理者に警告することを目的とするメッセージです。これは必ずしも、何かが誤っていることを意味するとは限りません。
  • トレース ログ
    詳細な警告メッセージと情報メッセージが含まれます。これらは、設定することができます。たとえば、トレース メッセージやフロー状態メッセージが含まれます。また、このファイルには、ヘッダの詳細や cookie 変数などのデータも含まれます。トレース ログに含まれるメッセージは、以下のとおりです。
    • トレース メッセージ
      トレースまたはデバッグ、あるいはその両方の目的で、プログラムの動作に関する詳細な情報を提供します。トレース メッセージは一般的に、通常の動作時は無効にしておきます。情報、警告、およびエラーの各メッセージとは対照的に、トレース メッセージはソース コード内に埋め込まれていて、容易にはローカライズできません。さらに、トレース メッセージには、メッセージ自体の他に、重要なデータが含まれていることがあります。たとえば、現在のユーザやレルムの名前です。
Web エージェントを設定するときに、エラー ログ ファイルとトレース ログ ファイルの両方のロケーションを指定します。エラー ログとトレース ログは、Web エージェントの正常な動作を妨げている可能性がある問題の解決に役立ちます。
注:
Windows プラットフォーム上のエージェントの場合、EnableWebAgent パラメータを yes に設定すると、Web エージェント ログが確実に作成されます。EnableWebAgent を no(デフォルト)のままにして、ログ パラメータを設定した場合は、UNIX プラットフォーム上のエージェントに対するエージェント ログのみが作成されます。
ログ ファイルに表示されるパラメータ値
Web エージェントは、Web エージェントのエラー ログ ファイルに、設定パラメータとその値をリストしますが、トラディショナル エージェントとフレームワーク エージェントとでその方法は異なります。
フレームワーク エージェントでは、エージェント設定オブジェクトまたはローカル設定ファイルに入力されているとおりに、設定パラメータとその値がログ ファイルに正確に記録されます。値が正しくない可能性があるパラメータを含め、すべてのパラメータがログ ファイルに記録されます。
トラディショナル エージェントでは、パラメータ値を記録する前に処理が行われます。パラメータの値が正しい場合は、パラメータとその値がログ ファイルに記録されます。値が正しくないパラメータは、ログ ファイルに記録
されません
エラー ロギングのセットアップと有効化
エラー ログには次の設定が必要です。
  • ロギングが有効になります。
  • ログ ファイルの場所を指定する。
エラー ロギングを有効にするパラメータや、ログ データを追加するなどのオプションを指定するパラメータは、ローカル設定ファイル、またはポリシー サーバのエージェント設定オブジェクトに定義されます。
IIS または Apache の Web サーバにインストールされるエージェントは、ローカル設定ファイルでローカルに設定されるログ パラメータの動的な設定をサポートしません。変更はエージェントが再起動されたときに有効になります。ただし、これらのログ設定をポリシー サーバのエージェント設定オブジェクトに格納し、動的に更新することができます。
IIS エージェントは、最初のユーザ要求が送信されてから、ログ ファイルを作成します。Apache 2.0 Web エージェントでは Apache サーバの起動時にログ ファイルが作成されます。
以下の手順に従います。
  1. ログ ファイルがまだない場合は、ログ ファイルと関連ディレクトリを作成します。
  2. LogFile パラメータの値を yes に設定します。
    sm1252sp1jjp
    : Web サーバのローカル設定ファイル内でこのパラメータの値を Yes に設定すると、ポリシー サーバ上で定義されたあらゆるロギング設定を上書きします。たとえば、このパラメータの値が LocalConfig.conf ファイルで yes に設定されていると仮定します。たとえ対応するエージェント設定オブジェクトの AllowLocalConfig パラメータの値が no に設定されていたとしても、エージェントはログ ファイルを作成します。また、エージェント設定オブジェクト内の他の設定を上書きするために、LocalConfig.conf ファイル内の関連するロギング パラメータも設定できます。
  3. ファイル名も含め、エラー ファイルの絶対パスを、以下のいずれかのパラメータで指定します。
    • sm1252sp1jjp
      LogFileName
      ログ ファイルの完全パス(ファイル名を含む)を指定します。
      デフォルト
      : No
      例:
      (Windows)
      web_agent_home
      \log\WebAgent.log
      例:
      (UNIX/LInux) /export/iPlanet/servers/https-jsmith/logs/WebAgent.log
    • sm1252sp1jjp
      LogFileName32
      IIS (32 ビット アプリケーションを保護する 64 ビット Windows オペレーティング環境上にある)用の Web エージェントのログ ファイルの完全パスを指定します。32 ビット アプリケーションは、64 ビット Windows オペレーティング環境では Wow64 モードで実行されます。ロギングが有効であるが、このパラメータが設定されていない場合、IIS 用 Web エージェントはログ ファイル名の末尾に _32 を追加します。
      デフォルト
      : No
      制限:
      Windows 64 ビット オペレーティング環境のみ。パスの最後にファイル名を指定します。
      : (Windows 64 ビット オペレーティング環境で Wow64 モードを使用)
      web_agent_home
      \log\WebAgent32.log.
  4. (省略可)以下のパラメータを設定します(ポリシー サーバのエージェント設定オブジェクト、またはローカル設定ファイルで設定します)。
    • sm1252sp1jjp
      LogAppend
      既存のログ ファイルの最後に新しいログ情報を追加します。このパラメータを no に設定した場合、ロギングが有効になるたびに、ログ ファイル全体が上書きされます。
      デフォルト
      : No
    • sm1252sp1jjp
      LogFileSize
      ログ ファイルのサイズ制限(メガバイト単位)を指定します。現在のログ ファイルがこの制限に到達すると、新しいログ ファイルが作成されます。新しいログ ファイルは、以下の命名規則のうちの 1 つを使用します。
      • フレームワーク エージェントでは、新しいログ ファイルの名前は、元の名前にシーケンス番号が追加されたものになります。たとえば、サイズ制限に到達すると、myfile.log という名前のログ ファイルは myfile.log.1 に名前が変更されます。
      • 従来のエージェントでは、新しいログファイルの名前は、元の名前に日付とタイムスタンプが追加されたものになります。たとえば、サイズ制限に到達すると、myfile.log という名前のログ ファイルは myfile.log.09-18-2003-16-07-07 に名前が変更されます。
      古いファイルは手動でアーカイブするか削除する必要があります。
      デフォルト:
      0(ロールオーバーなし)
      例:
      80
    • sm1252sp1jjp
      LogLocalTime
      ログがグリニッジ標準時(GMT)とローカル時間のどちらを使用するかを指定します。GMT を使用するには、この設定を no に変更します。このパラメータが存在しない場合は、デフォルト設定が使用されます。
      デフォルト:
      Yes
      ローカル設定ファイルを使用する場合、設定は以下の例のようになります。
      LogFile="yes" LogFileName="/export/iPlanet/servers/https-myserver/logs/errors.log" LogAppend="no" LogFileSize="80" LogLocalTime="yes"
    エラー ロギングが有効になります。
トランスポート層インターフェース(TLI)ロギングの有効化
エージェントとポリシー サーバの間の接続を検討する場合は、トランスポート層インターフェース ロギングを有効にします。
TLI ロギングを有効にする方法
  1. Web サーバに以下の環境変数を追加します。
    SM_TLI_LOG_FILE
  2. 以下の例に示されるように、変数の値のディレクトリおよびログ ファイル名を指定します。
    directory_name
    /log_file_name.log
  3. エージェントが有効であることを確認します。
  4. Web サーバを再起動します。
    TLI ロギングが有効になります。
保存されるログ ファイルの数の制限
エージェントが保持するログ ファイルの数を制限できます。たとえば、エージェント ログを格納するシステム上のディスク空き容量を節約したい場合は、以下のパラメータを使用して、ログ ファイルの数を制限できます。
LogFilesToKeep
保持するエージェント ログ ファイルの数を指定します。以下の場合に新しいログ ファイルが作成されます。
  • エージェントが起動したとき。
  • ログ ファイルのサイズ制限(LogFileSize パラメータの値で指定)に達したとき。
このパラメータの値を変更しても、保持数を超える既存のログ ファイルは自動的に削除
されません
。たとえば、システムに 500 個のログ ファイルが格納されているときに、それらのファイルのうち 50 個のみを保持することを指定しても、エージェントは、残りの 450 個のファイルを削除
しません
このパラメータの値を 0 に設定すると、すべてのログ ファイルが保持されます。
デフォルト
: 0
以下の手順に従います。
既存のログ ファイルをすべて、システムからアーカイブするか削除します。
LogAppend パラメータの値を no に設定します。
LogFilesToKeep パラメータの値を維持するログ ファイルの数に変更します。