IntroscopeAgent.profile プロパティ

apmsaas
IntroscopeAgent.profile ファイルで、プロパティを使用して、PHP エージェントを設定することができます。PHP エージェントは、これらのプロパティを標準的な接続および名前付けに使用します。インストール中に、PHP エージェント プロファイルは、別の場所を指定しない限り、
<Installation_Directory>
/apmia/core/config ディレクトリにインストールされます。
以下のプロパティを設定できます。
4
エージェント名
introscope.agent.agentName
ほかのエージェント名前付けの方法が失敗するときは、このプロパティのコメント化を解除し、デフォルトの PHP エージェント名を付けます。
例:
introscope.agent.agentName=Agent
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
エージェント拡張ディレクトリ
introscope.agent.extensions.directory
このプロパティは、PHP エージェントがロードするすべての拡張子の場所を指定します。絶対名以外で指定すると、このプロパティ設定ファイルを起点とする相対的な指定と見なされます。
例:
introscope.agent.extensions.directory=../../core/ext
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
エージェント メトリック クランプ
introscope.agent.metricClamp
このプロパティは、PHP エージェントが Enterprise Managerに送信するメトリックをクランプするおよその数を設定します。このプロパティが設定されていない場合、デフォルトでは PHP エージェントは 50000 メトリックでクランプをレポートします。新しいメトリックはレポートされませんが、既存のメトリックの値は引き続きレポートされます。
デフォルト:
50000
例:
introscope.agent.metricClamp=50000
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
エージェントのリモート プローブ
リモート プローブ ポート
introscope.remoteagent.collector.tcp.port
このプロパティは、Introscope がリモート プローブからイベントを収集するために接続をリスニングするポートを指定します。これらのプローブには、PHP、Ruby、.NET が含まれます。
値:
1 ~ 65535
デフォルト:
5005
例:
introscope.remoteagent.collector.tcp.port = 5005
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
リモート プローブ フィルタ
introscope.remoteagent.collector.probeid.filtering.enabled
このプロパティは、Enterprise Manager に送信する前に不要なイベントを除外するリモート PHP プローブを最適化します。このプロパティは、PHP プローブがフィルタリングをサポートしている場合にのみ有効です。フィルタリングがサポートされていない場合、このプロパティを設定をすると余分なオーバーヘッドが発生する可能性があります。このプロパティは、新しい PHP プローブ接続のみに対して有効になります。
値:
true または false
デフォルト:
True
例:
introscope.remoteagent.collector.probeid.filtering.enabled = true
AutoProbe プロパティ
AutoProbe を有効にします。
introscope.autoprobe.enable
このプロパティは、AutoProbe を有効および無効にします。
値:
true または false
デフォルト:
True
例:
introscope.autoprobe.enable=true
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
AutoProbe カスタム ログ ファイルの場所
introscope.autoprobe.logfile
このプロパティは、カスタム ログ ファイルの場所を指定します。AutoProbe は常に変更を記録しようとしています。ログ ファイルの場所をデフォルト以外の場所に移動するには、このプロパティを設定します。絶対名以外で指定すると、このプロパティ設定ファイルを起点とする相対的な指定と見なされます。
値:
カスタム場所
デフォルト:
../../logs/AutoProbe.log
例:
introscope.autoprobe.logfile=../../logs/AutoProbe.log
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
ディレクティブ ファイル
introscope.autoprobe.directivesFile[introscope.autoprobe.directivesFile]
AutoProbe によるインスツルメンテーションの実行方法を指定するすべてのディレクティブ ファイルを指定するプロパティです。単一エントリ、または複数エントリのカンマ区切りリストを指定します。リストには、以下のものの任意の組み合わせを含めることができます。
  • ディレクティブ(.pbd)ファイル
  • ディレクティブ リスト(.pbl)ファイル
  • pbd ファイルに対して毎分 1 回スキャンされるディレクトリ。
    リストに含まれたディレクトリ内に格納されているディレクティブ ファイルは、IntroscopeAgent.profile ファイルを編集しなくても自動的にロードされます。
絶対名以外で指定すると、このプロパティ設定ファイルを起点とする相対的な指定と見なされます。
これは必須パラメータであり、有効な値に設定する
必要があります
  • プロパティが指定されていない場合、または値が有効でない場合
    PHP エージェントは実行されません。
  • ディレクトリが含まれるようにプロパティが設定されており、そのディレクトリに無効なディレクティブ ファイルが配置される場合
    AutoProbe のメトリックはレポートされません。
  • ディレクトリが含まれるようにプロパティが設定されており、ロードされたディレクティブがそのディレクトリから削除された場合
    AutoProbe のメトリックはレポートされません。
例:
introscope.autoprobe.directivesFile=php-typical.pbl,hotdeploy
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
デフォルト プロセス名
introscope.agent.defaultProcessName
このプロパティは、カスタム プロセス名が指定されず、PHP エージェントがメイン アプリケーション クラスの名前を判断できない場合に、デフォルト プロセス名を指定します。デフォルト プロセス名は、Enterprise Manager および Workstation に表示されます。
例:
introscope.agent.defaultProcessName=Collector
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
Enterprise Manager 接続順序
introscope.agent.enterprisemanager.connectionorder
このプロパティは、Enterprise Manager から切断された場合に、PHP エージェントが使用する Enterprise Manager の接続順序リストを指定します。
デフォルト:
Default
例:
introscope.agent.enterprisemanager.connectionorder=DEFAULT
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
Enterprise Manager の場所および名前
ホストとポートの組み合わせ
このセクションで定義された名前は、
introscope.agent.enterprisemanager.connectionorder
プロパティでのみ使用されます。
これらのプロパティは、PHP エージェントが Enterprise Manager を検索するために使用する設定を指定します。また、ホストとポートの組み合せに付けられている名前を指定します。
introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT=orionphpcoda03 introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT=5001 introscope.agent.enterprisemanager.transport.tcp.socketfactory.DEFAULT=com.wily.isengard.postofficehub.link.net.DefaultSocketFactory
これらのプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
HTTP トンネルの有効化
以下の接続プロパティは、PHP エージェントから Enterprise Manager への HTTP によるトンネル通信を有効にします。
HTTP トンネリングは、PHP エージェントと Enterprise Manager のパフォーマンスに影響を与えます。HTTP トンネリングは、Enterprise Manager への直接ソケット接続が可能でない場合にのみ使用してください。たとえば、HTTP トラフィックを除いたすべてをブロックするファイアウォールで、PHP エージェントが Enterprise Manager から分離された場合がこれに当てはまります。
PHP エージェント用に HTTP トンネル エージェントを有効にする場合、以下のホスト、ポート、およびソケット ファクトリ プロパティのコメント化を解除します。Enterprise Manager Web サーバのホスト名およびポートを指定します。DEFAULT チャネルに割り当てられているほかのすべての接続プロパティのコメント化を解除します。DEFAULT チャネルが
introscope.agent.enterprisemanager.connectionorder
プロパティの値として割り当てられていることを確認します。
introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT=localhost introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT=8081 introscope.agent.enterprisemanager.transport.tcp.socketfactory.DEFAULT=com.wily.isengard.postofficehub.link.net.HttpTunnelingSocketFactory
これらのプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
プロキシ サーバを使用した Enterprise Manager への接続
場合によっては、PHP エージェントが HTTP でトンネルされているときに、プロキシ サーバ経由で Enterprise Manager に接続する必要があります。このような状況でのみ、以下のプロパティを使用します。以下に 2 つの例を示します。
PHP エージェントが指定されたホストとポートでプロキシ サーバと通信できない場合
PHP エージェントは Enterprise Manager への直接的な HTTP トンネル接続を試みた後で、接続が失敗します。
PHP エージェントは設定されたホストとポートでプロキシ サーバと通信できるが、認証が失敗した場合
PHP エージェントは、プロキシ サーバ経由で Enterprise Manager に接続する必要があります。
コメント化を解除して、適切なプロキシのホストおよびポートの値を設定します。
introscope.agent.enterprisemanager.transport.http.proxy.host introscope.agent.enterprisemanager.transport.http.proxy.port
これらのプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
プロキシ サーバ認証
以下のプロパティは、プロキシ サーバが認証を必要とする場合にのみ使用されます。コメント化を解除し、ユーザ名およびパスワードのプロパティを設定します。
NT LAN Manager (NTLM)認証情報の場合、エスケープされた円記号を使用して、ドメイン名とユーザ名を区切ります。例: mydomain.com\\jack01
introscope.agent.enterprisemanager.transport.http.proxy.username introscope.agent.enterprisemanager.transport.http.proxy.password
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
HTTPS を使用した Enterprise Manager への接続
HTTPS を使用して Enterprise Manager に接続するには、以下のプロパティのコメント化を解除します。ホストおよびポートを Enterprise Manager のセキュア https リスナのホストおよびポートに設定します。
introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT=localhost introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT=8444 introscope.agent.enterprisemanager.transport.tcp.socketfactory.DEFAULT=com.wily.isengard.postofficehub.link.net.HttpsTunnelingSocketFactory
SSL を使用した Enterprise Manager への接続
SSL を使用して Enterprise Manager に接続するには、以下のプロパティのコメント化を解除します。ホストおよびポートを Enterprise Manager SSL サーバ ソケットのホストおよびポートに設定します。
introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT=localhost introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT=5443 introscope.agent.enterprisemanager.transport.tcp.socketfactory.DEFAULT=com.wily.isengard.postofficehub.link.net.SSLSocketFactory
SSL を使用して Enterprise Manager に接続するための追加プロパティ
信頼される Enterprise Manager 証明書が含まれているトラストストアの場所
introscope.agent.enterprisemanager.transport.tcp.truststore.DEFAULT
トラストストアを指定しないと、PHP エージェントはすべての証明書を信頼します。PHP エージェントの作業ディレクトリへの絶対パスまたは相対パスを指定します。Windows では、円記号をエスケープします。たとえば、C:\\keystore のように記述します。
トラストストアのパスワード
introscope.agent.enterprisemanager.transport.tcp.trustpassword.DEFAULT
PHP エージェント証明書が含まれているキーストアの場所
introscope.agent.enterprisemanager.transport.tcp.keystore.DEFAULT
Enterprise Manager でクライアントの認証を必要とする場合、キーストアが必要です。PHP エージェントの作業ディレクトリへの絶対パスまたは相対パスを指定します。Windows では、円記号をエスケープします。たとえば、C:\\keystore のように記述します。
キーストアのパスワード
introscope.agent.enterprisemanager.transport.tcp.keypassword.DEFAULT
有効な暗号化スイートの設定
introscope.agent.enterprisemanager.transport.tcp.ciphersuites.DEFAULT
暗号化スイートのカンマ区切りリスト。指定しない場合、デフォルトの有効な暗号化スイートを使用します。
ErrorDetector の設定
エラー スナップショットの有効化
introscope.agent.errorsnapshots.enable
このプロパティは、エラー スナップショットが、重大なエラーのトランザクション詳細をキャプチャして、エラー数メトリックの記録を有効にすることを指定します。
値:
true = 有効、false = 無効
デフォルト:
True
introscope.agent.errorsnapshots.enable=true
管理対象アプリケーションの再起動は必要ありません。
エラー スナップショットの最大数
introscope.agent.errorsnapshots.throttle
このプロパティは、PHP エージェントが 15 秒間に送信できるエラー スナップショットの最大数を指定します。
例:
introscope.agent.errorsnapshots.throttle=10
管理対象アプリケーションの再起動は必要ありません。
特定エラー メッセージの無視
introscope.agent.errorsnapshots.ignore.0
このプロパティは、どのエラー メッセージを無視するのかを指定します。指定したフィルタと一致するメッセージのエラーについては、エラー スナップショットは生成または送信されません。0、1、2 およびワイルドカード(*)を使用して、数を指定できます。
introscope.agent.errorsnapshots.ignore.0=*com.company.HarmlessException* introscope.agent.errorsnapshots.ignore.1=*HTTP Error Code: 404*
管理対象アプリケーションの再起動は必要ありません。
die() または exit() によって中止される PHP スクリプトをエラーとして処理
introscope.agent.php.error.on.abort
die()
または
exit()
によって中止される PHP スクリプトをエラーとして処理します。
値:
true = 有効、false = 無効
デフォルト:
True
例:
introscope.agent.php.error.on.abort=true
管理対象アプリケーションの再起動は必要ありません。
ストール イベント
ストール イベント期間の最小しきい値
introscope.agent.stalls.thresholdseconds
このプロパティは、ストール イベント期間の最小しきい値を指定します。
例:
introscope.agent.stalls.thresholdseconds=30
管理対象アプリケーションの再起動は必要ありません。
PHP エージェントがストール イベントをチェックする頻度
introscope.agent.stalls.resolutionseconds
このプロパティは、PHP エージェントがストール イベントをチェックする頻度を指定します。
注:
introscope.agent.stalls.resolutionseconds=10
管理対象アプリケーションの再起動は必要ありません。
ログ記録設定
log4j.logger.IntroscopeAgent
ログ記録レベルと出力場所の両方を制御します。
値:
INFO、console、logfile
  • ログ記録レベルを引き上げるには、プロパティを以下のように設定します。
log4j.logger.IntroscopeAgent=VERBOSE#com.wily.util.feedback.Log4JSeverityLevel, console, logfile
  • 出力をコンソールのみに送信するには、プロパティを以下のように設定します。
    log4j.logger.IntroscopeAgent=INFO, console
  • 出力をログファイルのみに送信するには、プロパティを以下のように設定します。
    log4j.logger.IntroscopeAgent=INFO, logfile? ? ? ??
注:
管理対象アプリケーションの再起動は必要ありません。
ログ ファイルの場所
通常の使用で、以下のプロパティを変更しないでください。
  • log4j.additivity.IntroscopeAgent=false
  • log4j.appender.console=com.wily.org.apache.log4j.ConsoleAppender
  • log4j.appender.console.layout=com.wily.org.apache.log4j.PatternLayout
  • log4j.appender.console.layout.ConversionPattern=%d{M/dd/yy hh:mm:ss a z} [%-3p] [%c] %m%n
  • log4j.appender.console.target=System.err
  • log4j.appender.logfile=com.wily.introscope.agent.AutoNamingRollingFileAppender
  • log4j.appender.logfile.layout=com.wily.org.apache.log4j.PatternLayout
  • log4j.appender.logfile.layout.ConversionPattern=%d{M/dd/yy hh:mm:ss a z} [%-3p] [%c] %m%n
  • log4j.appender.logfile.MaxBackupIndex=4
  • log4j.appender.logfile.MaxFileSize=2MB
log4j.appender.logfile.File
logfile が
log4j.logger.IntroscopeAgent
プロパティで指定されている場合、ログ ファイルの場所は l
og4j.appender.logfile.File
プロパティを使用して設定されます。システム プロパティ(Java コマンド ライン
-D
オプションなど)は、ファイル名の一部として展開されます。
  • log4j.appender.logfile.File=../../logs/IntroscopeAgent.log
  • -Dmy.property=Server1
    を使用して Java が起動されると、
    log4j.appender.logfile.File=../../logs/Introscope-${my.property}.log
    が以下のように拡張されます。
log4j.appender.logfile.File=../../logs/Introscope-Server1.log
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
トランザクション追跡の設定
トランザクション追跡で許可されているコンポーネントの最大数
introscope.agent.transactiontrace.componentCountClamp
このプロパティのコメント化を解除して、トランザクション追跡で許可される最大コンポーネント数を指定します。デフォルトでは、クランプは 5000 に設定されます。そのクランプ値を超えるトランザクション追跡は PHP エージェントによって破棄されます。警告メッセージが PHP エージェントのログ ファイルに記録されます。
このクランプ サイズが大きくなると、メモリ要件も高くなります。したがって、最大 JVM ヒープ サイズを調整する必要があります。そうしないと、管理対象アプリケーションはメモリ不足に陥ってしまいます。
デフォルト:
5000
例:
introscope.agent.transactiontrace.componentCountClamp=5000
管理対象アプリケーションの再起動は必要ありません。
先頭フィルタリングで許可されるコンポーネントの深度
introscope.agent.transactiontrace.headFilterClamp
先頭フィルタリングは、トランザクション全体を収集する可能性のために、トランザクションの最初の部分を調べるプロセスです。先頭フィルタリングは、1 番目の追跡対象のコンポーネントが終了するまでチェックします。クランプが行われない場合、非常に深いコール スタックでこれが問題になる可能性があります。クランプの値は、固定されたレベルまで PHP エージェントに強制的に参照のみを実行させることにより、この動作によるメモリと CPU 使用率への影響を制限します。
先頭フィルタリングで使用できるコンポーネントの最大レベルを指定するには、このプロパティのコメント化を解除します。
トランザクション追跡のレベルがクランプを超えた場合、1 つの例外を除き、そのトランザクション追跡のコレクションはそれ以上行われません。その例外とは、サンプリングやユーザが開始したトランザクション追跡などのほかのメカニズムがアクティブで、コレクション対象のトランザクションが選択されていない場合です。
このクランプ サイズを大きくすると、必要なメモリが増えるため、ガベージ コレクションの動作に影響が及ぶ可能性があります。これは、アプリケーション全体のパフォーマンスに影響します。
例:
introscope.agent.transactiontrace.headFilterClamp=30
管理対象アプリケーションの再起動は必要ありません。
トランザクション追跡サンプリング
Transaction Tracer サンプリングの無効化
introscope.agent.transactiontracer.sampling.enabled
トランザクション追跡のサンプリングを無効にするには、このプロパティのコメント化を解除します。
値:
false = 有効、true = 無効
デフォルト:
False
例:
introscope.agent.transactiontracer.sampling.enabled=false
管理対象アプリケーションの再起動は必要ありません。
1 つのレポート サイクルで PHP エージェントによってレポートされるトランザクションの数の制限
introscope.agent.ttClamp
1 つのレポート サイクルで PHP エージェントによってレポートされるトランザクションの数を制限します。
デフォルト:
200
例:
introscope.agent.ttClamp=50
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
トランザクション追跡サンプリングの設定
これらのプロパティは通常、Enterprise Manager で設定されます。PHP エージェントでサンプリングを設定すると、Enterprise Manager 内の設定が無効になります。
introscope.agent.transactiontracer.sampling.perinterval.count=1 introscope.agent.transactiontracer.sampling.interval.seconds=120
これらのプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
高深度インスツルメンテーション
introscope.agent.deep.instrumentation.enabled
このプロパティを使用すると、高深度インスツルメンテーションが有効になります。false の場合には、高深度インスツルメンテーションはオフになります。
値:
true = 有効、false = 無効
デフォルト:
True
例:
introscope.agent.deep.instrumentation.enabled=true
このプロパティの変更を有効にするには、管理対象アプリケーションを再起動します。
高深度インスツルメンテーション コンポーネント
introscope.agent.deep.trace.enabled
このプロパティを使用すると、PHP エージェントは高深度可視性コンポーネントを収集し、Enterprise Manager にデータを送信できるようになります。false の場合、PHP エージェントは高深度インスツルメンテーション データを収集しません。
値:
true または false
デフォルト:
True
例:
introscope.agent.deep.trace.enabled=true
管理対象アプリケーションの再起動は必要ありません。
エラー スナップショットへの高深度コンポーネントの可視性
introscope.agent.deep.errorsnapshot.enable
このプロパティは、エラー スナップショットへの高深度コンポーネントの可視性を有効または無効にします。
値:
true = 有効、false = 無効
デフォルト:
True
例:
introscope.agent.deep.errorsnapshot.enable=true
管理対象アプリケーションの再起動は必要ありません。
コンポーネント制限の高深度追跡
introscope.agent.deep.trace.max.components
トランザクション追跡での高深度追跡コンポーネントの最大数を制限します。
例:
introscope.agent.deep.trace.max.components=5000
管理対象アプリケーションの再起動は必要ありません。
連続コンポーネント制限の高深度追跡
introscope.agent.deep.trace.max.consecutive.components
トランザクション追跡で、連続する高深度トランザクション追跡コンポーネントの最大数を制限します。
デフォルト:
15
例:
introscope.agent.deep.trace.max.consecutive.components=15
管理対象アプリケーションの再起動は必要ありません。
持続可能性メトリック
持続性メトリクスは、PHP エージェントの稼働状況および内部ステータスに関する情報を提供するために生成されます。これらのメトリックには大きいオーバーヘッドが関連しています。
introscope.agent.environment.java.metrics.enabled
このプロパティは、インフラストラクチャ エージェントで、Java バージョン、仮想マシン、および GC Heap:* メトリックを有効または無効にします。
値:
true= 有効、false = 無効
デフォルト:
True
例:
introscope.agent.environment.java.metrics.enabled=true