トランザクション

ノート

トランザクションの詳細については、次の文書を参照してください。例として、ヒットマップを使用したトランザクション分析のガイドについては、サブメニューである次の文書を参照してください。

トランザクショントレーシング

以下は、アプリケーションの各トランザクションの実行パスを詳細に追跡できるエージェントのオプションです。最小応答時間からトランザクションの実行ステップ数まで、様々な部分を調整可能です。

whatap.profile_step_normal_count Int

既定値 1000

トランザクショントレースの最大ステップ数を指定します。
whatap.profile_step_max_count Int

既定値 1024

収集可能なトレースステップの最大数を設定します。収集されたトレースステップの数がこの値を超えると、その後収集されるステップはすべて捨てられます。
whatap.profile_step_heavy_count Int

既定値 1000

基本ステップの収集数を超えるた場合は、実行時間がprofile_step_heavy_timeを超えるステップのみを収集します。そのステップの収集可能な数を設定します。Default設定のprofile_step_normal_countが800の場合、最大200個のステップが収集されます。
whatap.profile_step_heavy_time Millisecond

既定値100

Heavyなステップの基準を指定します。指定された値より実行時間が長い場合は、profile_step_normal_countを超える場合でもprofile_step_heavy_count以内で記録されます。
whatap.profile_basetime Millisecond

既定値500

トランザクションが設定値以下の時間内に終了した場合、トレース情報を収集しません。ただし、5分単位で最初に呼び出されたURL、エラーが発生したトランザクションに関するトレース情報は収集されます。
whatap.query_string_enabled Boolean

既定値false

トランザクションURLのクエリストリングをまとめて収集する機能を有効にします。whatap.query_string_urlsに登録されたURLのみ適用されます。
whatap.query_string_urls String

トランザクションからクエリストリングを収集するURLを登録します。
whatap.whatap.profile_compile_file_enabled Boolean

既定値false

compile_file、compile_string 関数が追跡されるかどうかを設定します。PHPの内部関数であるcompile_file、compile_string 関数はスクリプトを実行する前にコンパイルする関数で、Main、include、requireおよびautoloadスクリプトのコンパイル時間およびスクリプトファイルのパスと実行時間を確認できます。

ノート
ApacheおよびPHP-FPMの再起動後に有効になります。
whatap.profile_compile_file_basetime Millisecond

既定値200

実行時間の基準を設定します。設定した時間を超えて発生した場合のみ、情報を収集します。

注意
whatap.profile_compile_file_basetimeを小さく設定しすぎると、過剰な収集でサーバーに負荷をかける可能性があります。

ノート
ApacheおよびPHP-FPMの再起動後に有効になります。
whatap.profile_method_enabled Boolean

既定値 true

実行時間がwhatap.profile_method_timeの設定値(既定値1秒)を超えるユーザ関数の情報をトランザクション詳細情報を確認できます。

ノート
ApacheおよびPHP-FPMの再起動後に有効になります。
whatap.profile_method_time Milliseconds

既定値 1000

whatap.profile_method_enabled設定で収集される関数の実行時間を設定します。

ノート
ApacheおよびPHP-FPMの再起動後に有効になります。
whatap.profile_method_stack_enabled Boolean

既定値false

ユーザー関数のスタック情報をトランザクションの詳細から確認できます。

ノート
ApacheおよびPHP-FPMの再起動後に有効になります。
whatap.profile_internal_method_enabled Boolean

既定値false

PHP内部関数を追跡するかどうかを設定します。whatap.profile_internal_method_timeの設定値(既定値1秒)より長くかかる場合のみ追跡します。

注意
このオプションは、ユーザ定義関数ではなく、PHPの内蔵関数をすべて確認するため、性能に負荷が発生する可能性があります。

ノート
ApacheおよびPHP-FPMの再起動後に有効になります。
whatap.profile_internal_method_time Milliseconds

既定値 1000

PHP内部関数を追跡する場合、(whatap.profile_internal_method_enabled)関数の実行時間を設定します。

ノート
ApacheおよびPHP-FPMの再起動後に有効になります。
whatap.profile_internal_method_param_enabled Milliseconds

既定値 1000

PHPの内部関数を追跡する場合、(whatap.profile_internal_method_enabled)追加で関数のパラメータ情報を収集します。

ノート
ApacheおよびPHP-FPMの再起動後に有効になります。
whatap.net_udp_flush_start Boolean

既定値 true

値がfalseの場合、トランザクションの開始ポイントは収集しません。

ノート
開始時点で収集されていないため、進行中のトランザクション数を計算するアクティブトランザクション情報が少し遅れて反映される可能性があります。アクティブステータスは通常通り表示されます。
whatap.net_udp_profile_basetime_enabled Boolean

既定値false

値がtrueの場合、設定された応答時間より速いトランザクションのトレース情報は収集しません。
whatap.net_udp_profile_basetime Miliseconds

既定値false

トレース情報の収集を除外するトランザクションの応答時間を設定します。

ノート
トレース情報を収集しないため、SQL、HTTPCなどの統計には反映されません。
whatap.net_udp_trace_ignoretime_enabled Boolean

既定値false

値がtrueの場合、設定された応答時間を要するトランザクションおよびトレース情報を収集しません。
whatap.net_udp_trace_ignoretime Miliseconds

既定値30

トランザクションおよびトレース情報の収集を除くトランザクションの応答時間を設定します。
whatap.shm_tx_counter_enable Boolean

既定値false

値がtrueであれば、whatap.net_udp_trace_ignoretime_enabled設定でトランザクションの情報収集が除外される場合、TPS、平均応答時間、Apdex指標を共有メモリから収集すると、除外されたトランザクションの情報が統計に反映されます。

ノート
収集されていないトランザクションの場合、TPS、平均応答時間、Apdex指標に反映されますが、その他の統計データには反映されません。
whatap.split_profile_enabled Boolean

既定値false

一定量のプロファイルを仮想トランザクションに分割して、より多くのプロファイル情報を収集します。複数のトランザクション一覧に分割されます。

ノート
同時に設定された場合、優先順位は次の通りです。
1. split
2. large
3. circular
whatap.large_profile_enabled Boolean

既定値false

一定量のプロファイルを圧縮および分割して、メモリを増やことなく多くのプロファイル情報を収集できます。
ノート
- 約1万件のプロファイル(ステップ) 情報を収集できます。大量の場合は、whatap.split_profile_enabledオプションの使用をお勧めします。
- 同時に設定された場合、優先順位は次の通りです。
  
  1. split
  
  2. large
  
  3. circular
whatap.circular_profile_enabled Boolean

既定値false

最新の1024個のプロファイリング情報を収集します。

ノート
同時に設定された場合、優先順位は次の通りです。
1. split
2. large
3. circular
whatap.profile_zip_enabled Boolean

既定値 true

プロファイル情報を圧縮して送信します。既定値は、trueに設定されています。

whatap.trace_active_transaction_slow_time Millisecond

既定値 3000

収集情報を確認するダッシュボードのアクティブトランザクションアークイコライザーグラフでSlow区間として表示できるトランザクション応答時間の基準を指定します。トランザクションの応答時間が指定時間を超えた場合、Slowアクティブトランザクションの数に含まれます。
whatap.trace_active_transaction_very_slow_time Millisecond

既定値 8000
whatap.trace_active_transaction_lost_time Millisecond

既定値300000

トランザクションが終了する制限時間の5分以内にトランザクションが終了しない場合、トランザクション情報はそれ以上収集されません。トランザクションのトレース情報から"Lost Connection"を確認できます。
whatap.trace_useragent_enabled Boolean

既定値false

値がtrueの場合、トランザクションのユーザーエージェント情報を収集します。
whatap.trace_referer_enabled Boolean

既定値false

値がtrueであれば、トランザクションのRefere情報を収集します。

例外処理

以下は、アプリケーションで発生する例外を管理およびモニタリングするためのオプションです。ビジネス例外を登録し、関連する統計を収集することで、アプリケーションの安定性を確認できます。また、特定の例外を無視したりHTTPステータスコードがエラーの場合、エラーとして処理するかどうかを設定できます。例外として処理された項目は、ヒットマップまたはトレース分析画面で、正常なトランザクションとして表示されます。

whatap.biz_exceptions String

特定のErrorまたはExceptionをBusiness Exceptionに指定します。ヒットマップではエラーとして表記されず、統計情報にのみ収集されます。収集されるError Class 名と同様に適用します。コンマ(,)を区切り文字として複数登録できます。
whatap.conf
```
whatap.biz_exceptions=HttpConnectionServerError(400), GuzzleHttp\Exception\ServerException, CustomException
```
Tips
エラークラス収集 / ヒットマップ表示レベル：INFO(青色) / エラー統計を含む
whatap.ignore_exceptions String

登録したExceptionエラを無視します。

Exceptionの場合、Custom Exception Classが定義されていない場合、基本的にExceptionとして収集されます。特定のExceptionを区別するために、Custom Exception Classを定義し、その名前を指定することで除外できます。
whatap.conf
```
whatap.ignore_exceptions=HttpConnectionServerError(400), GuzzleHttp\Exception\ServerException, CustomException
```
Tips
エラークラス無視 / ヒットマップ表示レベル：INFO(青色) / エラー統計を含まない

HTTPトランザクションの追跡

以下は、HTTPリクエストと応答に関連する様々な情報を追跡および記録するエージェントのオプションです。これにより、ユーザーはアプリケーションのHTTPトランザクションを細かくモニタリングし分析できます。トランザクション名にパラメータ値を追加または特定のURLやHTTPメソッドを除外できます。またHTTPヘッダー情報やパラメータ情報を含め、トランザクションをより詳細に記録できます。

whatap.trace_normalize_enabled Boolean

既定値 true

トランザクションURLを変換して一般化する機能を有効にします。
whatap.trace_normalize_urls String

トランザクションURLを変換して一般化する対象URLを指定します。呼び出しURLパターンを変換してパスパラメータを削除します。

ノート
例えば、/a/{v}/bと設定すると、その形式で呼び出されたトランザクションURLは、/a/{v}/b形式として変換されます。複数の登録するときはコンマ(,)を使います。
whatap.trace_ignore_url_set String

特定のURLを設定すると、トランザクション追跡対象から除外されます。設定されたURLはトランザクション情報を収集せず、トランザクション一覧で確認できません。トランザクション追跡対象から除外するURLを指定します。2つ以上の値を指定する場合は、コンマ(,)を区切り文字として使用します。

ノート
このオプションを通じて登録したURLは、ヒットマップ, トレース分析またはトランザクション情報画面で収集が除外されます。
whatap.trace_ignore_url_prefix String

トランザクション追跡対象から除外するURL prefixを指定します。

ノート
このオプションを通じて登録したURLは、ヒットマップ, トレース分析またはトランザクション情報画面で収集が除外されます。
whatap.profile_http_header_enabled Boolean

既定値false

トレース履歴にHTTPヘッダーの情報を記録する場合に使用します。
whatap.profile_http_header_ignore_keys String

既定値host,accept,user-agent,referer, accept-language, connection

HTTP Header名を指定して、収集する情報から除外する機能を追加しました。指定されたHTTP Header名の値は収集から除外され、"#"として表示されます。
whatap.profile_http_parameter_enabled Boolean

既定値false

トレース履歴にHTTPパラメータ情報を記録する場合に使用します。パラメータは、別のセキュリティキーを入力しないと参照できません。

Get、Postパラメータで、textタイプの名前と値を収集します。最大40個(Get 20個、Post 20個) を収集し、パラメータ名と値は最大256 byteまで収集されます。

パラメータの情報は、別途に暗号化されて送信され、当該アプリケーションサーバの_/usr/whatap/php/security.conf_にあるキー(paramkey)で復号化して参照できます。
ノート
- PHP agent v2.8.0 or later: セキュリティキーはwhatap.iniファイルがあるWHATAP_HOME/security.confファイル内の6桁(paramkey)に設定します。
- Below PHP agent v2.8.0：セキュリティキーは、whatap.iniファイルがあるWHATAP_HOME/paramkey.txtファイルに６ケタで設定します。paramkey.txtファイルがない場合は、ランダムに値が自動生成されます。
whatap.profile_http_parameter_url_prefix String

既定値 /

トレース履歴にHTTPパラメータ情報を記録するために、対象URLのprefixを定義する場合に使用します。
whatap.profile_http_host_enabled Boolean

既定値false

トランザクションのHost情報を出力します。値がfalseの場合、トランザクションのURLはURIのみ表示され、trueの場合は、/xxx.aaa.com/URL形式で出力されます。
whatap.ignore_http_method String

設定したHTTPメソッド(Method)で要求されたトランザクション情報は収集しません。複数設定するには、コンマ(,)を区切り文字として利用してください。
whatap.ini
```
# e.g. http_methodがOPTIONS、HEADであるトランザクション"追跡"
ignore_http_method=PATCH,TRACE

# e.g. http_methodがOPTIONS、HEADであるトランザクション"無視"
ignore_http_method=OPTIONS,HEAD
```
ノート
このオプションを通じて登録したHTTPメソッドは、ヒットマップ, トレース分析またはトランザクション情報画面で収集が除外されます。

マルチトランザクショントレース

以下は、アプリケーション間の呼び出しを追跡しモニタリングするためのオプションです。このオプションにより、ユーザーは複数のアプリケーション間の相互作用を理解できます。提供する様々なオプションにより、マルチトランザクションの追跡に対する詳細な動作を調整できます。

whatap.mtrace_enabled Boolean

既定値false

マルチトランザクション追跡機能(MTID) を使用可否を設定します。MTIDを追跡すると、登録されたすべてのアプリケーション間の呼び出しを確認できます。
whatap.mtrace_rate Percentage

既定値10

最初のトランザクションが発生したときに発行されるMTID(Multi Transaction ID)の発行比率を設定するオプションです。
whatap.mtrace_poid_key String

既定値x-wtap-po

MTID追跡に使用するCallerプロジェクトの情報を渡すためのKey Nameを設定します。
whatap.mtrace_caller_key String

既定値 x-wtap-mst

MTID追跡に使用するCaller Key Nameを設定します。
whatap.mtrace_callee_key String

既定値 x-wtap-tx

MTID追跡に使用するCallee Key Nameを定義します。
whatap.mtrace_send_url_length Int

既定値80

HTTP Callerは、CalleeにURLを渡します。この時、URLの長さを制限しています。この長さを指定します。