Rubyエージェント設定オプション

このページでは、APMインサイトのRubyエージェント設定プロファイルをチューニングするための情報を提供します。設定プロファイルでは、パラメーターとWebトランザクションにしきい値の設定ができます。設定は、apminsight.confファイルかWebクライアントから実行してください（資産アイコン）。apminsight.confファイルは、APMインサイト エージェントのデプロイ先ディレクトリに存在する必要があります。

APMエージェント設定プロファイルは、2つの部分に分類されます。

基本設定プロファイル

設定 説明 デフォルト値
application.name*
  • Applications Managerでのアプリケーションの表示名を指定してください。
  • アプリケーションに複数インスタンスがあって、それらをグループにする場合は、すべてのインストールするAPMインサイト エージェント設定ファイルに同じアプリケーション名を指定する必要があります。

例：myonlineshopping.com

My Application

behind.proxy
  • エージェントをインストールしたアプリケーション サーバーへの接続に、プロキシを経由するか否かを指定してください。
  • trueの場合、エージェントからApplications Managerへのメトリック データ送信に、プロキシ認証情報の指定が必要となります。
  • behind.proxyをtrueにセットする場合、次のキーに値を指定してください。
    • proxy.server.host：プロキシ サーバーのホスト名
    • proxy.server.port：プロキシ サーバーのポート
    • proxy.auth.username：プロキシ サーバーのユーザー名
    • proxy.auth.password：プロキシ サーバーのパスワード

false

agent.server.port*
  • アプリケーション サーバーのHTTPリスニング ポートを指定してください。
  • 同じホストで、同じアプリケーション サーバーが複数稼働しているとき、インスタンスを区別するのに便利です。例：8080
 8080

データベースSQLクエリの捕捉 資産アイコン
  • このオプションを有効にすると、実行したクエリすべてをリスニングします。
  • 無効の場合、データベース メトリックは収集しません。

true

トランザクション トレースでのSQLのパラメーター化 資産アイコン
  • このオプションを有効にすると、スロウなトランザクションのトレースにあるSQLクエリは、すべてパラメーター表記となります（sql.capture.enabledとtransaction.trace.enabledをtrueにする必要があります）。
  • 無効の場合、実際のクエリ内容が、パラメーターの値とともに取得されます。
  • クエリ実行の際、クレジットカード番号やパスワードなど秘密パラメーターを利用している場合は、この機能を有効にするよう推奨します。

true

トランザクション トレースでのSQL向けスタック トレースしきい値 資産アイコン
  • このオプションを有効にすると、SQLクエリがしきい値を超えた際、スタック トレースの収集を行います。

3（秒）
下記のプロパティは、Applications Managerのビルド14440以上に適用されます。

license.key*
  • Applications Managerに対応するライセンスキーです。
  • APMインサイト タブ > ヘルプ カードで見つかります。
  • 値をコピーしてこのパラメーターに利用してください。
  • このキーはApplications Managerごとに固有であり、ほかの方とは共有しないでください。
例：
license.key=APMI_38497e5d7f08c97214db485882372818b854445c98e2927e94

apm.host*
  • Applications Managerが稼働しているホストの名前です。
  • 入力したホスト名が無効や到達不能の場合、エージェントは「Connection Refused」の例外を投げ、正しいホスト名がapminsight.confに設定されるまでリトライを続けます。
  • 指定はホスト名でもIPv4アドレスでも可能です。

例：mymachine.mydomain.com

 localhost

apm.protocol.https
  • Applications ManagerにデータをHTTPSで送る場合は、trueを指定します。
  • falseを指定すると、HTTPでの送信となります。

false

apm.port*
  • サービスが指定ポートで実行されていない場合、エージェントは「Connection Refused」例外を投げ、apminsight.confに正しいポートが入力されるまでリトライします。
 9090

メモ：
  • *マークのあるオプションは必須項目です。必須エントリの指定が無い場合、エージェントは初期化や起動ができません。ただし、エージェント デプロイ先のアプリケーション サーバーは正常起動します。
  • これらのオプション変更を有効にするには、アプリケーション サーバーの再起動が必要です。
  • apminsight.confファイルのオプションはすべて環境変数でも指定できます。環境変数は波括弧で囲ってください。

    例：
    application.name={app_name}
    ここでは、app_nameが環境変数です。

    メモ：エージェントは環境変数をENVハッシュでのみ探します。

Webトランザクション設定

設定 説明 デフォルト値

Apdexしきい値 資産アイコン
  • Apdexスコア（Application Performance Index）はアプリケーションのパフォーマンスを測定し、0から1の間で示します。
  • 詳細情報はwww.apdex.orgを参照ください（英語）。
  • トランザクション応答時間のスコアに、Apdexしきい値より低いものがあれば、トランザクションは満足と判定されます（satisfied）。
  • トランザクション応答時間のスコアに、Apdexしきい値の4倍を超えるものがあれば、トランザクションは不満と判定されます（frustrated）。
  • Apdexしきい値とまったく同じか、満足と不満の間の場合は、容認と判定されます（tolerating）。

0.5（秒）

サンプル係数 資産アイコン
  • サンプリング係数を指定します。20にすれば、同一種別のリクエストは20個ごとに取得します（1番名、21番目、41番目…）。

1（リクエスト）

トランザクション トレーシングの有効化 資産アイコン
  • このオプションを有効にすると、スロウなトランザクションでトレース構築を実行します。
  • Applications Mangerが収集したトレースは、APMインサイト ページでトレース タブを選択すると、確認できます。

true

トランザクション トレーシングのしきい値 資産アイコン
  • transaction.trace.enabledをtrueにしてある場合、応答時間が指定のしきい値を超えるトランザクションのトレースを収集します。
  • トレースは、動作中のトランザクションの分析・トラブルシュートに利用できます。

2（秒）

無効値が指定された場合は、デフォルト値を採用します。