Ruby エージェントの設定

New Relic エージェントの設定は、設定ファイル、環境変数、サーバーサイドの設定から変更できます。ここでは、Ruby エージェントで利用可能な設定について解説します。

設定方法と手順

デフォルトでは、Ruby エージェントは config ディレクトリにある newrelic.yml ファイルから設定を読み込みます。環境変数ですべてのオプションを設定することもできます(各オプションの前に NEW_RELIC_ 接頭辞を付け、ピリオド . は、下線 _ に置き換えます)。また、UI で、サーバーサイドの設定を利用して、設定を行えます。

Ruby エージェントにおける設定の優先順は以下のとおりです。

ruby-config-order.png
New Relic の Ruby エージェントで、環境変数はサーバーサイドの設定を上書きします。サーバーサイドの設定は、newrelic.yml 設定を上書きます。設定ファイルは、エージェントのデフォルト設定を上書きます。

設定ファイルのオプションの表示と編集

Ruby エージェントの newrelic.yml は一般的な yaml 設定ファイルです。これは、上部にデフォルトセクションと、その下に各環境のセクションがあります。たとえば、DevelopmentTestingProduction などです。

Ruby エージェントは、環境変数がアプリケーションの環境を示すように設定されているか確認し、newrelic.yml 設定ファイルのどのセクションから読み込むかを決定します。これは、設定ファイルの Development セクションの(log_level のような)設定を設定ファイルの上部にあるデフォルトセクションと別の設定を行たい場合に便利です。

以下、例です。

development:
  <<: *default_settings
  log_level: debug

Ruby エージェントが検索する環境変数の順番は以下のとおりです。

  1. NEW_RELIC_ENV
  2. RUBY_ENV
  3. RAILS_ENV
  4. RACK_ENV

上記の環境を指定した設定を Ruby エージェントが検出しない場合、エージェントは newrelic.yml 設定ファイルの development セクションから読み込みます。

rake newrelic:config:docs コマンドをを実行すると、エージェントで利用可能な設定オプションの最新のリストを確認できます。共通のオプションは、以下で説明します。

設定ファイルを編集する際は、以下のことに気をつけて下さい。

  • インデントは、スペース2つ。
  • error_collector のような関連ある塊としてインデントを使用してください。

正しくインデントされていない場合は、起動時にエージェントはUnable to parse configuration file [設定ファイルを解析できません]エラーをスローします。

設定ファイルの更新

ここでは、Ruby用エージェントの最新リリースについて説明します。以前のバージョンについては、newrelic.yml 内に記載されている内容をご覧ください。

新バージョンのリリース後に、newrelic.yml ファイルを更新するには、 エージェント gem のベースディレクトリにあるテンプレートファイルを使ってください。gem の新バージョンにアップデートした時に、config/newrelic.yml とインストールディレクトリにある newrelic.yml の差分を確認し、新バージョンで変更されたオプションがないか、チェックしてください。

注: gemを更新しても、config/newrelic.ymlは自動的に更新されません。

一般設定

以下の設定は、利用可能なエージェントの設定です。そのうちのいくつかは、New Relic のサブスクリプションレベルに依存します。

license_key
String
デフォルト値 “”
環境変数 NEW_RELIC_LICENSE_KEY

New Relic のライセンスキー

agent_enabled
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_AGENT_ENABLED

エージェントを有効または無効にする。

app_name
String
デフォルト値 (動的)
環境変数 NEW_RELIC_APP_NAME

セミコロンで区切ったアプリケーション名のリスト。エージェントがメトリクスをレポートする宛先 (例:’MyApplication’、’MyAppStaging;Instance1′)。詳しくは、アプリケーション名前付けを参照ください。

monitor_mode
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_MONITOR_MODE

true の場合、エージェントはアプリに関するデータを New Relic コレクターに送信します。

developer_mode
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_DEVELOPER_MODE

true の場合、rack アプリケーション用のエージェントに組み込まれているローカル解析パッケージである開発者モードを有効にします。お使いのアプリ上で /newrelic にアクセスすると、開発者モードの分析画面にアクセスできます。

log_level
String
デフォルト値 “info”
環境変数 NEW_RELIC_LOG_LEVEL

ログメッセージの詳細レベルを設定します。設定可能なログレベルは、冗長性を高めるために次のとおりです。errorwarninfodebug

high_security
Boolean
デフォルト値 false
環境変数 NEW_RELIC_HIGH_SECURITY

true の場合、ハイセキュリティモードが有効になります。この設定を有効にする前に、はいセキュリティモードの影響範囲を理解してください。

ssl
Boolean
デフォルト値 true
環境変数 NEW_RELIC_SSL

true の場合、New Relic コレクターへのデータ送信に SSL を利用します。

proxy_host
String
デフォルト値 nil
環境変数 NEW_RELIC_PROXY_HOST

プロキシサーバー経由で New Relic コレクタと通信するホストを定義します。

proxy_port
Fixnum
デフォルト値 nil
環境変数 NEW_RELIC_PROXY_PORT

プロキシサーバを経由して New Relic コレクタと通信するポートの定義。

proxy_user
String
デフォルト値 nil
環境変数 NEW_RELIC_PROXY_USER

プロキシサーバを経由して New Relic コレクタと通信するユーザーの定義。

proxy_pass
String
デフォルト値 nil
環境変数 NEW_RELIC_PROXY_PASS

プロキシサーバを経由して New Relic コレクタと通信するパスワードの定義。

capture_params
Boolean
デフォルト値 false
環境変数 NEW_RELIC_CAPTURE_PARAMS

true の場合、エージェントは HTTP リクエストパラメータを取得し、トランザクショントレース、トレースエラー、TransactionError イベントにそのパラメーターを追加します。

config_path
String
デフォルト値 (動的)
環境変数 NEW_RELIC_CONFIG_PATH

newrelic.yml へのパス。省略した場合、エージェントは config/newrelic.ymlnewrelic.yml$HOME/.newrelic/newrelic.yml$HOME/newrelic.yml(の順番に)確認します。

apdex_t
Float
デフォルト値 0.5
環境変数 NEW_RELIC_APDEX_T

非推奨 バージョン 3.5.0 以上では、New Relic UI 経由で Apdex T を設定できます。

sync_startup
Boolean
デフォルト値 false
環境変数 NEW_RELIC_SYNC_STARTUP

true の場合、アプリケーション起動時に New Relic コレクタに同期接続を強制します。非常に寿命の短いプロセスの場合、New Relic エージェントにレポートする時間を確保するのに役立ちます。

send_data_on_exit
Boolean
デフォルト値 true
環境変数 NEW_RELIC_SEND_DATA_ON_EXIT

true の場合、シャットダウン前に New Relic のコレクターにデータを送信する終了ハンドラを有効にします。

timeout
Fixnum
デフォルト値 120
環境変数 NEW_RELIC_TIMEOUT

エージェントがコレクタへの接続を試みる最大秒数を定義します。

log_file_name
String
デフォルト値 “newrelic_agent.log”
環境変数 NEW_RELIC_LOG_FILE_NAME

ログファイルの名前。

log_file_path
String
デフォルト値 “log/”
環境変数 NEW_RELIC_LOG_FILE_PATH

エージェントのログファイルのパス。ファイル名は除く。

capture_memcache_keys
Boolean
デフォルト値 false
環境変数 NEW_RELIC_CAPTURE_MEMCACHE_KEYS

トランザクショントレースから memcache キーの取得を有効または無効にする設定。

marshaller
String
デフォルト値 (動的)
環境変数 NEW_RELIC_MARSHALLER

New Relic のコレクターにデータを送信するためのマーシャラーを指定する。現在は、json のみ指定可能です。

labels
String
デフォルト値 “”
環境変数 NEW_RELIC_LABELS

このエージェントから送信されたデータに適用するラベル名と値のディクショナリー。コロン : 区切りのペアの文字列をセミコロン ; で区切ると複数指定できます。例:Server:One;Data Center:Primary

ca_bundle_path
String
デフォルト値 nil
環境変数 NEW_RELIC_CA_BUNDLE_PATH

マニュアルで上書きするローカルの CA バンドルへのパス。この CA バンドルは New Relic データ収集サービスによって提示された SSL 証明書を検証するために使用されます。

datastore_tracer.instance_reporting.enabled
Boolean
デフォルト値 true
環境変数 NEW_RELIC_DATASTORE_TRACER_INSTANCE_REPORTING_ENABLED

false の場合、エージェントはデータストアのインスタンス用のメトリクスを報告しません。また、トランザクションうや遅い SQL トレースに hostport_path_or_id パラメータを追加しません。

datastore_tracer.database_name_reporting.enabled
Boolean
デフォルト値 true
環境変数 NEW_RELIC_DATASTORE_TRACER_DATABASE_NAME_REPORTING_ENABLED

false の場合、エージェントはトランザクションや遅い SQL トレースに database_name パラメータを追加しません。

トランザクショントレーサー

トランザクションのトレース機能は、選別したトランザクションから詳細な情報を収集することです。トランザクションには、呼び出しシーケンスの概要、消費時間の内訳、SQL クエリのリスト、(MySQL や PostgreSQL の)クエリの実行計画が含まれます。これらの機能が利用可能かどうかは、サブスクリプションレベルに依存します。

transaction_tracer.enabled
Boolean
デフォルト値 true
環境変数 NEW_RELIC_TRANSACTION_TRACER_ENABLED

true の場合、トランザクションのトレースの収集を有効にします。

transaction_tracer.transaction_threshold
Float もしくは ‘apdex_f’ という文字列
デフォルト値 (動的)
環境変数 NEW_RELIC_TRANSACTION_TRACER_TRANSACTION_THRESHOLD

トランザクショントレースの対象となるレスポンスタイムの閾値を指定します。デフォルト値は、apdex_f です。これは、アプリで指定しているApdex T 値の4倍の値です。あるいは、代わりに特定の秒数を浮動小数点数として入力することもできます。

transaction_tracer.record_sql
String
デフォルト値 “obfuscated”
環境変数 NEW_RELIC_TRANSACTION_TRACER_RECORD_SQL

トランザクショントレースのノードから報告された SQL クエリを難読化するためのレベル。次の3つが設定可能です。obfuscated [難読化]、raw [生]、none [含めない]

transaction_tracer.record_redis_arguments
Boolean
デフォルト値 false
環境変数 NEW_RELIC_TRANSACTION_TRACER_RECORD_REDIS_ARGUMENTS

true の場合、エージェントは、Redis コマンドの引数をトランザクショントレースに記録します。

transaction_tracer.capture_attributes
Boolean
デフォルト値 true
環境変数 NEW_RELIC_TRANSACTION_TRACER_CAPTURE_ATTRIBUTES

非推奨 代わりに transaction_tracer.attributes.enabled を利用してください。

transaction_tracer.explain_threshold
Float
デフォルト値 0.5
環境変数 NEW_RELIC_TRANSACTION_TRACER_EXPLAIN_THRESHOLD

エージェントが実行計画を収集する際の(秒あたりの)閾値。explain_enabled が true の場合のみ有効になります。

transaction_tracer.explain_enabled
Boolean
デフォルト値 true
環境変数 NEW_RELIC_TRANSACTION_TRACER_EXPLAIN_ENABLED

true の場合、トランザクショントレースにある実行計画を収集します。この設定は、a href=”#slow_sql-explain_enabled”>slow_sql.explain_enabled が個別に設定されていない場合、Slow SQL トレースの実行計画にも適用されます。

transaction_tracer.stack_trace_threshold
Float
デフォルト値 0.5
環境変数 NEW_RELIC_TRANSACTION_TRACER_STACK_TRACE_THRESHOLD

閾値を秒単位で指定します。エージェントは、スタックトレーストレースの処理時間がこの閾値を超えると、トランザクショントレースノードにスタックトレースを追加します。

transaction_tracer.limit_segments
Fixnum
デフォルト値 4000
環境変数 NEW_RELIC_TRANSACTION_TRACER_LIMIT_SEGMENTS

単一のトランザクションのトレースに記録できるトランザクショントレースノードの最大数。

エラーコレクター

エージェントは、デフォルトですべての未キャッチ例外を収集してレポートします。これらの設定オプションを使用すると、エラーコレクションをカスタマイズすることができます。

error_collector.enabled
Boolean
デフォルト値 true
環境変数 NEW_RELIC_ERROR_COLLECTOR_ENABLED

true の場合、エージェントは、トレースエラーやエラーカウントのメトリクスをキャプチャします。

error_collector.capture_attributes
Boolean
デフォルト値 true
環境変数 NEW_RELIC_ERROR_COLLECTOR_CAPTURE_ATTRIBUTES

非推奨 error_collector.attributes.enabled を使ってください。

error_collector.ignore_errors
String
デフォルト値 “ActionController::RoutingError,Sinatra::NotFound”
環境変数 NEW_RELIC_ERROR_COLLECTOR_IGNORE_ERRORS

エージェントが無視するエラークラスのカンマ区切りのリスト。

error_collector.capture_events
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_ERROR_COLLECTOR_CAPTURE_EVENTS

true の場合、エージェントは TransactionError イベントを収集します。

error_collector.max_event_samples_stored
Fixnum
デフォルト値 100
環境変数 NEW_RELIC_ERROR_COLLECTOR_MAX_EVENT_SAMPLES_STORED

収集サイクルごとに Insights に送信する TransactionError イベントの最大数を定義します。

ブラウザ監視

New Relic ブラウザのページの読み込みタイミング(実ユーザー監視または RUM と呼ばれる)機能は、ユーザーがウェブサイトで体験している実際の性能に対するインサイトを提供します。各ページのヘッダーとフッターに少しの JavaScript コードを挿入することにより、ブラウザが、Web ページをダウンロードして、レンダリングにかかる時間を測定することによって性能を測定します。

browser_monitoring.auto_instrument
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_BROWSER_MONITORING_AUTO_INSTRUMENT

true の場合、ページの読み込みタイミング用の JavaScript ヘッダーの自動挿入を行います。

browser_monitoring.capture_attributes
Boolean
デフォルト値 false
環境変数 NEW_RELIC_BROWSER_MONITORING_CAPTURE_ATTRIBUTES

非推奨 代わりに browser_monitoring.attributes.enabled を使ってください。

Analytics イベント

New Relic Insights は、ソフトウェアとビジネスに関するデータを収集し、可視化するソフトウェア分析リソースです。Insights 上で、リアルタイムのダッシュボードを作成することで、すばやく簡単にエンドユーザー体験、クリックの流れ、モバイルにおける活動、サーバートランザクションに関して素早く回答を得ることができます。

analytics_events.enabled
Boolean
デフォルト値 true
環境変数 NEW_RELIC_ANALYTICS_EVENTS_ENABLED

true の場合、分析イベントのサンプルの抽出を行います。

analytics_events.max_samples_stored
Fixnum
デフォルト値 1200
環境変数 NEW_RELIC_ANALYTICS_EVENTS_MAX_SAMPLES_STORED

単一の収穫サイクルにおけるレポート対象となるリクエストイベントの最大数。

analytics_events.capture_attributes
Boolean
デフォルト値 true
環境変数 NEW_RELIC_ANALYTICS_EVENTS_CAPTURE_ATTRIBUTES

非推奨 代わりに transaction_events.attributes.enabled を利用してください。

属性

属性は、イベントやトランザクションのプロパティを決定する情報を含むキーと値のペアです。これらのキーと値のペアは、New Relic APM のトランザクショントレース、New Relic APM のトレースエラー、Insights の Transactio イベント、Insights の PageView で見ることができます。これらの各宛先に送信する属性を正確にカスタマイズすることができます。

attributes.enabled
Boolean
デフォルト値 true
環境変数 NEW_RELIC_ATTRIBUTES_ENABLED

true の場合、すべての宛先の属性を取得できます。

transaction_tracer.attributes.enabled
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_ENABLED

true の場合、エージェントはトランザクショントレースから属性を取得します。

transaction_events.attributes.enabled
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_ENABLED

true の場合、エージェントはトランザクションイベントから属性を取得します。

error_collector.attributes.enabled
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_ENABLED

true の場合、エージェントはエラーコレクションから属性を取得します。

browser_monitoring.attributes.enabled
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_ENABLED

true の場合、エージェントはブラウザ監視から属性を取得します。

attributes.exclude
Array
デフォルト値 []
環境変数 NEW_RELIC_ATTRIBUTES_EXCLUDE

すべての宛先から除外する属性の接頭辞。末尾に * ワイルドカードを使用できます。

transaction_tracer.attributes.exclude
Array
デフォルト値 []
環境変数 NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_EXCLUDE

トランザクショントレースから除外する属性の接頭辞。末尾に * ワイルドカードを使用できます。

transaction_events.attributes.exclude
Array
デフォルト値 []
環境変数 NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_EXCLUDE

トランザクションイベントから除外する属性の接頭辞。末尾に * ワイルドカードを使用できます。

error_collector.attributes.exclude
Array
デフォルト値 []
環境変数 NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_EXCLUDE

エラーコレクションから除外する属性の接頭辞。末尾に * ワイルドカードを使用できます。

browser_monitoring.attributes.exclude
Array
デフォルト値 []
環境変数 NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_EXCLUDE

ブラウザ監視から除外する属性の接頭辞。末尾に * ワイルドカードを使用できます。

attributes.include
Array
デフォルト値 []
環境変数 NEW_RELIC_ATTRIBUTES_INCLUDE

すべての送り先に含める属性の接頭辞。末尾に * ワイルドカードを使用できます。

transaction_tracer.attributes.include
Array
デフォルト値 []
環境変数 NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_INCLUDE

トランザクショントレースに含める属性の接頭辞。末尾に * ワイルドカードを使用できます。

transaction_events.attributes.include
Array
デフォルト値 []
環境変数 NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_INCLUDE

トランザクションイベントに含める属性の接頭辞。末尾に * ワイルドカードを使用できます。

error_collector.attributes.include
Array
デフォルト値 []
環境変数 NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_INCLUDE

エラーコレクションに含める属性の接頭辞。末尾に * ワイルドカードを使用できます。

browser_monitoring.attributes.include
Array
デフォルト値 []
環境変数 NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_INCLUDE

ブラウザ監視に含める属性の接頭辞。末尾に * ワイルドカードを使用できます。

監査ログ

audit_log.enabled
Boolean
デフォルト値 false
環境変数 NEW_RELIC_AUDIT_LOG_ENABLED

true の場合、New Relic のコレクターとの通信のログである監査ログを有効にします。

audit_log.path
String
デフォルト値 (動的)
環境変数 NEW_RELIC_AUDIT_LOG_PATH

監査ログファイルのパス。ファイル名を含む。

audit_log.endpoints
Array
デフォルト値 [“.*”]
環境変数 NEW_RELIC_AUDIT_LOG_ENDPOINTS

監査ログに含まれる許可済みのエンドポイントのリスト。

自動起動

autostart.blacklisted_constants
String
デフォルト値 “Rails::Console”
環境変数 NEW_RELIC_AUTOSTART_BLACKLISTED_CONSTANTS

定数のカンマ区切りのリスト。この定数がある場合、エージェントは自動で開始しません。例:Rails::Console,UninstrumentedBackgroundJob

autostart.blacklisted_executables
String
デフォルト値 “irb,rspec”
環境変数 NEW_RELIC_AUTOSTART_BLACKLISTED_EXECUTABLES

エージェントの計測対象外とする実行可能ファイルのカンマ区切りのリスト。例:rake,my_ruby_script.rb

autostart.blacklisted_rake_tasks
String
デフォルト値 “about,assets:clean,assets:clobber,assets:environment,assets:precompile,assets:precompile:all,db:create,db:drop,db:fixtures:load,db:migrate,db:migrate:status,db:rollback,db:schema:cache:clear,db:schema:cache:dump,db:schema:dump,db:schema:load,db:seed,db:setup,db:structure:dump,db:version,doc:app,log:clear,middleware,notes,notes:custom,rails:template,rails:update,routes,secret,spec,spec:features,spec:requests,spec:controllers,spec:helpers,spec:models,spec:views,spec:routing,spec:rcov,stats,test,test:all,test:all:db,test:recent,test:single,test:uncommitted,time:zones:all,tmp:clear,tmp:create”
環境変数 NEW_RELIC_AUTOSTART_BLACKLISTED_RAKE_TASKS

エージェントの計測対象外とする rake タスクのカンマ区切りのリスト。例:assets:precompile,db:migrate

クロスアプリケーショントレーサー

cross_application_tracer.enabled
Boolean
デフォルト値 true
環境変数 NEW_RELIC_CROSS_APPLICATION_TRACER_ENABLED

true の場合、クロスアプリケーショントレースを有効にします。

Insights カスタムイベント

custom_insights_events.enabled
Boolean
デフォルト値 true
環境変数 NEW_RELIC_CUSTOM_INSIGHTS_EVENTS_ENABLED

true の場合、Insights カスタムイベントを収集します。

custom_insights_events.max_samples_stored
Fixnum
デフォルト値 1000
環境変数 NEW_RELIC_CUSTOM_INSIGHTS_EVENTS_MAX_SAMPLES_STORED

一度にメモリにバッファ可能な Insights カスタムイベントの最大数

無効化

エージェント起動時に計測タイプを切り替えるには、以下の設定を使用します。

disable_rake
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_RAKE

true の場合、Rake 計測を無効にします。

disable_samplers
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_SAMPLERS

true の場合、サンプラーメトリクスの収集を無効にします。サンプラーメトリクスとは、(CPU 時間やメモリ使用量など)イベントを基にしていないメトリックのことです。

disable_resque
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_RESQUE

true の場合、Resque 計測を無効にします。

disable_sidekiq
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_SIDEKIQ

true の場合、Sidekiq 計測を無効にします。

disable_dj
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_DJ

true の場合、Delayed::Job 計測を無効にします。

disable_sinatra
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_SINATRA

true の場合、Sinatra 計測 [英語]を無効にします。

disable_sinatra_auto_middleware
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_SINATRA_AUTO_MIDDLEWARE

true の場合、Sinatra 向けのエージェントミドルウェアを無効にします。エージェントミドルウェアは、Sinatra において高度な機能のサポートを担当します。例えば、クロスアプリケーションのトレースページの読み込みタイミングエラーコレクションなど。

disable_view_instrumentation
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_VIEW_INSTRUMENTATION

true の場合、view 計測を無効にします。

disable_backtrace_cleanup
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_BACKTRACE_CLEANUP

true の場合、エージェントがバックトレースから newrelic_rpm を削除しません。

disable_activerecord_instrumentation
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_DISABLE_ACTIVERECORD_INSTRUMENTATION

true の場合、アクティブレコードの計測を無効にします。

disable_data_mapper
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_DATA_MAPPER

true の場合、DataMapper の計測を無効にします。

disable_activejob
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_ACTIVEJOB

true の場合、ActiveJob 計測を無効にします。

disable_action_cable_instrumentation
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_ACTION_CABLE_INSTRUMENTATION

true の場合、 Action Cable の計測を無効にします。

disable_memcached
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_DISABLE_MEMCACHED

true の場合、 memcache gem 用の計測を無効にします。

disable_memcache_client
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_DISABLE_MEMCACHE_CLIENT

true の場合、 memcache-client gem 用の計測を無効にします。

disable_dalli
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_DISABLE_DALLI

true の場合、dalli gem 用の計測を無効にします。

disable_dalli_cas_client
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_DISABLE_DALLI_CAS_CLIENT

true の場合、dalli gem の追加の CAS クライアントサポート用の計測を無効にします。

disable_memcache_instrumentation
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_DISABLE_MEMCACHE_INSTRUMENTATION

true の場合、memcache 計測を無効にします。

disable_gc_profiler
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_GC_PROFILER

true の場合、ガーベッジコレクションの消費時間を計測する GC::Profiler の利用を無効にします。

disable_sequel_instrumentation
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_SEQUEL_INSTRUMENTATION

true の場合、Sequel 計測 [英語]を無効にします。

disable_database_instrumentation
Boolean
デフォルト値 false

非推奨代わりに、disable_sequel_instrumentation を使ってください。

disable_mongo
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_MONGO

true の場合、エージェントは Mongo gem 用の計測 [英語]をインストールしません。

disable_redis
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_REDIS

true の場合、エージェントは Redis 用計測 [英語]をインストールしません。

disable_vm_sampler
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_VM_SAMPLER

true の場合、エージェントは Ruby VM からパフォーマンスの測定値をサンプル抽出 [英語]しません。

disable_memory_sampler
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_MEMORY_SAMPLER

true の場合、エージェントは、ホストプロセスのメモリ使用率をサンプル抽出しません。

disable_cpu_sampler
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_CPU_SAMPLER

true の場合、エージェントは、ホストプロセスの CPU 使用率をサンプル抽出しません。

disable_delayed_job_sampler
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_DELAYED_JOB_SAMPLER

true の場合、エージェントは、Delayed Job のキューの深さを計測しません。

disable_active_record_4
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_ACTIVE_RECORD_4

true の場合、エージェントは ActiveRecord 4 用の計測を無効にします。

disable_curb
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_CURB

true の場合、エージェントは curb gem 用の計測を無効にします。

disable_excon
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_EXCON

true の場合、エージェントは excon gem 用の計測を無効にします。

disable_httpclient
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_HTTPCLIENT

true の場合、エージェントは httpclient gem 用の計測を無効にします。

disable_net_http
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_NET_HTTP

true の場合、エージェントは Net::HTTP 用の計測を無効にします。

disable_rack
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_RACK

true の場合、アプリ起動中に、エージェントが、計測用の gem を探すために Rack::Builder の to_app メソッドにフックしません。

disable_rack_urlmap
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_RACK_URLMAP

true の場合、アプリ起動中に、エージェントが、ミドルウェアトレーシングをインストールするために Rack::URLMap にフックしません。

disable_puma_rack
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_DISABLE_PUMA_RACK

true の場合、アプリ起動中に、エージェントが、計測用の gem を探すために Puma::Rack::Builder の to_app メソッドにフックしません。

disable_puma_rack_urlmap
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_DISABLE_PUMA_RACK_URLMAP

true の場合、アプリ起動中に、エージェントが、ミドルウェアトレーシングをインストールするために Puma::Rack::URLMap にフックしません。

disable_rubyprof
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_RUBYPROF

true の場合、エージェントはデベロッパーモードでは RubyProf を使いません。

disable_typhoeus
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_TYPHOEUS

true の場合、エージェントは typhoeus gem 用の計測をインストールしません。

disable_httprb
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_HTTPRB

true の場合、エージェントは http.rb gem 用の計測をインストールしません。

disable_middleware_instrumentation
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_MIDDLEWARE_INSTRUMENTATION

true の場合、エージェントは (Rack::Builder や Rails 経由でインストールされているかに関係なく)
計測にサードパーティのミドルウェアをラップしません。

disable_grape
Boolean
デフォルト値 false
環境変数 NEW_RELIC_DISABLE_GRAPE

true の場合、エージェントは Grape 計測をインストールしません。

Heroku

heroku.use_dyno_names
Boolean
デフォルト値 true
環境変数 NEW_RELIC_HEROKU_USE_DYNO_NAMES

true の場合、エージェントはホスト名として heroku dyno 名を使用します。

heroku.dyno_name_prefixes_to_shorten
Array
デフォルト値 [“scheduler”, “run”]
環境変数 NEW_RELIC_HEROKU_DYNO_NAME_PREFIXES_TO_SHORTEN

通常、エージェントは後続のドットとプロセス ID を含んだ dyno 名 (たとえば worker.3)を送信します。この後続データを削除するには、後続データなしでレポートするにはプレフィックス(たとえば worker)を指定します。

Mongo

mongo.capture_queries
Boolean
デフォルト値 true
環境変数 NEW_RELIC_MONGO_CAPTURE_QUERIES

true の場合、エージェントは トランザクショントレースで、Mongo クエリをキャプチャします。

mongo.obfuscate_queries
Boolean
デフォルト値 true
環境変数 NEW_RELIC_MONGO_OBFUSCATE_QUERIES

true の場合、エージェントは トランザクショントレースで、Mongo クエリを難読化します。

プロセスのホスト

process_host.display_name
String
デフォルト値 (動的)
環境変数 NEW_RELIC_PROCESS_HOST_DISPLAY_NAME

New Relic UI に表示するカスタムホスト名を指定します。

Rake

rake.tasks
Array
デフォルト値 []
環境変数 NEW_RELIC_RAKE_TASKS

自動的に計測する Rake タスクのリスト。

rake.connect_timeout
Fixnum
デフォルト値 10
環境変数 NEW_RELIC_RAKE_CONNECT_TIMEOUT

Rake タスク実行の前に、エージェントが計測する前準備として接続する際の待ち時間におけるタイムアウト。

Resque

resque.capture_params
Boolean
デフォルト値 false
環境変数 NEW_RELIC_RESQUE_CAPTURE_PARAMS

非推奨 true の場合、Resque はトランザクショントレースとトレースエラーのジョブの引数をキャプチャします。

Rules

rules.ignore_url_regexes
Array
デフォルト値 []
環境変数 NEW_RELIC_RULES_IGNORE_URL_REGEXES

いずれかの URI に一致する場合、トランザクションを無視するパターンのリスト。

Sidekiq

sidekiq.capture_params
Boolean
デフォルト値 false
環境変数 NEW_RELIC_SIDEKIQ_CAPTURE_PARAMS

非推奨 true の場合、Sidekiq はトランザクショントレースとトレースエラーのジョブの引数をキャプチャします。

Slow SQL

slow_sql.enabled
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_SLOW_SQL_ENABLED

true の場合、Slow SQL クエリを収集します。

slow_sql.explain_threshold
Float
デフォルト値 (動的)
環境変数 NEW_RELIC_SLOW_SQL_EXPLAIN_THRESHOLD

実行計画の収集対象の処理時間の閾値。この時間を越えると、エージェントは Slow SQL クエリの実行計画を収集します。

slow_sql.explain_enabled
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_SLOW_SQL_EXPLAIN_ENABLED

true の場合、エージェントは、Slow SQL クエリの実行計画を収集します。この設定を行わない場合は、transaction_tracer.explain_enabled 設定がデフォルト設定として、適用されます。

slow_sql.record_sql
String
デフォルト値 (動的)
環境変数 NEW_RELIC_SLOW_SQL_RECORD_SQL

Slow SQL クエリの難読化レベルの定義。指定可能な値は、次のとおりです。
obfuscatedrawnone

slow_sql.use_longer_sql_id
String
デフォルト値 false
環境変数 NEW_RELIC_SLOW_SQL_USE_LONGER_SQL_ID

遅い SQL トレース用に長い sql_id を生成します。sql_id は、類似したクエリの集計に使われます。

例外メッセージの削除

strip_exception_messages.enabled
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_STRIP_EXCEPTION_MESSAGES_ENABLED

true の場合、エージェントは、ホワイトリストに指定されていない全ての例外から、メッセージを取り除く必要があるかどうかの定義。ハイセキュリティモードでは、自動的に有効になります。

strip_exception_messages.whitelist
String
デフォルト値 “”
環境変数 NEW_RELIC_STRIP_EXCEPTION_MESSAGES_WHITELIST

strip_exception_messagesstrip_exception_messages が true の場合、エージェントの削除対象外とすると例外のホワイトリストを指定します。複数の場合は、カンマで区切ります。例: "ImportantException,PreserveMessageException"

スレッドプロファイラー

thread_profiler.enabled
Boolean
デフォルト値 (動的)
環境変数 NEW_RELIC_THREAD_PROFILER_ENABLED

true の場合、スレッドプロファイラーを有効にします。

ユーティリティ

utilization.detect_aws
Boolean
デフォルト値 true
環境変数 NEW_RELIC_UTILIZATION_DETECT_AWS

true の場合、エージェントは AWS 環境で実行されていることを自動的に検出します。

utilization.detect_docker
Boolean
デフォルト値 true
環境変数 NEW_RELIC_UTILIZATION_DETECT_DOCKER

true の場合、エージェントは Docker で実行中であることを自動的に検出します。

X-Ray Session

xray_session.enabled
Boolean
デフォルト値 true
環境変数 NEW_RELIC_XRAY_SESSION_ENABLED

true の場合、X-Ray セッションを有効にします。

関連情報

関連情報は以下のとおりです。