Web サービスのトレース

Web サービス・ランタイム・コンポーネント (非管理対象クライアント、管理対象クライアント、およびサーバー・アプリケーションを含む) をトレースできます。ランタイム・コンポーネント内では、処理アクションに加えてプロシージャーの入り口および出口もトレース可能です。ユーザー定義の例外と、Java™ Message Service (JMS) または HTTP を使用して Web サービスを要求する SOAP メッセージをトレースすることもできます。

始める前に

com.ibm.ws.webservices.engine.*=all=enabled 仕様は、Web サービス・ランタイムのみをトレースします。ユーザー定義の例外および SOAP メッセージをトレースするために使用可能な設定についてはステップ 4 を参照してください。また、tcpmon プロセスによる SOAP メッセージのトレースについては、tcpmon による SOAP メッセージのトレースに関する資料を調べてください。

このタスクについて

以下のタスクでは、Web サービスのトレースを使用可能にする方法について説明します。

手順

  1. Web サービス非管理クライアントのトレースを使用可能にします。
    1. [AIX Solaris HP-UX Linux Windows][z/OS]%install_root¥properties¥TraceSettings.properties ファイルを、クライアント・アプリケーション Java アーカイブ (JAR) ファイルと同じディレクトリーにコピーして、トレース・プロパティー・ファイルを作成します。
    2. [IBM i]app_server_root/properties/TraceSettings.properties ファイルを、クライアント・アプリケーション Java アーカイブ (JAR) ファイルと同じディレクトリーにコピーして、トレース・プロパティー・ファイルを作成します。
    3. [AIX Solaris HP-UX Linux Windows][z/OS]トレース・データを出力するために、プロパティー・ファイルを編集して、traceFileName の値を変更します。 例えば、traceFileName=c:¥¥temp¥¥myAppClient.trc のようになります。
    4. [IBM i]トレース・データを出力するために、プロパティー・ファイルを編集して、traceFileName の値を変更します。 例えば、traceFileName=/myDir/myAppClient.trc のようになります。
    5. プロパティー・ファイルを編集して、com.ibm.ejs.ras.*=all=enabled を除去し、 com.ibm.ws.webservices.engine.*=all=enabled を追加します。
    6. -DtraceSettingsFile=<trace_properties_file> オプションを、クライアントの実行に使用する java コマンド行に追加します。ここで、trace_properties_file は、サブステップ a から c で作成したプロパティー・ファイルの名前です。 例えば、java -DtraceSettingsFile=TraceSettings.properties myApp.myAppMainClass のようになります。
  2. 以下のオプションを使用して launchClient コマンド行ツールを起動し、Web サービス管理対象クライアントのトレースを使用可能にします。

    -CCtrace=com.ibm.ws.webservices.engine.*=all=enabled

    -CCtracefile=traceFileName

    以下に例を示します。
    [AIX Solaris HP-UX Linux Windows][z/OS]
    %install_root%¥bin¥launchClient MyAppClient.ear
    -CCtrace=com.ibm.ws.webservices.engine.*=all=enabled -CCtracefile=myAppClient.trc
    [IBM i]
    app_server_root/bin/launchClient MyAppClient.ear
    -CCtrace=com.ibm.ws.webservices.engine.*=all=enabled -CCtracefile=myAppClient.trc
    このツールについて詳しくは、launchClient ツールに関する情報を参照してください。
  3. Web Services for Java Platform, Enterprise Edition (Java EE) サーバー・アプリケーションに対するトレースを使用可能にします。
    1. WebSphere® Application Server を始動します。
    2. 管理コンソールを開きます。
    3. 「サーバー」 > 「アプリケーション・サーバー」 > serverとクリックします。
    4. ログ詳細レベルの変更」をクリックします。
    5. テキスト・ボックスのトレース・ストリングを追加、または削除します。このタスクの場合は、トレース・ストリング *=info を削除し、トレース・ストリング com.ibm.ws.webservices.engine.*=all=enabled を追加します。 テキスト・ボックス中のトレース・ストリングは、次の 2 つの方法 のどちらかで指定できます。
      • テキスト・ボックスに直接トレース・ストリングを入力します。各トレース・ストリングはスペースなしのコロン (:) で区切る必要があります。以下に例を示します。
        com.ibm.ws.webservices.trace.MessageTrace=finest:com.ibm.ws.webservices.
        engine.Message=finest
      • リストされているセクションから定義済みトレース・ストリングを選択します。定義済みセクションは、*[All Components] で始まります。定義済みトレース・ストリングの Web サービス・コンポーネントは、com.ibm..ws.* セクションにリストされています。
        • プラス (+) 記号をクリックして、com.ibm.ws.* セクションを拡張します。
        • 定義済みトレース・ストリングをクリックします。例えば、SOAP メッセージング・トレースの定義済みトレース・ストリングを追加したい場合は、com.ibm.ws.webservices.trace.MessageTrace をクリックすることができます。
        • ドロップダウン・リストからトレースのオプションをクリックします。例えば、 off、fatal、severe、warning、audit、info、config、detail、fine、finer、finest、および all を選択することができます。オプション「finest」を選択することを、お勧めします。オプションをクリックすると、そのオプションがトレース・ストリングの末尾に追加されます。 以下に例を示します。
          com.ibm.ws.webservices.trace.MessageTrace=finest
    6. 保存」または「適用」をクリックします。
    トレースの使用可能化について詳しくは、トレースおよびロギングの構成に関する情報を参照してください。
  4. SOAP メッセージのトレース、ユーザー定義の例外、またはその両方を使用可能にします。 SOAP メッセージのトレースには、以下のトレース仕様が使用されます。
    • com.ibm.ws.webservices.trace.MessageTrace=all

      この仕様は、SOAP メッセージの内容 (バイナリー添付ファイル・データを含む) をトレースします。

      SOAP メッセージのコンテキスト・タイプがテキストまたは xml 以外の場合、メッセージには添付ファイルが含まれている可能性があります。この場合、メッセージはトレース・ファイルに 16 進ダンプ・フォーマットで表示されます。以下の例は、非テキスト SOAP メッセージの 16 進ダンプ・フォーマットの行を示しています。
      0000: 0D 0A 2D 2D 2D 2D 2D 2D - 3D 5F 50 61 72 74 5F 36 ..------=_Part_6
      • トレース・ファイルの各行に、16 バイトのメッセージが表示されます。
      • 最初の 4 桁は 16 進数で、その値は行の最初のバイトの SOAP メッセージへのバイト・オフセットです。
      • 次の 16 個の 2 桁の 16 進数は、メッセージの連続バイトそれぞれの内容です。
      • そのバイトの ASCII 表記が、行の最後の 16 文字で表示されています。印刷不能な文字はピリオドで表されています。
    • *=off:com.ibm.ws.webservices.*=all

      この設定を使用すると、すべての Web サービス情報 (SOAP メッセージおよびユーザー定義の例外を含む) をトレースできます。

    com.ibm.ws.webservices.trace.UserExceptionTrace=all トレース・ストリングを指定して、ユーザー定義の例外のロギングを使用可能にできます。デフォルトでは、ユーザー定義の例外はログに記録されません。 ユーザー定義の例外は、Web サービス記述言語 (WSDL) ファイルに定義されている操作の例外です。

    ユーザー定義の例外は、エラー・フリー条件を表す場合があります。例えば、ユーザー定義の OverdrawnException 例外は、makeWithdrawl メソッドのサービス・エンドポイント実装で発生する場合があります。 この例外は、サービス・エンドポイント実装のエラ ーを示しているのではなく、予期される状態を示しています。 このようなタイプの例外は通常の処理中に発生する可能性があるため、デフォルトではログに記録されません。ユーザー定義の例外がログに記録される場合、情報は SystemOut.log ファイルではなく、trace.log ファイルに送信されます。

    注: このトピックでは、 1 つ以上のアプリケーション・サーバー・ログ・ファイルを参照します。推奨される代替案として、分散システムや IBM® i システムの SystemOut.logSystemErr.logtrace.logactivity.log ファイルではなく、High Performance Extensible Logging (HPEL) ログおよびトレース・インフラストラクチャーを使用するようにサーバーを構成できます。また HPEL は、ネイティブ z/OS® ロギング機能と連携させて使用することができます。HPEL を使用する場合、LogViewer コマンド・ライン・ツールを サーバー・プロファイルの bin ディレクトリーから使用して、すべてのログ・ファイルにアクセスし、 情報をトレースできます。HPEL の使用について詳しくは、HPEL を使用してのアプリケーションの トラブルシューティングに関する情報を参照してください。
    また、他のトレース・ポイントに加えて、以下のトレース・ストリングを使用することによっても、ユーザー定義の例外のトレースを使用可能にできます。
    • com.ibm.ws.webservices.*=all

      すべての Web サービス・ランタイム・トレース・ログをオンにします。

    • com.ibm.ws.webservices.trace.*=all

      MessageTrace および UserExceptionTrace をオンにします。

    トラブルの回避 (Avoid trouble) トラブルの回避 (Avoid trouble): このトレースがオンになると、SOAP メッセージ・ペイロード全体がトレース・ファイルに書き込まれることにご注意ください。SOAP メッセージ内にペイロードの一部として機密情報 (ユーザー ID やパスワードなど) が含まれる場合、その情報もプレーン・テキストとして出力されます。情報のセキュリティーの保護について適切な計画を立ててください。gotcha
    注: JAX-WS Web サービスの場合、 トレース・ファイル内の アウトバウンド HTTP SOAP メッセージインバウンド HTTP SOAP メッセージ を出力する方法は 2 つ (通常レベルと最小レベル) あります。
    通常レベルの設定
    com.ibm.ws.websvcs.trace.*=all
    最小レベルの設定
    com.ibm.ws.websvcs.trace.MessageTrace=all:com.ibm.ws.websvcs.trace.LogFilterInputStream=all

タスクの結果

これで、非管理対象クライアント、管理対象クライアント、およびサーバー・アプリケーションのトレースが使用可能になりました。トレース・ストリング仕様によって、ランタイム・コンポーネント、ユーザー定義の例外、および SOAP メッセージのいずれがトレースに含まれるかが決まります。

次のタスク

メッセージ・データを分析します。

トピックのタイプを示すアイコン タスク・トピック



タイム・スタンプ・アイコン 最終更新: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=twbs_tracewbscomp
ファイル名:twbs_tracewbscomp.html