Rubyエージェントの一般設定

trueの場合、Rubyエージェントの実行を許可します。

NewRelicUIでデータを集約するために使用するアプリケーション名を指定します。同時に複数のアプリにデータを報告するには、名前のリストをセミコロン;で区切って指定します。たとえば、 MyAppまたはMyStagingApp;Instance1 。

あなたのNew Relic ライセンスキー。

ログメッセージの詳細レベルを設定します。設定可能なログレベルは、詳細レベルが低い方から、fatal、error、warn、info、debugです。

サブスクライブして計装するActiveSupportカスタムイベント名の配列。例：[one.custom.event, another.event, a.third.event]

trueに設定すると、エージェントはActive Recordのメトリクス、スパン、およびトランザクショントレースセグメントを命名する際、クラス名ではなくActive Recordモデルのテーブル名を使用します。複数のモデルがデータベーステーブルを共有している場合、この設定によりカーディナリティを削減できます。デフォルトはfalseです。

Rails 6で導入されたActiveRecordの接続検索の高速化をバックポートし、ActiveRecordをインストルメントする際のエージェントのパフォーマンスを向上させます。この設定は、ActiveRecordにパッチを当てる他のgemと互換性がないかもしれないことに注意してください。

ローカル CA バンドルへのパスを手動でオーバーライドします。この CA バンドルは、 New Relicのデータ収集サービスによって提示された SSL 証明書を検証します。

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

trueの場合、エージェントはHTTPリクエストパラメータをキャプチャし、それらをトランザクショントレース、トレースされたエラー、およびTransactionErrorイベントに添付します。

trueの場合、エージェントはAgent.drop_buffered_dataのTracer::Stateをクリアします。

newrelic.ymlへのパス。指定しない場合、エージェントは以下のディレクトリを（以下の順番で）チェックします：config/newrelic.yml -> newrelic.yml -> $HOME/.newrelic/newrelic.yml -> $HOME/newrelic.yml

trueの場合、アウトバウンドリクエストにnewrelicディストリビューティッド（分散）トレーシングヘッダーを付加しません。

trueの場合、通常はインストールをスキップする場合（別のフレームワーク内の埋め込みサービスとしてSinatraが実行されていることを検出した場合など）でも、エージェントに終了ハンドラー（シャットダウンする前にキャッシュされたすべてのデータをコレクターに送信する）を強制的にインストールさせます。Sinatraはアプリケーション全体を独自のat_exitブロック内で実行するため、競合を避けるために、エージェントはデフォルトで独自のat_exitハンドラーをスキップします。この設定はそのデフォルトの動作を上書きします。注意：この設定を有効にするには、send_data_on_exitもtrueにする必要があります。

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

このエージェントから送信されるデータに適用されるラベル名と値の辞書。コロンで区切られた:ペアのセミコロンで区切られた;文字列として表現することもできます。たとえば、 Server:One;Data Center:Primary 。

ログファイルの名前を定義します。

エージェントログファイルへのパスを定義します（ファイル名は含みません）。エージェントのログを標準出力に送信したい場合は、これをSTDOUTに設定してください。

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の場合、Action Cableブロードキャスト呼び出しのメトリクスには、指定されたブロードキャストのbroadcastingの値は含まれません。デフォルトはfalseです。デフォルトは、今後のメジャーバージョンリリースで変更される可能性があります。

エージェントが無視すべきミドルウェアクラスまたはモジュール名のリスト。例：["Rack::Cors", "ActionDispatch::Reloader"]

trueの場合、エージェントが Ruby on Rails を使用するアプリケーションにある場合、エージェントは config/initializers の実行後に開始されます。