New Relic Ruby エージェントの設定は、設定ファイルでの設定、環境変数での設定、またはプログラムによるサーバーサイドでの設定があります。本ドキュメントでは、Ruby エージェントで利用可能な設定オプションについてまとめています。
構成オプションのデフォルト値が(Dynamic)
の場合、これはRubyエージェントが実行時にデフォルトを計算することを意味します。構成設定の値は、デフォルトで別の設定の値になります。
構成方法と優先順位
Rubyエージェントを構成するための主要な(デフォルトの)方法は、 config
サブディレクトリーの構成ファイル( newrelic.yml
)を使用することです。環境変数を使用して構成値を設定するには:
- プレフィックス
NEW_RELIC_
を設定の名前に追加します。 - ピリオド
.
をアンダースコア_
に置き換えます。
また、 サーバーサイドの設定 を介して、UIでいくつかの値を設定することもできます。
Rubyエージェントでは、この優先順位に従って設定を行います。
- 環境変数
- サーバー側の構成
- 構成ファイル(
newrelic.yml
) - デフォルトのコンフィギュレーション設定
つまり、環境変数は他のすべての設定や情報を上書きし、サーバー側の設定は設定ファイルやデフォルトのコンフィグ設定を上書きする、といった具合です。
コンフィグファイルオプションの表示と編集
Rubyエージェントのnewrelic.yml
は標準のYAML設定ファイルです。 通常、上部にDefaults
セクションが含まれ、その下に各アプリケーション環境のセクション ( Development
、 Test
、 Staging
、および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: infodevelopment: <<: *default_settings log_level: debug
Ruby エージェントは、アプリケーション環境を見つけるために、次の環境変数をこの順序で探します。
NEW_RELIC_ENV
RUBY_ENV
RAILS_ENV
APP_ENV
RACK_ENV
Ruby エージェントがこれらの環境変数の値を検出しない場合は、アプリケーション環境をデフォルトでdevelopment
に設定し、 newrelic.yml
構成ファイルのdevelopment
セクションから読み取ります。
Rails アプリで Ruby エージェントを実行する場合、エージェントは最初にNEW_RELIC_ENV
環境変数を検索して、アプリケーション環境と使用するnewrelic.yml
のセクションを見つけます。NEW_RELIC_ENV
が存在しない場合、エージェントは Rails 環境 ( 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 のサブスクリプションレベルによって異なります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、Rubyエージェントの実行を許可します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
NewRelicUIでデータを集約するために使用するアプリケーション名を指定します。同時に複数のアプリにデータを報告するには、名前のリストをセミコロン;
で区切って指定します。たとえば、 MyApp
またはMyStagingApp;Instance1
。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
あなたのNew Relic 。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
ログメッセージの詳細レベルを設定します。冗長性を高める場合に考えられるログレベルは、 error
、 warn
、 info
、またはdebug
です。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
サブスクライブして計測する ActiveSupport カスタム イベント名の配列。例えば、
- one.custom.event
- 別のイベント
- a.second.event
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
あなたのNew Relic 。 New Relic REST API v2 を使用してnewrelic deployments
コマンドでデプロイメントを記録する場合に必要です。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
Rails 6で導入されたActiveRecordの接続検索の高速化をバックポートし、ActiveRecordをインストルメントする際のエージェントのパフォーマンスを向上させます。この設定は、ActiveRecordにパッチを当てる他のgemと互換性がないかもしれないことに注意してください。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
ローカル CA バンドルへのパスを手動でオーバーライドします。この CA バンドルは、 New Relicのデータ収集サービスによって提示された SSL 証明書を検証します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクショントレースからのmemcacheキーのキャプチャを有効または無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはHTTPリクエストパラメータをキャプチャし、それらをトランザクショントレース、トレースされたエラー、およびTransactionError
イベントに添付します。
注意
capture_params
設定を使用する場合、Ruby エージェントは秘密情報をフィルタリングしようとしません。Recommendation:
リクエストから機密情報をフィルターするには、代わりにattributes.include
設定を使用します。 詳細については、 Ruby 属性の例を参照してください。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはAgent.drop_buffered_data
のTracer::State
をクリアします。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
newrelic.yml
へのパス。定義されていない場合、エージェントは次のディレクトリを (順番に) チェックします。
config/newrelic.yml
newrelic.yml
$HOME/.newrelic/newrelic.yml
$HOME/newrelic.yml
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
newrelicのdistributed tracingヘッダを送信リクエストで抑制することを許可します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
シャットダウン前にキャッシュされたすべてのデータをコレクターに送信する終了ハンドラーが強制的にインストールされます。これは、通常は検出されないはずのシナリオを検出した場合にも当てはまります。このオプションの既知の使用例は、Sinatra が別のフレームワーク内の埋め込みサービスとして実行される場合です。エージェントは Sinatra アプリを検出し、結果としてat_exit
ハンドラーをスキップします。Sinatra は、通常、アプリケーション全体をat_exit
ブロック内で実行しますが、そのような状況でエージェントのat_exit
ハンドラーもインストールされていると、誤動作が発生します。注意: この設定と同時にsend_data_on_exit
もtrue
に設定する必要があります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、高セキュリティモードを有効にします。この設定を有効にする前に、高セキュリティモードの影響を理解してください。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
このエージェントから送信されるデータに適用されるラベル名と値の辞書。コロンで区切られた:
ペアのセミコロンで区切られた;
文字列として表現することもできます。たとえば、 Server:One;Data Center:Primary
。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
ログファイルの名前を定義します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
エージェント・ログ・ファイルのパスを定義します(ファイル名を除く)。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
NewRelicコレクターにデータを送信するためのマーシャラーを指定します。現在、この設定の有効な値はjson
のみです。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはアプリに関するデータをNewRelicコレクターに送信します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ActiveRecordインストルメンテーションにalias_method
ではなくModule#prepend
を使用します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
プロキシサーバーを介して New Relic コレクター と通信するためのホストを定義します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
プロキシサーバーを経由して New Relic コレクター と通信するためのパスワードを定義します。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
プロキシサーバーを経由して New Relic コレクター と通信するためのポートを定義します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
プロキシサーバーを介して New Relic コレクター と通信するためのユーザーを定義します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
言語エージェントセキュリティポリシーの設定を適用します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、シャットダウンする前にNewRelicコレクターにデータを送信するExitハンドラーを有効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
に設定すると、アプリケーションの起動時にNewRelicコレクターへの同期接続を強制します。非常に短期間のプロセスの場合、これはNewRelicエージェントがレポートする時間を確保するのに役立ちます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、トレーサーの状態ストレージはスレッドローカル、それ以外の場合はファイバーローカルです。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントがコレクターへの接続を試みる際の最大秒数を定義します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、すべての宛先のすべての HTTP リクエスト ヘッダーのキャプチャが有効になります。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントが自動的にカスタム インストゥルメンテーションを追加できるRubyメソッドを表す、 CLASS#METHOD
(インスタンス メソッドの場合) および/またはCLASS.METHOD
(クラス メソッドの場合) の文字列の配列。 これには、メソッドを定義するソースコードを変更する必要はありません。
モジュールまたはクラスの名前空間を含む完全修飾クラス名 ( ::
区切り文字を使用) を使用します。
以下は、Image
クラスの render_png
インスタンス メソッドと、User
クラスの notify
クラス メソッドを定義するRubyソースコードです。両方とも MyCompany
モジュール ネームスペース内にあります。
module MyCompany class Image def render_png # code to render a PNG end end
class User def self.notify # code to notify users end end end
そのソースコードを考慮すると、 newrelic.yml
構成ファイルは次のように両方のメソッドのインストゥルメンテーションをリクエストする可能性があります。
automatic_custom_instrumentation_method_list: - MyCompany::Image#render_png - MyCompany::User.notify
この設定例では、YAML 配列構文を使用して両方のメソッドを指定しています。 あるいは、カンマで区切られた文字列を使用することもできます。
automatic_custom_instrumentation_method_list: 'MyCompany::Image#render_png, MyCompany::User.notify'
リスト内のカンマの周囲の空白はオプションです。 NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST
環境変数を介してメソッドのリストを使用してエージェントを構成する場合は、次のコンマ区切りの文字列形式を使用します。
$export NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST='MyCompany::Image#render_png, MyCompany::User.notify'
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントが Ruby on Rails を使用するアプリケーションにある場合、エージェントは config/initializers
の実行後に開始されます。
注意
このオプションは、環境変数によってのみ設定できます。
トランザクショントレーサー
トランザクショントレース 機能は、選択したトランザクションから、呼び出しシーケンスの概要、費やした時間の内訳、SQL クエリのリストとそのクエリプラン(mysql および postgresql の場合)などの詳細な情報を収集します。利用可能な機能は、お客様の New Relic のサブスクリプションレベルによって異なります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、トランザクショントレースの収集を有効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、段階レースでの Explain プランの収集が有効になります。 slow_sql.explain_enabled
が別途設定されていない場合、この設定は低速 SQL トレースの説明プランにも適用されます。
タイプ | 浮く |
---|---|
デフォルト |
|
環境変数 |
|
エージェントが説明プランを収集するしきい値(秒単位)。 explain_enabled
がtrueの場合にのみ関連します。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
1つのトランザクション・トレースに記録するトランザクション・トレース・ノードの最大数。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはRedisコマンド引数をトランザクショントレースに記録します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
SQL の難読化レベルは、段階トレース ノードで報告されます。 デフォルトでは、これはobfuscated
に設定されており、数値リテラルと文字列リテラルが削除されます。
- エージェントにクエリ情報をキャプチャさせたくない場合は、これを
none
に設定します。 - エージェントがすべてのクエリ情報を元の形式でキャプチャするようにする場合は、これを
raw
に設定します。 - 高セキュリティモードを有効にすると、これは自動的に
obfuscated
に設定されます。
タイプ | 浮く |
---|---|
デフォルト |
|
環境変数 |
|
閾値を秒単位で指定します。エージェントは、スタックトレースの継続時間がこの閾値を超えた場合、トランザクショントレースノードにスタックトレースを含めます。
タイプ | 浮く |
---|---|
デフォルト |
|
環境変数 |
|
しきい値を秒単位で指定します。このしきい値よりも長い期間のトランザクションは、トランザクショントレースの対象となります。 float値または文字列apdex_f
を指定します。
エラーコレクター
エージェントは、デフォルトでは、すべてのアンキャッチャー例外を収集して報告します。これらの設定オプションにより、エラー収集をカスタマイズすることができます。
無視されたエラーと予想されるエラーの詳細については、APM のエラー分析に関するこのページを参照してください。NewRelic::Agent.notice_error
Ruby メソッドを介して予想されるエラーを設定するには、Ruby エージェント API を参照してください。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントは TransactionError
イベントを収集します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトレースされたエラーとエラーカウントメトリックをキャプチャします。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントが期待通りに扱うべきエラークラスのリストです。
注意
このオプションは、環境変数で設定することはできません。
タイプ | ハッシュ |
---|---|
デフォルト |
|
環境変数 |
|
メッセージのリストへのエラー・クラスのマップです。ここで指定されたクラスのエラーが発生したとき、そのエラーメッセージにここで指定された文字列のいずれかが含まれていれば、そのエラーは期待どおりに処理されます。
注意
このオプションは、環境変数で設定することはできません。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
コンマで区切られたステータスコードのリスト(場合によっては範囲を含む)。これらのステータスコードに関連したエラー(該当する場合)は、期待通りに処理されます。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントが無視すべきエラークラスのリストです。
注意
このオプションは、環境変数で設定することはできません。
タイプ | ハッシュ |
---|---|
デフォルト |
|
環境変数 |
|
メッセージのリストへのエラー・クラスのマップです。ここで指定されたクラスのエラーが発生したとき、そのエラーメッセージにここで指定された文字列のいずれかが含まれていれば、そのエラーは無視されます。
注意
このオプションは、環境変数で設定することはできません。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
コンマで区切られたステータスコードのリスト(場合によっては範囲を含む)。これらのステータスコードに関連するエラーは、該当する場合は無視されます。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
エラー バックトレース内のフレームの最大数を定義します。 この量を超えるバックトレースは途中で切り捨てられ、スタックトレースの先頭と末尾は保持されます。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
収集サイクルごとに報告される TransactionError
イベント の最大数を定義します。
ブラウザの監視
ページ読み込みタイミング機能 (リアルユーザー監視またはRUMとも呼ばれます) は、実際のユーザーが Web サイトで体験しているパフォーマンスをインサイトに提供します。 これは、各ページのヘッダーとフッターに少量の JavaScript コードを挿入することにより、ユーザーのブラウザーが Web ページをダウンロードしてレンダリングするのにかかる時間を測定することで実現されます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ページの読み込みタイミングのためにJavaScriptヘッダーの自動挿入を有効にします(実際のユーザー監視またはRUMと呼ばれることもあります)。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ブラウザ監視ブラウザでContent Security Policy Nonceの自動インジェクションを有効にします。 現時点では、自動インジェクションは Rails 5.2 以降でのみ機能します。
トランザクション・イベント
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、トランザクションイベントのサンプリングを有効にします。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
1つのハーベストから報告されるトランザクションイベントの最大数を定義する。
アプリケーションログ
Ruby エージェントは、コンテキスト内の APM ログをサポートします。Ruby エージェントのログを構成するためのヒントについては、コンテキストで Ruby ログを構成するを参照してください。
使用可能なロギング関連の構成オプションには、次のものがあります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ログの装飾とログイベントおよびメトリックの収集を有効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはアプリケーションによって発行されたログレコードをキャプチャします。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
ログイベントを New Relic に転送する必要がある最小レベルを設定します。
これは、Ruby のLogger::Severity
定数の整数値に基づいています。
その目的は、構成に指定されたレベルのログと、より高い重大度レベルのログを転送することです。
たとえば、この値を「debug」に設定すると、すべてのログイベントが New Relic に転送されます。この値を「error」に設定すると、「error」、「fatal」、および「unknown」レベルのログ イベントのみが転送されます。
有効な値 (最小値から最大値の順):
- "デバッグ"
- "info"
- 「警告する」
- "エラー"
- "致命的"
- "知らない"
タイプ | ハッシュ |
---|---|
デフォルト |
|
環境変数 |
|
New Relic に転送されるすべてのログ イベントにカスタム属性として追加するキーと値のペアを含むハッシュ。環境変数を使用して送信する場合、値は「key1=value1,key2=value2」のような形式にする必要があります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
場合、エージェントはログ レコードにラベルを添付します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
ログ レコードから除外するラベルを含む、大文字と小文字を区別しない配列またはコンマ区切りの文字列。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
一度にメモリにバッファリングするログレコードの最大数を定義します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはログをメタデータで装飾して、エンティティ、ホスト、トレース、およびスパンにリンクします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはアプリケーションのロギングに関連するメトリックをキャプチャします。
AIモニタリング
このセクションには、AIモニタリングを設定するためのRubyエージェント設定が含まれています。
重要
トレースとフィードバックデータを取得するには、ディストリビューティッド(分散)トレーシングを有効にする必要があります。 Ruby エージェント 8.0.0 以降ではデフォルトでオンになっています。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
false
の場合、すべての LLM インストゥルメンテーション (現時点では OpenAI のみ) が無効になり、メトリック、イベント、スパンは送信されません。 high_security
モードが有効な場合、AI モニタリングは自動的に無効になります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
false
の場合、LLM インストゥルメンテーション (現時点では OpenAI のみ) は、特定の LLM イベントの入出力コンテンツをキャプチャしません。
除外される属性には次のものが含まれます。
content
LlmChatCompletionMessage イベントからinput
LlmEmbedding イベントからこれは、LLM との間で送受信される機密データの記録を防ぐためのオプションのセキュリティ設定です。
属性
アトリビュート は、イベントやトランザクションのプロパティを決定する情報を含むキーとバリューのペアです。これらのキー・バリュー・ペアは、APMのトランザクション・トレース、APMのトレースされたエラー、ダッシュボードのトランザクション・イベント、ダッシュボードのページ・ビューで見ることができます。どの属性がこれらの各送信先に送信されるかを正確にカスタマイズできます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、すべての宛先の属性のキャプチャを有効にします。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
すべての宛先から除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
すべての宛先に含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはブラウザの監視から属性を取得します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
ブラウザの監視から除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
ブラウザの監視に含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはエラー収集から属性をキャプチャします。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
エラー収集から除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
エラー収集に含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはスパンイベントの属性をキャプチャします。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
スパンイベントから除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
スパンイベントに含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトランザクションイベントから属性をキャプチャします。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクションイベントから除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクションイベントに含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトランザクションセグメントの属性をキャプチャします。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクションセグメントから除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクションセグメントに含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトランザクショントレースから属性をキャプチャします。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクショントレースから除外する属性のプレフィックス。最後にワイルドカードとして*
を許可します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
トランザクショントレースに含める属性のプレフィックス。最後にワイルドカードとして*
を許可します。
監査ログ
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、NewRelicコレクターとの通信をログに記録する監査ログを有効にします。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
監査ログに含めることが許可されているエンドポイントのリスト。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
監査ログファイルのパス(ファイル名を含む)を指定します。
オートスタート
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントが自動的に起動しないようにする定数のリストを指定します。個々の定数はコンマ,
で区切ります。たとえば、 "Rails::Console,UninstrumentedBackgroundJob"
。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントがインストルメントしてはならない実行可能ファイルのコンマ区切りリストを定義します。たとえば、 "rake,my_ruby_script.rb"
です。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
エージェントがインストルメントしてはならないRakeタスクのコンマ区切りリストを定義します。たとえば、 "assets:precompile,db:migrate"
です。
クラウド
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
このアプリに関連付けられた AWS アカウントの AWS アカウント ID
コード レベルの指標
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトレース メソッドのソースコード レベルのメトリクスを報告します。 参照: https://docs.newrelic.com/docs/apm/agents/ruby-agent/features/ruby-codestream-integration/
クロスアプリケーショントレーサー
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
DEPRECATED 「distributed_tracing.enabled」を参照してください。
true
の場合、 distributed_tracing.enabled
がfalse
に設定されているときにクロスアプリケーショントレースを有効にします。
カスタム属性
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
false
の場合、カスタム属性はイベントで送信されません。
カスタムイベント
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはカスタムイベントをキャプチャします。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
- 一度にメモリにバッファリングするカスタムイベントの最大数を指定します。
- AI モニタリングのエージェントを構成する場合は、最大値
100000
に設定します。 これにより、エージェントは最大量の LLM イベントをキャプチャできるようになります。
データストアトレーサー
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
false
の場合、エージェントはdatabase_name
パラメータをトランザクションに追加しないか、SQLトレースを遅くします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
false
の場合、エージェントはデータストアインスタンスメトリックを報告せず、トランザクションにhost
またはport_path_or_id
パラメータを追加したりSQLトレースを遅くしたりしません。
無効化
これらの設定を使用して、エージェントの起動時に計測の種類を切り替えます。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、アクションケーブルの計装を無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、アクション コントローラーの計測を無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、アクション メールボックスの計測を無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、Action Mailer インストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、アクティブなジョブの計測を無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、アクティブ ストレージの計測を無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、Active Support インスツルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、Active Record インストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、Active Record 4+ のインストルメンテーションを無効にします
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはホストプロセスのCPU使用率をサンプリングしません。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントは遅延ジョブキューの深さを測定しません。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ガベージ コレクションに費やされた時間を測定するためのGC::Profiler
の使用を無効にします
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはホストプロセスのメモリ使用量をサンプリングしません。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはサードパーティのミドルウェアをインストルメンテーションにラップしません ( Rack::Builder
または Rails を介してインストールされているかどうかに関係なく)。
重要
ミドルウェア インストルメンテーションが無効になっている場合、アプリケーションが応答コードを変更する可能性のあるミドルウェアを使用している場合、トランザクションで報告される HTTP ステータス コードに変更された値が反映されない可能性があります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、サンプラーメトリックの収集を無効にします。サンプラーメトリックは、イベントベースではないメトリックです(CPU時間やメモリ使用量など)。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、 Sequelインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、 Sidekiqインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、Roda のエージェント ミドルウェアを無効にします。このミドルウェアは、 ページの読み込みタイミング や エラー収集などの高度な機能のサポートを担当します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、Sinatraのエージェントミドルウェアを無効にします。このミドルウェアは、クロスアプリケーショントレース、ページの読み込みタイミング、エラー収集などの高度な機能のサポートを担当します。
重要
クロス アプリケーション トレースは廃止され、分散トレースが優先されます。Ruby エージェント バージョン 8.0.0 以降では、デフォルトで分散トレースがオンになっています。ミドルウェアは、分散トレースをサポートする必要はありません。
クロスアプリケーショントレースを引き続き使用するには、 newrelic.yml
構成ファイルの次のオプションを更新します。
cross_application_tracer: enabled: true distributed_tracing: enabled: false
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ビューインストルメンテーションを無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはRubyVMからパフォーマンス測定値をサンプリングしません。
分散型トレーシング
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
分散トレーシングでは、リクエストが分散システムを通過する経路を確認することができます。分散トレーシングを有効にすると、New Relic の一部の機能の動作が変わるため、この機能を有効にする前に 移行ガイド をよく確認してください。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
この設定は、リモート 親がサンプリングされ、トレース フラグが traceparent に設定されているときのトランザクション サンプリングの動作を制御します。使用可能な値はdefault
、 always_on
、 always_off
です。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
この設定は、リモート 親がサンプリングされず、トレース フラグが traceparent に設定されていない場合のトランザクション サンプリングの動作を制御します。使用可能な値はdefault
、 always_on
、 always_off
です。
Elasticsearch
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントは、段階トレース内のElasticsearchクラスタ名をキャプチャします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトランザクション追跡で Elasticsearch クエリをキャプチャします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトランザクション追跡で Elasticsearch クエリを難読化します。
Heroku
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはホスト名としてHerokudyno名を使用します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
通常、エージェントは、末尾にドットとプロセス ID を付けて dyno 名を報告します (例: worker.3
)。末尾のデータなしで報告するプレフィックスを指定することで、この末尾のデータを削除できます (たとえば、 worker
)。
無限のトレース
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
トレース オブザーバ ホストのホスト名を設定します。設定すると、通常のエージェント サンプリング決定に関係なく、さらにサンプリングを決定するために、記録されたすべてのスパンをトレース オブザーバに送信することで、テールベースのサンプリングが有効になります。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
トレース オブザーバー ホストの TCP/IP ポートを構成します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
(デフォルト) の場合、トレース オブザーバーに送信されるデータは、各スパンを個別に送信する代わりにバッチ処理されます。
タイプ | シンボル |
---|---|
デフォルト |
|
環境変数 |
|
トレース オブザーバーに送信されるデータの圧縮レベルを構成します。次のいずれかになります: :none
、 :low
、 :medium
、 :high
。圧縮を無効にするにはレベルを:none
に設定します。
計装
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のActiveSupport::BroadcastLogger
の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。Rails バージョン 7.1 以上で使用されます。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のActiveSupport::Logger
の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。Rails 7.1 より前のバージョンで使用されます。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Async::HTTP の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のバニーの自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の AWS-sdk-firehose ライブラリの自動インストゥルメンテーションを制御します。 auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の aws_sdk_lambda ライブラリの自動インストゥルメンテーションを制御します。 auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の AWS-sdk-kinesis ライブラリの自動インストゥルメンテーションを制御します。 auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のruby-kafkaライブラリの自動インストゥルメンテーションを制御します。 auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の opensearch-ruby ライブラリの自動インストゥルメンテーションを制御します。 auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の rdkafka ライブラリの自動インストゥルメンテーションを制御します。 auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の AWS-sdk-sqs ライブラリの自動インストゥルメンテーションを制御します。 次のいずれかになります: auto
、 prepend
、 chain
、 disabled
。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の AWS-sdk-dynamodb ライブラリの自動インストゥルメンテーションを制御します。 auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のファイバー クラスの自動インスツルメンテーションを制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の並行 Ruby ライブラリの自動インスツルメンテーションを制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Curb の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の遅延ジョブの自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の elasticsearch ライブラリの自動インストルメンテーションを制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のethonの自動インストゥルメンテーションを制御します。 auto
、 prepend
、 chain
のいずれかになります。 disabled
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Excon の自動計測を制御します。enabled
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Grape の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の gRPC クライアントの自動インストルメンテーションを制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
New Relic がトラフィックを無視する gRPC ホスト名に一致する、コンマで区切られたホスト名パターンのリストを指定します。New Relic の gRPC クライアント インストルメンテーションは、これらのパターンのいずれかに一致するホストにストリーミングされたトラフィックを無視し、New Relic の gRPC サーバー インストルメンテーションは、ホスト名がこれらのパターンのいずれかに一致するホスト上で実行されているサーバーのトラフィックを無視します。デフォルトでは、gRPC インストルメンテーション自体が有効になっている場合、トラフィックは無視されません。例えば、 "private.com$,exception.*"
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の gRPC サーバーの自動インストルメンテーションを制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の HTTPClient の自動インストルメンテーションを制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の http.rb gem の自動インストルメンテーションを制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のhttpxの自動インストゥルメンテーションを制御します。 auto
、 prepend
、 chain
のいずれかになります。 disabled
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
Ruby標準ライブラリLoggerの起動時の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の LogStasher ライブラリの自動インストゥルメンテーションを制御します。 次のいずれかになります: auto
、 prepend
、 chain
、 disabled
。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時に Memcache の dalli gem の自動インスツルメンテーションを制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時に Memcache の memcached gem の自動インストルメンテーションを制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時に Memcache の memcache-client gem の自動インストルメンテーションを制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Mongo の自動計測を制御します。enabled
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のNet::HTTP
の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の ruby-openai gem の自動インストゥルメンテーションを制御します。 次のいずれかになります: auto
、 prepend
、 chain
、 disabled
。高セキュリティ モードではデフォルトでdisabled
になります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
Puma::Rack
の自動計測を制御します。有効にすると、エージェントはPuma::Rack::Builder
のto_app
メソッドにフックして、アプリケーションの起動時に計測する gem を見つけます。auto
、 prepend
、 chain
、 disabled
のいずれかです。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のPuma::Rack::URLMap
の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
Rack の自動計測を制御します。有効にすると、エージェントはRack::Builder
のto_app
メソッドにフックして、アプリケーションの起動時に計測する gem を見つけます。auto
、 prepend
、 chain
、 disabled
のいずれかです。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時のRack::URLMap
の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の rake の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Redis の自動インストルメンテーションを制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の resque の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Roda の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Sinatra の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Stripe の自動計測を制御します。enabled
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時に ViewComponent の自動実行を制御します。 auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時に Thread クラスの自動計測を制御して、エージェントが非同期トランザクション内でスパンを正しくネストできるようにします。これにより、エージェントは作成されたすべてのスレッドを自動的にトレースできなくなります ( instrumentation.thread.tracing
を参照)。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
起動時に Thread クラスの自動インスツルメンテーションを制御し、アプリケーションで作成されたすべてのスレッドにトレースを自動的に追加します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Tilt テンプレート レンダリング ライブラリの自動インストルメンテーションを制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
起動時の Typhoeus の自動計測を制御します。auto
、 prepend
、 chain
、 disabled
のいずれかになります。
メッセージトレーサー
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはメッセージに関するメタデータを収集し、それらをセグメントパラメータとして添付します。
Mongo
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトランザクショントレースでMongoクエリをキャプチャします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはトランザクショントレースでMongoクエリを難読化します。
オープンサーチ
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントは、発言トレースで OpenSearch 書き込みをキャプチャします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントは現場トレースで OpenSearch 書き込みを難読化します。
プロセスホスト
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
New Relic UI で 表示するカスタムホスト名を指定する 。
Rake
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
自動的にインストルメントする Rake タスクの配列を指定します。この構成オプションは、配列を正規表現リストに変換します。デフォルトですべてのタスクを許可する場合は、 rake.tasks: [.+]
を使用します。このリストに追加されない限り、rake タスクはインストルメントされません。詳細については、 New Relic Rake Instrumentation のドキュメントを参照してください。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
rakeタスクの前にconnectが完了するのを待つためのタイムアウト
ルール
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
無視する URI に一致するパターンのリストを指定して、エージェントが無視するトランザクションを定義します。詳細については、特定のトランザクションの無視に関するドキュメントを参照してください。
セキュリティ
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、セキュリティエージェントがロードされます(Ruby の 'require' が実行されます)
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、セキュリティ エージェントが起動します (エージェントはイベント ループで実行されます)
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
セキュリティ エージェントが動作するモードを定義します。現在、 IAST
のみがサポートされています
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
セキュリティ関連データを投稿するためのエンドポイント URL を定義します
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
アプリケーションがリッスンしているポート。この設定は Passenger サーバーでは必須です。エージェントはデフォルトで他のサーバーを検出します。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
セキュリティ エージェントが IAST スキャンで無視する API パスを定義します。無視する URI に一致する正規表現パターンの配列を受け入れます。正規表現パターンは、エンドポイントのない URL に完全に一致するものを見つける必要があります。例えば、 [".*account.*"], [".*/\api\/v1\/.*?\/login"]
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
セキュリティ エージェントが IAST スキャンで無視する HTTP 要求ヘッダーの配列。配列には、無視するヘッダーに一致するパターンのリストを指定する必要があります。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
HTTP リクエストの配列は、セキュリティ担当者がIASTスキャンで無視する必要があります。 配列には、HTTP リクエストに一致する無視するパターンのリストを指定する必要があります。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
セキュリティ エージェントが IAST スキャンで無視する HTTP リクエスト本文キーの配列。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、重大度が低い安全でない設定の検出を無効にします。たとえば、ハッシュ、暗号、Cookie、乱数ジェネレーター、信頼境界などです。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、ファイル操作関連の IAST 検出 (ファイル アクセスとアプリケーションの整合性違反) を無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、IAST スキャンでの SQL インジェクション検出が無効になります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
場合、IAST スキャンでの NOSQL インジェクション検出が無効になります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、IAST スキャンでの LDAP インジェクション検出が無効になります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、IAST スキャンでの Javascript インジェクション検出が無効になります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、IAST スキャンでのシステム コマンド インジェクション検出が無効になります。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
場合、IAST スキャンでの XPATH インジェクション検出を無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、IAST スキャンでのサーバー側リクエスト偽造 (SSRF) 検出を無効にします。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、 IASTでの Reflected Cross-Site Script (RXSS) 検出を無効にします。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
アプリケーションの起動後に IAST スキャンが開始されるまでの遅延時間 (分単位) を指定します。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
IAST スキャンが実行される期間 (分単位) を示します。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
IAST スキャンをいつ実行するかを設定する cron 式を指定します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
場合、IAST はバックグラウンドでトレース データを継続的に収集できます。セキュリティ エージェントは収集されたデータを使用して、スケジュールされた時間に IAST スキャンを実行します。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
スキャンに 1 分あたりに許可される HTTP の最大数を設定します。requestsIAST12 から 3600 までの任意の整数が有効です。デフォルト値は 3600 です。
タイプ | 整数 |
---|---|
デフォルト |
|
環境変数 |
|
IAST 分析を実行する特定のエンティティのアプリケーション インスタンスの数。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
場合、HTTP 応答本文の送信が有効になります。これを無効にすると、Reflected Cross-Site スクリプト (RXSS) の脆弱性検出も無効になります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
CI/CD 環境で IAST を実行するときに、異なるテスト実行を区別するための一意のテスト識別子。たとえば、ビルド番号などです。
サーバーレスモード
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントは有効期間の短いサーバーレス機能での使用に適した合理化モードで動作します。 注意: 現在、 AWS Lambda 関数のみがサポートされており、このオプションはNew RelicのRuby Lambdaレイヤーオファリングなしで使用するためのものではありません。
Sidekiq
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
どの Sidekiq ジョブ引数が New Relic に報告されるかをフィルタリングするためのホワイトリストとして集合的に機能する文字列の配列。Sidekiq 引数をキャプチャするには、「job.sidekiq.args.*」別の :'attributes.include'
構成オプションに追加する必要があります。この配列内の各文字列は、高度なマッチングを可能にするために、 Regexp.new
によって正規表現に変換されます。ジョブ引数ハッシュの場合、キーまたは値のいずれかが一致する場合、そのペアが含まれます。一致するすべてのジョブ引数配列要素とジョブ引数スカラーが含まれます。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
どの Sidekiq ジョブ引数が New Relic に報告されるかをフィルタリングするための拒否リストとして集合的に機能する文字列の配列。Sidekiq 引数をキャプチャするには、「job.sidekiq.args.*」別の :'attributes.include'
構成オプションに追加する必要があります。この配列内の各文字列は、高度なマッチングを可能にするために、 Regexp.new
によって正規表現に変換されます。ジョブ引数ハッシュの場合、キーまたは値のいずれかが一致する場合、そのペアは除外されます。一致するジョブ引数の配列要素とジョブ引数のスカラーはすべて除外されます。
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
から10000
までの任意の整数が有効です。 - AI モニタリングのエージェントを構成する場合、最大値
10000
に設定します。これにより、エージェントが最大量のディストリビューティッド(分散)トレーシングを確実に捕捉します。
例外メッセージの除去
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true の場合、エージェントは許可されたクラス リスト内の例外を除くすべての例外からのメッセージを削除します。高セキュリティモードでは自動的に有効になります。
タイプ | 弦 |
---|---|
デフォルト |
|
環境変数 |
|
strip_exception_messagesがtrue
の場合に、エージェントが削除しない例外のリストを指定します。例外はコンマで区切ります。たとえば、 "ImportantException,PreserveMessageException"
。
ストライプ
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
Stripe イベントのuser_data
ハッシュ内のどのキーを New Relic に報告するかを指定する文字列の配列。この配列内の各文字列は、高度な一致を可能にするためにRegexp.new
を介して正規表現に変換されます。値を["."]
に設定すると、すべてのuser_data
が報告されます。
タイプ | 配列 |
---|---|
デフォルト |
|
環境変数 |
|
Stripe イベントのuser_data
ハッシュ内のどのキーや値を New Relic に報告しないかを指定する文字列の配列。この配列内の各文字列は、高度な一致を可能にするためにRegexp.new
を介して正規表現に変換されます。各ハッシュ ペアについて、キーまたは値のいずれかが一致する場合、そのペアは報告されません。デフォルトでは、 user_data
は報告されません。このオプションは、 stripe.user_data.include
オプションも使用されている場合にのみ使用してください。
スレッドプロファイラー
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、スレッドプロファイラーの使用を有効にします。
活用
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはAWS環境で実行されていることを自動的に検出します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはAzure環境で実行されていることを自動的に検出します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはDockerで実行されていることを自動的に検出します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはGoogleCloudPlatform環境で実行されていることを自動的に検出します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはKubernetesで実行されていることを自動的に検出します。
タイプ | ブール値 |
---|---|
デフォルト |
|
環境変数 |
|
true
の場合、エージェントはPivotalCloudFoundry環境で実行されていることを自動的に検出します。