New Relic Ruby エージェントの設定は、設定ファイルでの設定、環境変数での設定、またはプログラムによるサーバーサイドでの設定があります。本ドキュメントでは、Ruby エージェントで利用可能な設定オプションについてまとめています。
構成オプションのデフォルト値が(Dynamic)
の場合、これはRubyエージェントが実行時にデフォルトを計算することを意味します。構成設定の値は、デフォルトで別の設定の値になります。
設定方法と優先順位
Rubyエージェントを構成するための主要な(デフォルトの)方法は、 config
サブディレクトリーの構成ファイル( newrelic.yml
)を使用することです。環境変数を使用して構成値を設定するには:
- プレフィックス
NEW_RELIC_
を設定の名前に追加します。 - ピリオド
.
をアンダースコア_
に置き換えます。
また、 サーバーサイドの設定 を介して、UIでいくつかの値を設定することもできます。
Rubyエージェントでは、この優先順位に従って設定を行います。
- 環境変数
- サーバーサイドコンフィグレーション
- 構成ファイル(
newrelic.yml
) - デフォルトのコンフィギュレーション設定
つまり、環境変数は他のすべての設定や情報を上書きし、サーバー側の設定は設定ファイルやデフォルトのコンフィグ設定を上書きする、といった具合です。
コンフィグファイルオプションの表示と編集
Rubyエージェントのnewrelic.yml
は標準のYAML構成ファイルです。通常、上部にDefaults
セクションがあり、各アプリケーション環境の下部にセクションがあります。たとえば、 Development
、 Testing
、およびProduction
です。
Rubyエージェントは、特定の環境変数を調べてアプリケーションの環境を導出することにより、 newrelic.yml
構成ファイルのどのセクションから読み取るかを決定します。これは、たとえば、実稼働環境でlog_level
構成設定にinfo
を使用し、開発環境でより詳細なlog_level
構成設定( debug
など)が必要な場合に役立ちます。
newrelic.yml
設定ファイルの例を次に示します。
common: &default_settings
license_key: 'YOUR_LICENSE_KEY'
app_name: 'My Application Name'
production:
<<: *default_settings
log_level: info
development:
<<: *default_settings
log_level: debug
非Railsアプリの場合、Rubyエージェントは以下の環境変数をこの順番で探し、アプリケーション環境を判断します。
NEW_RELIC_ENV
RUBY_ENV
RAILS_ENV
APP_ENV
RACK_ENV
Rubyエージェントがこれらの環境変数のいずれの値も検出しない場合、Rubyエージェントはデフォルトでアプリケーション環境をdevelopment
に設定し、 newrelic.yml
構成ファイルのdevelopment
セクションから読み取ります。
RailsアプリでRubyエージェントを実行する場合、エージェントは最初にNEW_RELIC_ENV
環境変数を探して、アプリケーション環境とnewrelic.yml
のセクションを使用するかを決定します。 NEW_RELIC_ENV
が存在しない場合、エージェントはRails環境を使用します(Railsのバージョンに応じてRAILS_ENV
またはRAILS.env
)。
設定ファイルを編集する際には、次のことを確認してください。
- インデントはスペース2つ分のみ。
- error_collector のようなスタンザでは、関連する部分のみインデントします。
正しくインデントしないと、エージェントは起動時にUnable to parse configuration file
エラーをスローする可能性があります。
使用可能なRubyエージェント構成オプションの最新のリストを表示するには、 rake newrelic:config:docs
コマンドを使用します。このドキュメントでは、最も一般的なオプションについて説明します。
設定ファイルの更新
このドキュメントは、Rubyエージェントの最新リリースに適用されます。以前のバージョンの詳細については、 newrelic.yml
自体のコメントを参照してください。
新しいリリース後にnewrelic.yml
ファイルを更新するには、エージェントgemのベースディレクトリにあるテンプレートを使用します。新しいgemバージョンに更新するときは、インストールディレクトリのconfig/newrelic.yml
とnewrelic.yml
を調べるか差分をとって、新しい構成オプションを利用してください。
重要
gemを更新しても、 config/newrelic.yml
は自動的に更新されません。
一般
これらの設定は、エージェントの設定に利用できます。一部の設定は、New Relic のサブスクリプションレベルによって異なります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
あなたのNew Relic ライセンスキー 。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、Rubyエージェントの実行を許可します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
NewRelicUIでデータを集約するために使用するアプリケーション名を指定します。同時に複数のアプリにデータを報告するには、名前のリストをセミコロン;
で区切って指定します。たとえば、 MyApp
またはMyStagingApp;Instance1
。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはアプリに関するデータをNewRelicコレクターに送信します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
ログメッセージの詳細レベルを設定します。冗長性を高める場合に考えられるログレベルは、 error
、 warn
、 info
、またはdebug
です。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、高セキュリティモードを有効にします。この設定を有効にする前に、高セキュリティモードの影響を理解してください。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
言語エージェントセキュリティポリシーの設定を適用します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
プロキシサーバーを介して New Relic コレクター と通信するためのホストを定義します。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
プロキシサーバーを経由して New Relic コレクター と通信するためのポートを定義します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
プロキシサーバーを介して New Relic コレクター と通信するためのユーザーを定義します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
プロキシサーバーを経由して New Relic コレクター と通信するためのパスワードを定義します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはHTTPリクエストパラメータをキャプチャし、それらをトランザクショントレース、トレースされたエラー、およびTransactionError
イベントに添付します。
注意
capture_params
設定を使用する場合、Rubyエージェントは秘密情報のフィルタリングを試みません。推奨事項:要求パラメーターから秘密情報をフィルターに掛けるには、代わりにattributes.include
設定を使用してください。詳細については、 Ruby属性の例を参照してください。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
のパス newrelic.yml .未定義の場合、エージェントは次のディレクトリを(順に)チェックします: config/newrelic.yml , newrelic.yml , $HOME/.newrelic/newrelic.yml and $HOME/newrelic.yml .
タイプ | フロート |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED エージェントのバージョン3.5.0以降では、 New Relic UIでApdex Tを設定してください.
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
に設定すると、アプリケーションの起動時にNewRelicコレクターへの同期接続を強制します。非常に短期間のプロセスの場合、これはNewRelicエージェントがレポートする時間を確保するのに役立ちます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、シャットダウンする前にNewRelicコレクターにデータを送信するExitハンドラーを有効にします。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントがコレクターへの接続を試みる際の最大秒数を定義します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
シャットダウンする前に、キャッシュされたすべてのデータをコレクターに送信する出口ハンドラーを、通常はインストールされるべきではないシナリオの検出に関係なく、強制的にインストールします。このオプションの既知のユースケースは、Sinatraが別のフレームワーク内の組み込みサービスとして実行されており、エージェントがSinatraアプリを検出し、結果としてat_exit
ハンドラーをスキップする場合です。 Sinatraは、従来、アプリケーション全体をat_exit
ブロックで実行します。そうしないと、エージェントのat_exit
ハンドラーもそのような状況でインストールされた場合に誤動作します。注:この設定と並行して、 send_data_on_exit
もtrue
に設定する必要があります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
ログファイルの名前を定義します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
エージェント・ログ・ファイルのパスを定義します(ファイル名を除く)。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ActiveRecordインストルメンテーションにalias_method
ではなくModule#prepend
を使用します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクショントレースからのmemcacheキーのキャプチャを有効または無効にします。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
NewRelicコレクターにデータを送信するためのマーシャラーを指定します。現在、この設定の有効な値はjson
のみです。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
Rails 6で導入されたActiveRecordの接続検索の高速化をバックポートし、ActiveRecordをインストルメントする際のエージェントのパフォーマンスを向上させます。この設定は、ActiveRecordにパッチを当てる他のgemと互換性がないかもしれないことに注意してください。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
このエージェントから送信されるデータに適用されるラベル名と値の辞書。コロンで区切られた:
ペアのセミコロンで区切られた;
文字列として表現することもできます。たとえば、 <var>Server</var>:<var>One</var>;<var>Data Center</var>:<var>Primary</var>
。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
ローカル CA バンドルへのパスを手動でオーバーライドします。この CA バンドルは、New Relic のデータ収集サービスが提示する SSL 証明書を検証するために使用されます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはAgent.drop_buffered_data
のTracer::State
をクリアします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
newrelicのdistributed tracingヘッダを送信リクエストで抑制することを許可します。
トランザクショントレーサー
トランザクショントレース 機能は、選択したトランザクションから、呼び出しシーケンスの概要、費やした時間の内訳、SQL クエリのリストとそのクエリプラン(mysql および postgresql の場合)などの詳細な情報を収集します。利用可能な機能は、お客様の New Relic のサブスクリプションレベルによって異なります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、トランザクショントレースの収集を有効にします。
タイプ | フロート |
---|---|
デフォルト |
|
環境変数 |
|
しきい値を秒単位で指定します。このしきい値よりも長い期間のトランザクションは、トランザクショントレースの対象となります。 float値または文字列apdex_f
を指定します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクショントレースノードで報告されるSQLクエリの難読化レベル。
デフォルトでは、これはobfuscated
に設定されており、数値リテラルと文字列リテラルが削除されます。
- エージェントにクエリ情報をキャプチャさせたくない場合は、これを
none
に設定します。 - エージェントがすべてのクエリ情報を元の形式でキャプチャするようにする場合は、これを
raw
に設定します。 - 高セキュリティモードを有効にすると、これは自動的に
obfuscated
に設定されます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはRedisコマンド引数をトランザクショントレースに記録します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
非推奨代わりにtransaction_tracer.attributes.enabled
を使用してください。
タイプ | フロート |
---|---|
デフォルト |
|
環境変数 |
|
エージェントが説明プランを収集するしきい値(秒単位)。 explain_enabled
がtrueの場合にのみ関連します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、トランザクショントレースでのExplainプランの収集を有効にします。この設定は、 slow_sql.explain_enabled
が個別に設定されていない場合、遅いSQLトレースのプランを説明する場合にも適用されます。
タイプ | フロート |
---|---|
デフォルト |
|
環境変数 |
|
閾値を秒単位で指定します。エージェントは、スタックトレースの継続時間がこの閾値を超えた場合、トランザクショントレースノードにスタックトレースを含めます。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
1つのトランザクション・トレースに記録するトランザクション・トレース・ノードの最大数。
エラーコレクター
エージェントは、デフォルトでは、すべてのアンキャッチャー例外を収集して報告します。これらの設定オプションにより、エラー収集をカスタマイズすることができます。
無視されたエラーと予想されるエラーについては、APMのエラー分析に関するこのページを参照してください。 NewRelic::Agent.notice_error
Rubyメソッドを介して予想されるエラーを設定するには、 RubyAgentAPIを参照してください。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトレースされたエラーとエラーカウントメトリックをキャプチャします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
非推奨代わりにerror_collector.attributes.enabled
を使用してください。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
非推奨代わりにerror_collector.ignore_classes
を使用してください。エージェントが無視する必要のあるエラークラスのコンマ区切りリストを指定します。
注意
この設定では、サーバー側の設定がすべての環境設定よりも優先されます。これは、環境変数がサーバー側の設定よりも優先される他のすべての構成設定とは異なります。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントが無視すべきエラークラスのリストです。
注意
このオプションは、環境変数で設定することはできません。
タイプ | ハッシュ |
---|---|
デフォルト |
|
環境変数 |
|
メッセージのリストへのエラー・クラスのマップです。ここで指定されたクラスのエラーが発生したとき、そのエラーメッセージにここで指定された文字列のいずれかが含まれていれば、そのエラーは無視されます。
注意
このオプションは、環境変数で設定することはできません。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
コンマで区切られたステータスコードのリスト(場合によっては範囲を含む)。これらのステータスコードに関連するエラーは、該当する場合は無視されます。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントが期待通りに扱うべきエラークラスのリストです。
注意
このオプションは、環境変数で設定することはできません。
タイプ | ハッシュ |
---|---|
デフォルト |
|
環境変数 |
|
メッセージのリストへのエラー・クラスのマップです。ここで指定されたクラスのエラーが発生したとき、そのエラーメッセージにここで指定された文字列のいずれかが含まれていれば、そのエラーは期待どおりに処理されます。
注意
このオプションは、環境変数で設定することはできません。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
コンマで区切られたステータスコードのリスト(場合によっては範囲を含む)。これらのステータスコードに関連したエラー(該当する場合)は、期待通りに処理されます。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
エラーバックトレースの最大フレーム数を定義します。この数を超えるバックトレースは、最初と最後で切り捨てられます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはTransactionErrorイベントを収集します。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
ハーベストサイクルごとに報告される TransactionError イベント の最大数を定義します。
ブラウザの監視
ブラウザモニタリング ページロードタイミング 機能(リアルユーザーモニタリング(RUM)と呼ばれることもあります)は、実際のユーザーがお客様のウェブサイトで体験しているパフォーマンスを把握することができます。これは、各ページのヘッダーとフッターに少量のJavaScriptコードを注入することで、ユーザーのブラウザがWebページをダウンロードしてレンダリングするまでの時間を測定することで実現しています。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ページの読み込みタイミングのためにJavaScriptヘッダーの自動挿入を有効にします(実際のユーザー監視またはRUMと呼ばれることもあります)。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
非推奨代わりにbrowser_monitoring.attributes.enabled
を使用してください。
分析イベント
New Relic ダッシュボード は、お客様のソフトウェアに関するデータと、それがお客様のビジネスについて語っていることを収集し、視覚化するためのリソースです。これを使えば、リアルタイムのダッシュボードを素早く簡単に作成して、エンドユーザー・エクスペリエンス、クリックストリーム、モバイル・アクティビティ、サーバー・トランザクションに関する答えをすぐに得ることができます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED ご参照ください: transaction_events.enabled.
true
の場合、分析イベントのサンプリングを有効にします。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED ご参照ください: transaction_events.max_samples_stored.
1つのハーベストから報告されるリクエストイベントの最大数を定義します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
非推奨代わりにtransaction_events.attributes.enabled
を使用してください。
トランザクション・イベント
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、トランザクションイベントのサンプリングを有効にします。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
1つのハーベストから報告されるトランザクションイベントの最大数を定義する。
アプリケーションログ
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ログの装飾とログイベントおよびメトリックの収集を有効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはアプリケーションによって発行されたログレコードをキャプチャします。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
一度にメモリにバッファリングするログレコードの最大数を定義します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはアプリケーションのロギングに関連するメトリックをキャプチャします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはログをメタデータで装飾して、エンティティ、ホスト、トレース、およびスパンにリンクします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトレースされたメソッドのソースコードレベルのメトリックを報告します
属性
アトリビュート は、イベントやトランザクションのプロパティを決定する情報を含むキーとバリューのペアです。これらのキー・バリュー・ペアは、APMのトランザクション・トレース、APMのトレースされたエラー、ダッシュボードのトランザクション・イベント、ダッシュボードのページ・ビューで見ることができます。どの属性がこれらの各送信先に送信されるかを正確にカスタマイズできます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、すべての宛先の属性のキャプチャを有効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトランザクショントレースから属性をキャプチャします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトランザクションイベントから属性をキャプチャします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはエラー収集から属性をキャプチャします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはブラウザの監視から属性を取得します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはスパンイベントの属性をキャプチャします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトランザクションセグメントの属性をキャプチャします。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
すべての宛先から除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクショントレースから除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクションイベントから除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
エラー収集から除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
ブラウザの監視から除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
スパンイベントから除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクションセグメントから除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
すべての宛先に含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクショントレースに含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクションイベントに含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
エラー収集に含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
ブラウザの監視に含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
スパンイベントに含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクションセグメントに含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
監査ログ
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、NewRelicコレクターとの通信をログに記録する監査ログを有効にします。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
監査ログファイルのパス(ファイル名を含む)を指定します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
監査ログに含まれる許可されたエンドポイントのリスト
オートスタート
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントが自動的に起動しないようにする定数のリストを指定します。個々の定数はコンマ,
で区切ります。たとえば、 Rails::Console,UninstrumentedBackgroundJob
。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントがインストルメントしてはならない実行可能ファイルのコンマ区切りリストを定義します。たとえば、 rake,my_ruby_script.rb
です。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントがインストルメントしてはならないRakeタスクのコンマ区切りリストを定義します。たとえば、 assets:precompile,db:migrate
です。
クロスアプリケーショントレーサー
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: distributed_tracing-enabled.
true
の場合、 distributed_tracing.enabled
がfalse
に設定されているときにクロスアプリケーショントレースを有効にします。
カスタム属性
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
false
の場合、カスタム属性はイベントで送信されません。
カスタムイベント
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはカスタムイベントをキャプチャします。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
一度にメモリにバッファリングするカスタムイベントの最大数を指定します。
データストアトレーサー
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
false
の場合、エージェントはデータストアインスタンスメトリックを報告せず、トランザクションにhost
またはport_path_or_id
パラメータを追加したりSQLトレースを遅くしたりしません。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
false
の場合、エージェントはdatabase_name
パラメータをトランザクションに追加しないか、SQLトレースを遅くします。
無効化
これらの設定を使用して、エージェントの起動時に計測の種類を切り替えます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.rake.
true
の場合、Rakeインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、サンプラーメトリックの収集を無効にします。サンプラーメトリックは、イベントベースではないメトリックです(CPU時間やメモリ使用量など)。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.resque.
true
の場合、 Resqueインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、 Sidekiqインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.delayed_job.
true
の場合、 Delayed::Jobインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.sinatra.
true
の場合、 Sinatraインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、Sinatraのエージェントミドルウェアを無効にします。このミドルウェアは、クロスアプリケーショントレース、ページの読み込みタイミング、エラー収集などの高度な機能のサポートを担当します。
重要
クロスアプリケーショントレースは廃止され、 ディストリビュートトレースが採用されました 。分散トレーシングは、Rubyエージェントのバージョン8.0.0以降ではデフォルトでオンになっています。ミドルウェアは分散トレーシングをサポートする必要はありません。
クロスアプリケーショントレースを引き続き使用するには、 newrelic.yml
構成ファイルの次のオプションを更新します。
# newrelic.yml
cross_application_tracer: enabled: true distributed_tracing: enabled: false
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ビューインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、アクティブなレコードインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、DataMapperインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ActiveJobインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、アクションケーブルの計装を無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ActiveStorageインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.memcached.
true
の場合、memcachedgemのインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.memcache-client.
true
の場合、memcache-clientgemのインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.memcache.
true
の場合、ダリジェムのインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.memcache.
true
の場合、dalligemの追加のCASクライアントサポートのインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.memcache.
true
の場合、memcacheインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ガベージコレクションに費やされた時間を測定するためのGC::Profilerの使用を無効にします
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、 Sequelインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
非推奨代わりにdisable_sequel_instrumentation
を使用してください。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.mongo.
true
の場合、エージェントはMongogemのインストルメンテーションをインストールしません。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.redis.
true
の場合、エージェントはRedisのインストルメンテーションをインストールしません。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはRubyVMからパフォーマンス測定値をサンプリングしません。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはホストプロセスのメモリ使用量をサンプリングしません。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはホストプロセスのCPU使用率をサンプリングしません。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントは遅延ジョブキューの深さを測定しません。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ActiveRecord 4、5、および6のインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.bunny.
true
の場合、バニージェムのインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.curb.
true
の場合、縁石の宝石の計装を無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.exon.
true
の場合、excongemのインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.httpclient.
true
の場合、httpclientgemのインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.net_http.
true
の場合、Net::HTTPのインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.rack.
true
の場合、エージェントがRack :: Builderのto_app
メソッドにフックして、アプリケーションの起動時にインストルメントするgemを見つけるのを防ぎます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.rack_urlmap.
true
の場合、エージェントがRack::URLMapにフックしてミドルウェアトレースをインストールするのを防ぎます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.puma_rack.
true
の場合、エージェントがPuma :: Rack :: Builderのto_app
メソッドにフックして、アプリケーションの起動中にインストルメントするgemを見つけるのを防ぎます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.puma_rack_urlmap.
true
の場合、エージェントがPuma :: Rack::URLMapにフックしてミドルウェアトレースをインストールするのを防ぎます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.typhoeus.
true
の場合、エージェントはtyphoeusgemのインスツルメンテーションをインストールしません。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.httprb.
true
の場合、エージェントはhttp.rbgemのインストルメンテーションをインストールしません。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはサードパーティのミドルウェアをインストルメンテーションでラップしません(Rack :: BuilderまたはRailsのどちらを介してインストールされているかに関係なく)。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED Please see: instrumentation.grape.
true
の場合、エージェントはGrapeインストルメンテーションをインストールしません。
分散型トレーシング
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
分散トレーシングでは、リクエストが分散システムを通過する経路を確認することができます。分散トレーシングを有効にすると、New Relic の一部の機能の動作が変わるため、この機能を有効にする前に 移行ガイド をよく確認してください。
Heroku
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはホスト名としてHerokudyno名を使用します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
通常、エージェントはダイノ名の末尾にドットとプロセスIDを付けて報告します(例: worker.3 )。トレイリングデータなしで報告したいプレフィックスを指定することで、このトレイリングデータを取り除くことができます(例: worker )。
無限トレーシング
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
トレースオブザーバーホストのホスト名を設定します。設定すると、通常のエージェントによるサンプリングの決定とは関係なく、記録されたすべてのスパンをトレースオブザーバーに送信して、さらなるサンプリングの決定を行うテールベースのサンプリングが可能になります。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
Trace Observer Host の TCP/IP ポートを設定します。
計装
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Net::HTTP の自動計測を制御します。auto|prepend|chain|disabled]のいずれかを指定します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のTyphoeusの自動機器化を制御する。auto|prepend|chain|disabled]のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のバニーのオートインストルメントを制御します。auto|prepend|chain|disabled]のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のhttp.rb gemの自動計測を制御します。auto|prepend|chain|disabled]のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のResqueの自動計測を制御します。auto|prepend|chain|disabled]のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時にThreadクラスの自動インストルメンテーションを制御して、エージェントが非同期トランザクション内にスパンを正しくネストできるようにします。これにより、エージェントは作成されたすべてのスレッドを自動的にトレースできなくなります( instrumentation.thread.tracing
を参照)。 [auto | prefix | chain|disabled]のいずれかである可能性があります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
起動時にThreadクラスの自動インストルメンテーションを制御して、アプリケーションで作成されたすべてのスレッドにトレースを自動的に追加します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のRedisの自動導入を制御します。auto|prepend|chain|disabled]のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のレーキの自動計測を制御します。auto|prepend|chain|disabled]のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Mongo の自動計測を制御します。enabled|disabled] のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のディレイドジョブの自動計測を制御します。auto|prepend|chain|disabled]のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のHTTPClientの自動計測を制御します。auto|prepend|chain|disabled]のいずれかを指定します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のCurbの自動計装を制御する。auto|prepend|chain|disabled]のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のSinatraの自動計測を制御します。auto|prepend|chain|disabled]のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
ラックの自動計装を制御します。有効にすると、エージェントはRack :: Builderのto_app
メソッドにフックして、アプリケーションの起動時にインストルメントするgemを検索します。 [auto | prefix | chain|disabled]のいずれかである可能性があります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Rack::URLMap の自動入力を制御します。auto|prepend|chain|disabled]のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
Puma::Rackの自動計測を制御します。有効にすると、エージェントはPuma :: Rack :: Builderのto_app
メソッドにフックして、アプリケーションの起動時にインストルメントするgemを検索します。 [auto | prefix | chain|disabled]のいずれかである可能性があります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Puma::Rack::URLMap の自動入力を制御します。auto|prepend|chain|disabled]のいずれかを指定します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時にMemcache用のgemを自動的に導入するかどうかを制御します。auto|prepend|chain|disabled]のいずれかを指定します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時にMemcacheのためのmemcache-client gemを自動的にインストルメントすることを制御します。auto|prepend|chain|disabled]のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時にMemcache用のdalli gemの自動導入を制御します。auto|prepend|chain|disabled]のいずれかを指定します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Ruby 標準ライブラリ Logger の自動計測を制御します。auto|prepend|chain|disabled]のいずれかを指定します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のTiltテンプレート・レンダリング・ライブラリの自動導入を制御します。auto|prepend|chain|disabled]のいずれかを指定します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のExconの自動計測を制御します。有効|無効]のいずれかを指定します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時にActiveSupport::Loggerの自動計測を制御します。 [auto | prefix | chain|disabled]のいずれかである可能性があります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のGrapeのオートインストルメントを制御します。auto|prepend|chain|disabled]のいずれかになります。
メッセージトレーサー
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはメッセージに関するメタデータを収集し、それらをセグメントパラメータとして添付します。
Mongo
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトランザクショントレースでMongoクエリをキャプチャします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトランザクショントレースでMongoクエリを難読化します。
プロセスホスト
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
New Relic UI で 表示するカスタムホスト名を指定する 。
Rake
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
自動的にインストルメントするRakeタスクの配列を指定します。この構成オプションは、アレイをRegExリストに変換します。デフォルトですべてのタスクを許可する場合は、 rake.tasks: [.+]
を使用します。このリストに追加されない限り、レーキタスクはインストルメントされません。詳細については、(New Relic Rake Instrumentationドキュメント)[/ docs / apm / agent / ruby-agent / background-jobs/rake-instrumentation]にアクセスしてください。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
rakeタスクの前にconnectが完了するのを待つためのタイムアウト
Resque
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
非推奨true
の場合、Resqueでトランザクショントレースおよびトレースされたエラーのジョブ引数のキャプチャを有効にします。
ルール
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
無視したいURIにマッチするパターンのリストを指定することで、エージェントに無視させたいトランザクションを定義します。詳細は、(特定のトランザクションを無視する)[https://docs.newrelic.com/docs/agents/ruby-agent/api-guides/ignoring-specific-transactions/#config-ignoring]のドキュメントを参照してください。
Sidekiq
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
非推奨true
の場合、 Sidekiqでトランザクショントレースおよびトレースされたエラーのジョブ引数のキャプチャを有効にします。
Slow SQL
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントは低速のSQLクエリを収集します。
タイプ | フロート |
---|---|
デフォルト |
|
環境変数 |
|
閾値を秒単位で指定します。エージェントは、このしきい値を超えた 低速の SQL クエリ と説明プランを収集します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントは低速のSQLクエリでExplainプランを収集します。この設定を省略すると、低速SQLのExplainプランのデフォルト設定としてtransaction_tracer.explain_enabled
設定が適用されます。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
遅いSQLクエリの難読化レベルを定義します。有効なオプションは、 obfuscated
、 raw
、またはnone
です)。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
遅いSQLトレースのために長いsql_idを生成します。sql_idは類似したクエリの集約に使用されます。
スパンイベント
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、スパンイベントのサンプリングを有効にします。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
トレースオブザーバーにストリーミングする際にバッファするスパンイベントの最大数を設定します。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
1つのハーベストから報告されるスパンイベントの最大数を定義する。1~10000の任意の整数が有効です。
例外メッセージの除去
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
真であれば、エージェントは allowlist にあるものを除くすべての例外からのメッセージを取り除きます。 ハイセキュリティモードでは自動的に有効になります。.
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
strip_exception_messagesがtrue
の場合に、エージェントが削除しない例外のリストを指定します。例外はコンマで区切ります。たとえば、 "ImportantException,PreserveMessageException"
。
スレッドプロファイラー
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、スレッドプロファイラーの使用を有効にします。
活用
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはAWS環境で実行されていることを自動的に検出します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはAzure環境で実行されていることを自動的に検出します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはGoogleCloudPlatform環境で実行されていることを自動的に検出します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはPivotalCloudFoundry環境で実行されていることを自動的に検出します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはDockerで実行されていることを自動的に検出します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはKubernetesで実行されていることを自動的に検出します。