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設定ファイルの読み取るセクションを決定します。これは、本番環境ではinfoをlog_level設定に使用し、開発環境ではより詳細な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: debugRubyエージェントは、次の環境変数をこの順序で検索して、アプリケーション環境を見つけます。
NEW_RELIC_ENVRUBY_ENVRAILS_ENVAPP_ENVRACK_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は自動的に更新されません。
General
これらの設定はエージェントの設定に使用できます。一部の設定は、New Relicのサブスクリプションレベルによって異なります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Rubyエージェントの実行を許可します。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
New Relic UIでデータを集計するために使用するアプリケーション名を指定します。複数のアプリに同時にデータを報告するには、名前をセミコロン;で区切って列挙します。例:MyApp、MyStagingApp;Instance1。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
New Relic 。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
ログメッセージの詳細レベルを設定します。設定可能なログレベルは、詳細レベルが低い方から、error、warn、info、debugです。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
サブスクライブ・計装するActiveSupportカスタムイベント名の配列。例:
- one.custom.event
- another.event
- a.third.event
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
If true, the agent will use the Active Record model's table name instead of the class name when naming Active Record metrics, spans, and transaction trace segments. This can reduce cardinality when multiple models share a database table. Defaults to false.
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
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.ymlnewrelic.yml$HOME/.newrelic/newrelic.yml$HOME/newrelic.yml
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
アウトバウンドリクエストでNew Relicのディストリビューティッド(分散)トレーシングヘッダーの付与を抑制できるようにします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
シャットダウン前にキャッシュ済みのすべてのデータをコレクターに送信する終了ハンドラーが強制的にインストールされます。これは、通常であればインストールすべきではない状況を検出した場合でも同様です。このオプションは、Sinatraが別のフレームワーク内で組み込みサービスとして実行される場合などに使用します。このオプションを使うと、エージェントはSinatraアプリを検出し、at_exitハンドラーをスキップします。Sinatraは通常、アプリケーション全体をat_exitブロック内で実行するため、その状況でエージェントのat_exitハンドラーもインストールされていると、正常に動作しなくなります。注:この設定と同時に、send_data_on_exitもtrueに設定する必要があります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、高セキュリティモードが有効になります。この設定を有効にする前に、高セキュリティモードを有効にした場合の影響を十分に確認してください。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
このエージェントから送信されるデータに適用されるラベル名と値のディクショナリ。文字列をコロン:で区切ったペアで表現し、セミコロン;で区切って複数登録することができます。例:Server:One;Data Center:Primary。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
ログファイルの名前を定義します。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
エージェントログファイルへのパスを定義します(ファイル名は含みません)。エージェントのログを標準出力に送信したい場合は、これをSTDOUTに設定してください。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
New Relicコレクターにデータを送信するためのマーシャラーを指定します。現在、この設定で有効な値はjsonのみです。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはアプリに関するデータをNew Relicコレクターに送信します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、ActiveRecord計装にalias_methodではなくModule#prependを使用します。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
プロキシサーバーを介してNew Relicコレクターと通信するためのホストを定義します。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
プロキシサーバー経由でNew Relicコレクターと通信するためのパスワードを定義します。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
プロキシサーバー経由でNew Relicコレクターと通信するためのポートを定義します。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
プロキシサーバーを介してNew Relicコレクターと通信するためのユーザーを定義します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、シャットダウン前にデータをNew Relicコレクターに送信する終了ハンドラーが有効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueに設定すると、アプリケーション起動時にNew Relicコレクターへの同期接続が強制されます。存続期間が非常に短いプロセスの場合、これはNew Relicエージェントが報告する時間を確実に確保するのに役立ちます。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
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の場合、Action Cableブロードキャスト呼び出しのメトリクスには、指定されたブロードキャストのbroadcastingの値は含まれません。デフォルトはfalseです。デフォルトは、今後のメジャーバージョンリリースで変更される可能性があります。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
エージェントが無視すべきミドルウェアクラスまたはモジュール名のリスト。例:["Rack::Cors", "ActionDispatch::Reloader"]
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueにすると、エージェントがRuby on Railsを使用するアプリケーションにある場合、config/initializersの実行後に起動します。
注意
このオプションは環境変数でのみ設定できます。
トランザクショントレーサー
トランザクショントレース機能は、呼び出しシーケンスの概要、所要時間の内訳、SQLクエリとそのクエリプランのリスト(MySQLおよびpostgresqlで利用可能)など、一部のトランザクションから詳細な情報を収集します。利用可能な機能は、New Relicのサブスクリプションレベルによって異なります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、トランザクショントレースの収集が有効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、トランザクショントレースでの実行計画の収集が有効になります。slow_sql.explain_enabledが別途設定されていない場合、この設定はスローSQLの実行計画にも適用されます。
タイプ | フロート |
|---|---|
デフォルト |
|
環境変数 |
|
この閾値(秒)を超えるとエージェントは実行計画を収集します。explain_enabledがtrueの場合にのみ関係します。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
単一のトランザクショントレースに記録するトランザクショントレースノードの最大数。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはトランザクショントレースにRedisコマンド引数を記録します。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
SQLクエリの難読化レベルは、トランザクショントレースノードで報告されます。デフォルトでは、これはobfuscatedに設定されており、数値リテラルと文字列リテラルが削除されます。
- エージェントにクエリ情報を取得させたくない場合は、これを
noneに設定してください。 - エージェントにすべてのクエリ情報を元の形式で取得させたい場合は、これを
rawに設定してください。 - 高セキュリティモードを有効にすると、これは自動的に
obfuscatedに設定されます。
タイプ | フロート |
|---|---|
デフォルト |
|
環境変数 |
|
閾値を秒単位で指定します。スタックトレースの継続時間がこの閾値を超えた場合、エージェントはスタックトレースノードにスタックトレースを含めます。
タイプ | フロート |
|---|---|
デフォルト |
|
環境変数 |
|
閾値を秒単位で指定します。この閾値を超えて継続時間が続く場合は、トランザクショントレースの対象となります。フロート値または文字列apdex_fを指定します。
エラーコレクター
デフォルトでは、エージェントは捕捉されなかったすべての例外を収集・報告します。これらの設定オプションを使用することで、エラー収集をカスタマイズできます。
無視対象のエラーと想定されるエラーの詳細については、APMのエラー分析に関するページを参照してください。NewRelic::Agent.notice_error Rubyメソッドを使用して想定されるエラーを設定するには、RubyエージェントAPI参照してください。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはTransactionErrorイベントを収集します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはトレースされたエラーとエラー数のメトリクスをキャプチャします。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
エージェントが想定されたエラーとして処理すべきエラークラスのリスト。
注意
このオプションは環境変数では設定できません。
タイプ | ハッシュ |
|---|---|
デフォルト |
|
環境変数 |
|
エラークラスとメッセージリストの対応関係を示すマップ。ここで指定したクラスのエラーが発生した際、そのエラーメッセージにここで設定した文字列のいずれかが含まれている場合、想定されたエラーとして処理されます。
注意
このオプションは環境変数では設定できません。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
ステータスコードをカンマで区切ったリスト。範囲を含めることも可能です。設定した場合、そのステータスコードに関連するエラーは想定されたエラーとして処理されます。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
エージェントが無視すべきエラークラスのリスト。
注意
このオプションは環境変数では設定できません。
タイプ | ハッシュ |
|---|---|
デフォルト |
|
環境変数 |
|
エラークラスとメッセージリストの対応関係を示すマップ。ここで指定したクラスのエラーが発生した際、そのエラーメッセージにここで設定した文字列のいずれかが含まれている場合、無視対象のエラーとして処理されます。
注意
このオプションは環境変数では設定できません。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
ステータスコードをカンマで区切ったリスト。範囲を含めることも可能です。設定した場合、そのステータスコードに関連するエラーは無視対象として処理されます。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
エラーバックトレースにおけるフレームの最大数を定義します。設定値を超えるバックトレースは途中で切り捨てられ、スタックトレースの開始と終了は保持されます。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
フレーム数がerror_collector.max_backtrace_framesを超えた場合に、バックトレースのどの部分を切り捨てるかを指定します。設定可能なオプションは、top(先頭からフレームを削除)、middle(先頭と末尾は残し、中間からフレームを削除)、end(末尾からフレームを削除)です。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
収集サイクルごとに報告されるTransactionErrorイベントの最大数を定義します。
ブラウザのモニタリング
ページ読み込みタイミング機能(リアルユーザー監視またはRUMとも呼ばれます)を使用すると、実際のユーザーがWebサイトで体験しているパフォーマンスについて洞察を得られます。これは、各ページのヘッダーとフッターに少量のJavaScriptコードを挿入することで、ブラウザがウェブページをダウンロードしてレンダリングするのにかかる時間を測定することによって実現されます。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、ページ読み込みタイミング(リアルユーザー監視またはRUMとも呼ばれます)のJavaScriptヘッダーの自動インジェクションが有効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、ブラウザ監視ブラウザでContent Security Policy Nonceの自動インジェクションを有効にします。現時点では、自動インジェクションはRails 5.2以降でのみ動作します。
Transactionイベント
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、トランザクションイベントのサンプリングが有効になります。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
単一の収集先から報告されるトランザクションイベントの最大数を定義します。
アプリケーションロギング
RubyエージェントはAPM logs in contextに対応しています。Rubyエージェント向けのログの設定に関するヒントについては、「Ruby logs in contextの設定」を参照してください。
ログ関連の設定オプションは以下のとおりです。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、ログの装飾と、ログイベントとメトリクスの収集が有効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはアプリケーションから出力されるログレコードを取得します。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
New Relicに転送されるログイベントの最小レベルを設定します。
これは、RubyのLogger::Severity定数の整数値に基づいています。
この設定で指定したレベルのログと、それよりも深刻度の高いログが転送されます。
例えば、この値を「debug」に設定すると、すべてのログイベントがNew Relicに転送されます。「error」に設定すると、「error」、「fatal」、「unknown」レベルのログイベントのみが転送されます。
有効な値(深刻度の低い順):
- "debug"
- "info"
- "warn"
- "error"
- "fatal"
- "unknown"
タイプ | ハッシュ |
|---|---|
デフォルト |
|
環境変数 |
|
New Relicに転送されたすべてのログイベントにカスタムアトリビュートとして追加するキーと値のペアを持つハッシュ。環境変数を使用して送信する場合、値は「key1=value1,key2=value2」のように記述する必要があります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはログレコードにラベルを付加します。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
ログレコードから除外するラベルを含む、大文字小文字を区別しない配列またはカンマ区切りの文字列。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
一度にメモリにバッファリングするログレコードの最大数を定義します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはエンティティ、ホスト、トレース、スパンと関連付けるためのメタデータをログに追加します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはアプリケーションのロギングに関連するメトリクスを取得します。
AI Monitoring
このセクションには、AI監視を設定するためのRubyエージェント設定を記載します。
重要
トレースとフィードバックデータを取得するには、ディストリビューティッド(分散)トレーシングを有効にする必要があります。Ruby 8.0.0以降ではデフォルトで有効になっています。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
falseの場合、すべてのLLM計装(現時点ではOpenAIのみ)が無効になり、メトリクス、イベント、スパンは送信されません。AI監視は、high_securityモードが有効になっている場合、自動的に無効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
falseの場合、LLM計装(現時点ではOpenAIのみ)は、特定のLLMイベントの入出力コンテンツを取得しません。
除外される属性は以下のとおりです。
contentLlmChatCompletionMessageイベントからinputLlmEmbeddingイベントからこれは、LLMとの間で送受信される機密データの記録を防止するためのオプションのセキュリティ設定です。
属性
属性は、イベントまたはトランザクションのプロパティを決定する情報を含むキーと値のペアです。これらのキーの値のペアは、APMのトランザクショントレース、APMのトレース対象のエラー、ダッシュボードの重大イベント、ダッシュボードのページビュー内で確認できます。これらの各宛先に送信する属性を正確にカスタマイズできます。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、すべての宛先に対して属性の取得を有効にします。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
すべての宛先から除外する属性のプレフィックス。末尾に*をワイルドカードとして使用可能。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
すべての宛先に含める属性の接頭辞。末尾にワイルドカードとして*を使用できます。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはブラウザ監視から属性を取得します。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
ブラウザモニタリングから除外する属性の接頭辞。末尾に*をワイルドカードとして使用可能。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
ブラウザモニタリングに含める属性の接頭辞。末尾に*をワイルドカードとして使用可能。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはエラーコレクションから属性を取得します。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
エラーコレクションから除外する属性のプレフィックス。末尾に*をワイルドカードとして使用可能。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
エラーコレクションに追加する属性のプレフィックス。末尾に*をワイルドカードとして使用可能。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはスパンイベントで属性を取得します。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
スパンイベントから除外する属性の接頭辞。末尾にワイルドカードとして*を使用できます。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
スパンイベントに含める属性の接頭辞。末尾にワイルドカードとして*を使用できます。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueに設定されていると、エージェントはトランザクションイベントの属性をキャプチャーします。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
トランザクションイベントから除外する属性の接頭辞。末尾に*をワイルドカードとして使用可能。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
トランザクションイベントに含める属性の接頭辞。末尾に*をワイルドカードとして使用可能。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはトランザクションセグメントの属性を取得します。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
トランザクションセグメントから除外する属性の接頭辞。末尾にワイルドカードとして*を使用できます。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
トランザクションセグメントに含める属性の接頭辞。末尾にワイルドカードとして*を使用できます。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueに設定されていると、エージェントはトランザクショントレースの属性をキャプチャーします。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
トランザクショントレースから除外する属性の接頭辞。末尾に*をワイルドカードとして使用可能。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
トランザクショントレースに含める属性の接頭辞。末尾に*をワイルドカードとして使用可能。
監査ログ
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、New Relicコレクターとの通信を記録する監査ログが有効になります。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
監査ログに含めることが許可されているエンドポイントのリスト。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
監査ログファイルへのパス(ファイル名を含む)を指定します。
自動起動
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
エージェントの自動起動を防止する定数のリストを指定します。各定数をカンマ,で区切ってください。例:"Rails::Console,UninstrumentedBackgroundJob"。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
エージェントが計装すべきでない実行可能ファイルをカンマ区切りで列挙します。例:"rake,my_ruby_script.rb"。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
エージェントが計装すべきでないRakeタスクをカンマ区切りで列挙します。例:"assets:precompile,db:migrate"。
Cloud
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
このアプリに関連付けられているAWSアカウントのAWSアカウントID
コードレベルのメトリクス
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはトレースされたメソッドについてソースコードレベルのメトリクスを報告します。詳細は、https://docs.newrelic.com/docs/apm/agents/ruby-agent/features/ruby-codestream-integration/を参照してください。
カスタムアトリビュート
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
falseの場合、カスタムアトリビュートはイベントに送信されません。
カスタムイベント
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはカスタムイベントを取得します。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
- 一度にメモリにバッファリングするカスタムイベントの最大数を指定します。
- AI監視用にエージェントを設定する際は、最大値(
100000)に設定してください。これにより、エージェントは最大数のLLMイベントを確実に取得できます。
データストアトレーサー
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
falseの場合、エージェントはdatabase_nameパラメーターをトランザクションまたは遅いsqlトレースに追加しません。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
falseの場合、エージェントはデータストアインスタンスメトリクスをレポートせず、hostまたはport_path_or_idパラメーターをトランザクションまたは遅いsqlトレースに追加しません。
無効化
これらの設定を使用して、エージェント起動時に計装タイプを切り替えます。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Action Cableの計装が無効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Action Controllerの計装が無効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Action Mailboxの計装が無効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Action Mailerの計装が無効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Active Jobの計装が無効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
If true, step names from Rails Active Job Continuations will not be included in metric names. This reduces metric cardinality but also reduces visibility into individual step performance. Only set this to true if you are experiencing metric cardinality issues due to jobs with many steps or dynamically-named steps.
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Active Storageのが無効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Active Supportの計装が無効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Active Recordの計装が無効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Active Record 4+の計装が無効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはホストプロセスのCPU使用率をサンプリングしません。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはDelayed Jobキューの深さを測定しません。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、ガベージコレクションに費やされた時間を計測するためのGC::Profilerの使用を無効にします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはホストプロセスのメモリ使用量をサンプリングしません。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはサードパーティのミドルウェアを計装用にラッピングしません(Rack::BuilderまたはRailsを介してインストールされているかどうかは問いません)。
重要
ミドルウェアの計装が無効になっている場合、アプリケーションで応答コードを変更する可能性のあるミドルウェアが使用されていると、トランザクション上で報告されるHTTPステータスコードが変更後の値を反映しない可能性があります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、サンプラーメトリクスの収集を無効にします。サンプラーメトリクスとは、イベントに基づかないメトリクス(CPU時間やメモリ使用量など)を指します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Sequelの計装を無効にします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Sidekiqの計装を無効にします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Roda向けのエージェントミドルウェアを無効にします。このミドルウェアは、ページ読み込みタイミングやエラー収集などの高度な機能をサポートするものです。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、Sinatra向けのエージェントミドルウェアを無効にします。このミドルウェアは、ディストリビューティッド(分散)トレーシング、ページ読み込みタイミング、エラー収集などの高度な機能をサポートするものです。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、ビューの計装が無効になります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはRuby VMからパフォーマンス測定をサンプリングしません。
ディストリビューティッド(分散)トレーシング
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
ディストリビューティッド(分散)トレーシングを使用すると、リクエストが分散システムを通過する経路を確認できます。ディストリビューティッド(分散)トレーシングを有効にすると、一部のNew Relic機能の動作が変化するため、この機能を有効にする前に移行ガイドをよく確認してください。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
この設定は、リモート親を持たず、New Relicエージェントのインスタンス内で開始されるトレースのトランザクションのサンプリング動作を制御します。設定可能な値は、adaptive(デフォルト値)、always_on、always_off、trace_id_ratio_basedです。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
この設定は、リモート親トランザクションがサンプリングされる場合のトランザクションサンプリングの動作を制御します。設定可能な値は、adaptive(デフォルト値)、always_on、always_off、trace_id_ratio_basedです。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
この設定は、リモート親トランザクションがサンプリングされない場合のトランザクションサンプリングの動作を制御します。設定可能な値は、adaptive(デフォルト値)、always_on、always_off、trace_id_ratio_basedです。
Elasticsearch
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはトランザクショントレースにおいてElasticsearchクラスタ名をキャプチャします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはトランザクショントレースにおいてElasticsearchクエリをキャプチャします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはトランザクショントレースにおいてElasticsearchクエリを難読化します。
Heroku
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはHeroku dyno名をホスト名として使用します。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
通常、エージェントは末尾にドットとプロセスIDが付いたdyno名を報告します(例:worker.3)。この末尾のデータを削除したい場合は、末尾データなしで報告したいプレフィックスを指定します(例:worker)。
無限トレーシング
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
トレースオブザーバーホストのhostnameを設定します。設定すると、通常のエージェントによるサンプリング判断に関係なく、追加のサンプリング判断のために、記録されたすべてのスパンをトレースオブザーバーに送信することにより、テールベースサンプリングが有効になります。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
トレースオブザーバーホストのTCP/IPポートを設定します
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
true(デフォルト)にすると、トレースオブザーバへのデータ送信は、スパンごとに個別に行われず、まとめて行われます。
タイプ | Symbol |
|---|---|
デフォルト |
|
環境変数 |
|
トレースオブザーバに送信されるデータの圧縮レベルを設定します。設定可能な値は次のとおりです::none、:low、:medium、:high。圧縮を無効にするには、レベルを:noneに設定してください。
インストゥルメンテーション
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
エージェントがサブスクライブ対象とするActive Supportライブラリ自体に固有のActive Support通知イベントの許可リスト配列。Active Supportライブラリに固有のイベントは主にキャッシュに焦点を当てています。このリストに含まれていない名前のイベントは、エージェントによって無視されます。「cache_fetch_hit.active_support」のように完全なイベント名を指定してください。アスタリスクや正規表現は使用できません。また、バックスラッシュで文字をエスケープすることもできません。設定可能なアクティブサポートイベント名の一覧については、公式Railsドキュメントのキャッシュ名一覧とメッセージ名一覧を参照してください。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時のActiveSupport::BroadcastLoggerの自動インストゥルメンテーションを制御します。設定可能な値は次のとおりです:auto、prepend、chain、disabled。Railsバージョン7.1以降で使用されます。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時のActiveSupport::Loggerの自動インストゥルメンテーションを制御します。設定可能な値は次のとおりです:auto、prepend、chain、disabled。Rails 7.1より前のバージョンで使用します。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時のAsync::HTTPの自動インストゥルメンテーションを制御します。設定可能な値は次のとおりです:auto、prepend、chain、disabled。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時のbunnyの自動インストゥルメンテーションを制御します。設定可能な値は次のとおりです:auto、prepend、chain、disabled。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時のsemantic_loggerライブラリの自動インストゥルメンテーションを制御します。設定可能な値は次のとおりです:auto、prepend、chain、disabled。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時のparallelライブラリの自動インストゥルメンテーションを制御します。設定可能な値は次のとおりです: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。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時のFibreクラスの自動インストゥルメンテーションを制御します。設定可能な値は次のとおりです:auto、prepend、chain、disabled。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時のconcurrent-rubyライブラリの自動インストゥルメンテーションを制御します。設定可能な値は次のとおりです:auto、prepend、chain、disabled。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時のCurbの自動インストゥルメンテーションを制御します。設定可能な値は次のとおりです:auto、prepend、chain、disabled。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時のDelayed Jobの自動インストゥルメンテーションを制御します。設定可能な値は次のとおりです: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。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時のloggingライブラリの自動インストゥルメンテーションを制御します。設定可能な値は次のとおりです:auto、prepend、chain、disabled。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時のLogStasherライブラリの自動インストゥルメンテーションを制御します。設定可能な値は次のとおりです:auto、prepend、chain、disabled。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
Controls instrumentation of Rails.event as structured logs
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
An array of Rails.event names to capture as structured log events. For example,
- user.signup
- payment.processed
- order.created Leave empty to capture all Rails.event notifications. Events are logged with level UNKNOWN (ensuring they're never filtered) unless overridden via :level key in the event payload.
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
起動時の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クエリを難読化します。
Opensearch
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはトランザクショントレースにOpenSearchクエリをキャプチャします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはトランザクショントレース内のOpenSearchクエリを難読化します。
OpenTelemetry
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
New Relic経由で送信されるすべてのOpenTelemetryシグナルを無効にするためのグローバル設定オプション。falseに設定すると、OpenTelemetryシグナルはNew Relicに送信されません。trueに設定した場合は、シグナル固有の有効化設定オプション(例:opentelemetry.traces.enabled)に基づいて、そのシグナルタイプのテレメトリーがNew Relicに報告されるかどうかが決まります。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
OpenTelemetryスパンからトランザクショントレースセグメントとタイムスライスメトリクスを作成する機能を有効にします。これは、OpenTelemetryスパンに関するNew Relic UIの体験向上に役立ちます。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
OpenTelemetryトレーサーのリスト。カンマ区切りの文字列で指定します(例:「AppTracer1,OpenTelemetry::Instrumentation::Bunny::Instrumentation」)。ここに指定したトレースがNew Relicに送信されるようになります。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
OpenTelemetryトレーサーのリスト。カンマ区切りの文字列で指定します(例:「AppTracer1,OpenTelemetry::Instrumentation::Bunny::Instrumentation」)。ここに指定したトレースがNew Relicに送信されなくなります。
プロセスホスト
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
New Relic UIに表示するカスタムホスト名を指定します。
Rake
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
自動インストゥルメントするRakeタスクの配列を指定します。この設定オプションは、配列を正規表現リストに変換します。デフォルトで全てのタスクを許可したい場合は、rake.tasks: [.+]を使用してください。このリストに追加されない限り、Rakeタスクはインストルメントされません。詳細については、New RelicのRake計装に関するドキュメントを参照してください。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
rakeタスクの前に接続完了を待つタイムアウト
ルール
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
エージェントに無視させたいトランザクションを定義するには、無視したいURIに一致するパターンのリストを指定します。詳細については、特定のトランザクションを無視する方法に関するドキュメントを参照してください。
セキュリティ
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、セキュリティエージェントがロードされます(Rubyの「require」が実行されます)。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、セキュリティエージェントが起動します(エージェントはイベントループで実行されます)。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
セキュリティエージェントが動作するモードを定義します。現在サポートされているのはIASTのみです。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
セキュリティ関連データの送信先となるエンドポイントのURLを定義します。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
アプリケーションがリッスンしているポート番号。この設定はPassengerサーバーでは必須です。エージェントはデフォルトで他のサーバーを検出します。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
セキュリティエージェントがIASTスキャンで無視すべきAPIパスを定義します。無視するURIに一致する正規表現パターンの配列を受け入れます。正規表現パターンは、エンドポイントを除いたURLと完全に一致するものを見つける必要があります。例: [".*account.*"], [".*/\api\/v1\/.*?\/login"]
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
セキュリティエージェントがIASTスキャンで無視すべきHTTPリクエストヘッダーを配列で指定します。配列は、無視するヘッダーに一致するパターンのリストを指定する必要があります。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
セキュリティエージェントがIASTスキャンで無視すべきHTTPリクエストクエリパラメーターを配列で指定します。配列には、HTTP リクエストに一致する無視するパターンのリストを指定する必要があります。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
セキュリティエージェントがIASTスキャンで無視すべきHTTPリクエストボディキーを配列で指定します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、軽微なセキュリティ設定の検出を無効にします。例:ハッシュ、暗号、クッキー、ランダムジェネレーター、信頼境界。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、ファイル操作関連のIAST検出(ファイルアクセスおよびアプリケーション整合性違反)を無効にします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、IASTスキャンでのSQLインジェクション検出を無効にします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、IASTスキャンでのNOSQLインジェクション検出を無効にします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、IASTスキャンでのLDAPインジェクション検出を無効にします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、IASTスキャンでのJavaScriptインジェクション検出を無効にします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、IASTスキャンでのシステムコマンドインジェクション検出を無効にします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、IASTスキャンでのXPATHインジェクション検出を無効にします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、IASTスキャンでのサーバーサイドリクエストフォージェリ(SSRF)の検出を無効にします。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、IASTスキャンでの反射型クロスサイトスクリプティング(RXSS)検出を無効にします。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
アプリケーション起動後、IASTスキャンが開始されるまでの遅延時間(分単位)を指定します。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
IASTスキャンを実施する時間(分単位)を示します。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
IASTスキャンを実行するタイミングを設定するcron式を指定します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、IASTはバックグラウンドでトレースデータを収集し続けます。セキュリティエージェントは収集されたデータを使用して、予定された時間にIASTスキャンを実行します。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
IASTスキャンで1分あたりに許可されるHTTPリクエストの最大数を設定します。12~3600の任意の整数を設定できます。デフォルト値は3600です。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
特定のエンティティに対してIAST分析を実行するアプリケーションインスタンスの数。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、HTTPレスポンスボディの送信が有効になります。これを無効にすると、反射型クロスサイトスクリプティング(RXSS)の脆弱性検出も無効になります。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
CI/CD環境でIASTを実行する際に、各テスト実行を区別するための固有のテスト識別子。例:製造番号。
Serverlessモード
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
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を介して正規表現に変換されるため、高度なマッチングが可能です。ジョブ引数ハッシュの場合、キーまたは値のいずれかが一致すると、そのペアは除外されます。一致するジョブ引数配列要素とジョブ引数スカラーはすべて除外されます。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはSidekiqの再試行中に発生した例外を無視し、ジョブが完全に失敗した場合にのみエラーを報告します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
If true, the agent starts a new transaction when a Sidekiq job is executed during a web transaction. This prevents Sidekiq job execution time from being included in web transaction metrics.
動作の遅いSQL
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントは低速なSQLクエリを収集します。
タイプ | フロート |
|---|---|
デフォルト |
|
環境変数 |
|
閾値を秒単位で指定します。エージェントは、この閾値を超える低速なSQLクエリと実行計画を収集します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントは低速なSQLクエリの実行計画を収集します。この設定を省略した場合、transaction_tracer.explain_enabled設定が低速SQLの実行計画のデフォルト設定となります。
タイプ | 文字列 |
|---|---|
デフォルト |
|
環境変数 |
|
低速なSQLクエリに対する難読化レベルを定義します。設定可能なオプションは次のとおりです:obfuscated、raw、none。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
低速なSQLトレース用に、より長いsql_idを生成します。sql_idは、類似のクエリを集約するために使用されます。
スパンイベント
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、スパンイベントのサンプリングが有効になります。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
トレースオブザーバーへのストリーミング時にバッファリングするスパンイベントの最大数を設定します。
タイプ | 整数 |
|---|---|
デフォルト |
|
環境変数 |
|
- 1回の取集から報告されるスパンイベントの最大数を定義します。
1~10000の任意の整数を設定できます。 - AI監視のエージェントを設定する場合、最大値(
10000)に設定します。これにより、エージェントは最大量のディストリビューティッド(分散)トレーシングを確実に取得できます。
例外メッセージの削除
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントは、許可されたクラスのリストにある例外を除き、すべての例外からメッセージを削除します。この設定は、高セキュリティモードでは自動的に有効になります。
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
strip_exception_messagesがtrueの場合にエージェントが削除しない例外のリストを指定します。例外をカンマで区切って設定します。例:"ImportantException,PreserveMessageException"。
Stripe
タイプ | 配列 |
|---|---|
デフォルト |
|
環境変数 |
|
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の場合、エージェントはGoogle Cloud Platform環境で実行されていることを自動検出します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはKubernetesで実行されていることを自動検出します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントはPivotal Cloud Foundry環境で実行されていることを自動検出します。
タイプ | ブール値 |
|---|---|
デフォルト |
|
環境変数 |
|
trueの場合、エージェントは環境検出を並行して実行し、エージェントの起動時間を短縮します。