infrastructureエージェントには、その動作を微調整するための大量の設定セットがあります。ここでは:
- すべての設定オプションを一覧表示します(YAMLと環境変数名の両方)。
- 設定の内容と使用するタイミングを説明します。
- 変数の型とデフォルト値(ある場合)を指定します。
- 必要に応じて、最低限必要なエージェントバージョンを列挙します。
重要
シークレット管理を使用すると、インフラストラクチャを使用してエージェントのオンホストインテグレーションを設定し、機密データ(パスワードなど)をインテグレーションの設定ファイルにプレーンテキストとして書き込むことなく使用できるようになります。詳細については、「シークレットの管理」を参照してください。
まだNewRelicアカウントがありませんか?永久に無料でサインアップ します。
スタートガイド
New Relicアカウントを作成し(永久に無料です)、infrastructureエージェントをインストールした後、環境に合わせてinfrastructureエージェントを設定できるようになります。
必須の設定は、license_keyのみです。
各変数の使用方法の例については、 GitHubのサンプル設定テンプレートを参照してください。
環境変数
リストされている設定オプションの多くは、環境変数を使用して値を設定することもでき、これはYAML設定よりも優先されます。
重要
多くの場合、infrastructureエージェントはホスト内のシステムサービスとして実行され、グローバルに管理されます(例:Linux、Windowsサービスの場合はsystemd 、macOSの場合はlaunchd)。このセットアップで環境変数によって設定の変更を適用するには、これらの環境変数を設定し、infrastructureエージェントサービスが実行されている個別のコンテキストに表示できるようにする必要があります。この方法はプラットフォームによって異なります。環境変数をシステムサービスに追加する方法を確認するには、プラットフォームのサービスマネージャーのドキュメントを確認してください。
エージェント変数
New Relicアカウントのを指定します。エージェントはこのキーを使用して、サーバーのメトリクスをNew Relicアカウントに関連付けます。 この設定は、標準のインストレーションプロセスの一部として作成されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
例:
license_key: 1234567890abcdefghijklmnopqrstuvwxyz1234FedRAMPエンドポイントを使用するかどうかを指定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
エージェントが使用できる論理プロセッサの数を指定します。この値を増やすと、異なるコア間における負荷の分散化に役立ちます。
-1に設定すると、エージェントは環境変数GOMAXPROCSを読み取ろうとします。この変数が設定されていない場合、デフォルト値はホストで使用可能なコアの合計数になります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
エラーをスローする前に、エージェントが起動時にNew Relicプラットフォームの可用性を確認するためのリクエストを再試行する回数。
negative valueに設定すると、エージェントは接続が成功するまで接続をチェックし続けます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
| 1.0.936 |
リクエストがタイムアウトした後、エージェントが起動時にNew Relicプラットフォームの可用性を確認するためにリクエストを再試行するまで待機する時間。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
| 1.0.936~1.2.30 |
起動時にNew Relicプラットフォームの可用性を確認する要求がタイムアウトしたと判断されるまでエージェントが待機する時間。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
| 1.0.936 |
エージェント自身の計装を有効にします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
|
組み込みのFluentbitログフォワーダーを介してログ転送のエージェント再試行を有効にします。整数値は意図した再試行回数を表します。その他の設定可能な値には、再試行回数を無制限に設定するFalseや、再試行機能を完全にオフにするno_retriesがあります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
クラウド変数
エージェントがcloudインスタンスで実行されている場合、エージェントはcloudタイプを検出し、基本的なメタデータを取得しようとします。メトリクスは、 New Relicにcloudプロバイダーアカウントを接続するときに、拡張cloudメタデータ(カスタムリソースタグを含む)で強化することもできます。
cloud検出が失敗した場合にエージェントが接続を再試行する回数を設定します。
エージェントの初期化中にcloud検出に失敗した場合、エージェントはCloudRetryBackOffSec秒待ってから再試行します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
| 1.2.6 |
エージェントがメタデータを破棄するまで待機する間隔を秒単位で設定します。この期間が過ぎるとメタデータの有効期限が切れ、エージェントはそれを再度取得します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
| 1.2.6 |
cloud検出が失敗した場合に、エージェントがcloud検出の再試行を待機する間隔を秒単位で設定します。
エージェントの初期化中にcloud検出が失敗した場合、 CloudMaxRetryCount回再試行されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
| 1.2.6 |
エージェントが実行されているcloudプロバイダーを指定します。これがデフォルトとは異なる値に設定されている場合、エージェントはcloudプロバイダーからメタデータ(インスタンス ID)を正常に取得するまで待機してから、データをバックエンドに送信します。
デフォルトの動作では、エージェントはcloudプロバイダーを検出してメタデータを取得しようとしますが、エージェントはブロックされません。
許可される値:"" 、 "aws" 、 "azure" 、 "gcp" 、 "alibaba"
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
| 1.40.1 |
DisableCloudMetadataと似ていますが、ホストエイリアスプラグインのcloudメタデータの収集のみを無効にします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
| 1.0.220 |
cloudメタデータの収集を無効にします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
Docker変数
キャッシュされたコンテナのメタデータの有効期限が切れ、エージェントによる再取得が必要になるまでの時間(秒)。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
| 1.0.801 |
DockerクライアントのAPI バージョンを指定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
|
ファイルシステム変数
エージェントがサポートするファイルシステムの種類のリスト。この値はデフォルトリストのサブセットである必要があり、デフォルトリストにない項目は破棄されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| []string | Linux: Windows: | 1.0.220 |
StorageSampleデータを収集する際、エージェントによって無視されるストレージデバイスのリスト。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| []string | 1.0.220 |
YAML属性としての例:
file_devices_ignored: - sda1 - sda2環境変数としての例:
FILE_DEVICES_IGNORED="sda1,sda2"ホスト名変数
レポート用に自動生成されたhostnameを上書きします。これは、インフラストラクチャ監視が各ホストの一意の識別子としてhostnameを使用するため、同じ名前のホストが複数ある場合に便利です。この値は、エンティティ名のループバックアドレスの置換にも使用されることに注意してください。
詳細については、 エンティティ名解決の仕組みに関するドキュメントをご覧ください。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 | 空 | 1.0.266 |
例:
display_name: teslaOnetrueの場合、ホストのアドレスのルックアップを実行することによって完全なhostnameを解決します。それ以外の場合、Linuxではhostnameコマンドで取得し、 Windowsではレジストリの TCP/IPパラメーターから取得します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
設定されている場合、この値が完全なhostnameとして報告されます。それ以外の場合、エージェントは通常のルックアップを実行します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 | 1.0.1015 |
例:
my.custom-hostname.co.org設定されている場合、この値がhostnameとして報告されます。それ以外の場合、エージェントは通常のルックアップを実行します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 | 1.0.1015 |
例:
my.custom-hostnameインストレーション変数
エージェントがキャッシュ、インベントリ、インテグレーションなどのファイルを保存するディレクトリ。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 | Linux: Windows: | 1.0.2 |
インテグレーションの設定ファイルが格納されているディレクトリ。
各インテグレーションには、デフォルトで<integration_name>-config.ymlという名前の独自の設定ファイルがあり、初期化時にエージェントが読み込まれる事前定義された場所に配置されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 | Linux: Windows: | 1.0.2 |
インテグレーションをインストールするためのカスタムパスを指定します。これにより、インテグレーションをagent_dirの外部にインストールできるようになります。エージェントがインストールされているインテグレーションを探している場合、これが優先されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 | 空 | 1.0.2 |
インテグレーション変数
すべてのインテグレーションに渡される環境変数のリスト。インテグレーションに同じ名前の既存の設定オプションがすでにある場合、この環境変数が優先されます。
infrastructureエージェント1.24.1 passthrough_environment以降では、変数名の正規表現がサポートされています。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| []string | 空 |
YAML属性としての例(エージェントの設定ファイル内、デフォルトで/etc/newrelic-infra.ymlにあります):
passthrough_environment: - HOST - PORT - NRIA_.*環境変数としての例:
NRIA_PASSTHROUGH_ENVIRONMENT="HOST,PORT,NRIA_.*"Windowsホストの場合:PATHEXTは MS Windows環境変数です。この機能は、すべてのコマンドラインから実行可能なファイルにどの拡張子がマークされているかを判断します。これにより、一般的なFlexインテグレーションで「... はコマンドレット、関数、スクリプトファイルの名前として認識されません...」というエラーを解決できます。
passthrough_environment: - PATHEXTこのエージェントにより、インテグレーションプロトコルのバージョン3のエンティティ名(したがってキー)のループバックアドレスの置換が自動的に有効になります。プロトコルのバージョン2を使用しており、この動作が必要な場合は、 entityname_integrations_v2_updateオプションを有効にします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
| 1.2.15 |
この設定パラメーターをtrueに設定すると、エージェントはHTTPポート(デフォルトでは8001)を開き、New RelicStatsDバックエンドからデータを受信します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
この値を設定すると、エージェントはHTTPServerPortでリッスンを開始し、New Relic StatsDバックエンドからデータを受信します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
|
New Relic StatsDバックエンドからデータを受信するためのhttpサーバーのポートを設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
この間隔中に情報を報告していないエンティティを削除するプロセスを開始します。
有効な時間単位:s(秒)、 m(分)、 h(時間)。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
|
例:
1hホスト上に多数のプロセスがある場合、またはインテグレーション全体で収集された大量のデータがある場合、エージェントキューがオーバーランする可能性があります。キューがいっぱいになってもエラーメッセージが表示されないようにするには、キューの深さを増やします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
インテグレーションSDK同期の永続ストレージとして使用される一時ディレクトリを定義します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
|
infrastructureエージェント以外のソース(OpenTelemetry CollectorやPrometheusノードエクスポータなど)からホストをインストゥルメントされており、infrastructureエージェントオンホストインテグレーションを引き続き使用して他のインフラストラクチャサービスを監視したい場合は、この設定を使用します。有効にすると、エージェントはホストのメタデータで修飾されたホストインベントリとインテグレーションテレメトリー(イベントメトリクスとインベントリ)を報告しますが、ホストメトリクス(CPU、メモリ、ディスク、ネットワーク、プロセス)は無効になります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
インベントリ変数
キャッシュされたインベントリがこの値より古くなった場合(たとえば、エージェントがオフラインの場合)、エージェントは自動的にデルタストアを削除して再作成します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
|
trueに設定すると、インベントリの非同期処理が有効になり、より大きなインベントリペイロードを処理できるようになります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| bool |
|
エージェントによって無視されるインベントリパスのリスト。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| string[] | 空のリスト |
YAML属性としての例:
ignored_inventory: - files/config/stuff.bar - files/config/stuff.foo環境変数としての例:
NRIA_IGNORED_INVENTORY="files/config/stuff.bar,files/config/stuff.foo"Linux変数
エージェントプロセスのpidファイルが作成されるLinux上の場所。これは起動時に使用され、エージェントの他のインスタンスが実行されていないことを確認します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
| 1.0.2 |
trueの場合、ホスト仮想メモリの定式化では、SReclaimableが使用可能なメモリとみなされます。それ以外の場合は、 SReclaimableは使用済みメモリの一部とみなされます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
変数のロギング
ログは、infrastructureエージェントロガーを設定するために使用されるキーの値マップです。YAML属性としての例:
log: file: '/var/log/newrelic-infra/newrelic-infra.log' level: debug forward: true stdout: false環境変数としての例:
NRIA_LOG_FILE='/var/log/newrelic-infra/newrelic-infra.log'NRIA_LOG_LEVEL='smart'NRIA_LOG_FORWARD='false'NRIA_LOG_STDOUT='true'ログのファイルパスを定義します。
デフォルトのインストレーションではログディレクトリが作成され、このファイルパス値がfile設定オプションに設定されます。このログディレクトリは、以下に示すようにOSごとに異なります。
ログのファイルパスをカスタマイズするには、この設定オプションを変更します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 | 以下を参照してください* |
デフォルトのパス:
Linux:定義されていない場合は、標準出力にのみログが記録されます。
Windows、エージェントバージョン 1.0.944以上:
C:\%ProgramData%\New Relic\newrelic-infra\newrelic-infra.logディレクトリを作成できない場合:
C:\Program Files\New Relic\newrelic-infra\newrelic-infra.log
ログレベルを定義します。使用可能な値:
info:レベルエラー、警告、情報のログメッセージを表示します。smart:スマート詳細モードを有効にします。スマート詳細モードでは、エラーがログに記録されると、最後のsmart_level_entry_limitデバッグメッセージがログに記録されます。debug:エラー、警告、情報、デバッグレベルのログメッセージを表示します。trace:すべてのログメッセージが表示されます。重要
トレースレベルのログ記録では、大量のデータが迅速に生成される可能性があります。問題を再現するために必要な期間のみエージェントをトレースモードで実行し、
level: infoを設定してエージェントを再起動し、詳細ログを無効にします。あるいは、level:smartを設定すると、スマート詳細モードが有効になります。YMLオプション名
環境変数
タイプ
デフォルト
バージョン
levelNRIA_LOG_LEVEL文字列
未設定
ログ出力形式を定義します。使用可能な値:
text:ログエントリごとに1行のプレーンテキスト出力。json:ログエントリごとに1行のJSON形式出力。YMLオプション名
環境変数
タイプ
デフォルト
バージョン
formatNRIA_LOG_FORMAT文字列
text
エージェントログをログUIに転送できるようにします。無効にするには、この設定オプションをfalseに設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
デフォルトでは、すべてのログは標準出力とログファイルの両方に表示されます。標準出力のログを無効にするには、この設定オプションをfalseに設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
smart_level_entry_limit エラーがログに記録されるときにログに記録される過去のデバッグメッセージの数を指します。たとえば、制限が5に設定されている場合、デバッグログはエラーがログに記録されるまでメモリにキャッシュされ、その時点で過去の5つのデバッグメッセージもログに記録されます。
重要
この設定オプションは、 level がsmartに設定されている場合(スマートレベルが有効な場合)にのみ使用されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
バージョンv1.28.0以降では、組み込みのログローテーション機能を使用できます。デフォルトでは、ログローテーションは無効になっています。これを有効にするには、 max_size_mbオプションでログファイルの最大サイズを指定する必要があります。infrastructureエージェントのログファイルがそのサイズに達すると、現在のログファイルが新しいファイルにローテーションされます。
log: level: info file: /var/log/newrelic-infra/newrelic-infra.log rotate: max_size_mb: 1000 # Required max_files: 5 # Optional compression_enabled: true # Optional file_pattern: YYYY-MM-DD_hh-mm-ss.log # Optionalmax_size_mb infrastructureエージェントログファイルの最大サイズをメガバイト単位で指定します。ファイルがこのサイズに達すると、現在のログは新しいファイルにローテーションされます。max_size_mbが0の場合、組み込みのログローテーションは無効になります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
max_files 保存されるアーカイブログファイルの数を定義します。この値を超えると、古いファイルが削除されます。max_filesが0の場合、ファイル数の制限は無効になります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
compression_enabledをtrueに設定すると、ログファイルの圧縮を有効にできます。圧縮を有効にすると、ローテーションされたファイルはgzip形式になり、ディスク容量の使用量が少なくなります。
重要
ログのローテーション中に圧縮が有効になっていると、特にmax_size_mb値が1000より大きい場合に、エージェントのCPU使用率が増加する可能性があります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
file_pattern アーカイブされたログファイルの名前形式を指定します。デフォルトでは、新しいファイル名には次の名前パターンが使用されます:original-file_YYYY-MM-DD_hh-mm-ss.log 。
次のtimestampフィールドを使用してファイル名パターンをカスタマイズできます。
YYYY: YearMM: MonthDD: Dayhh: Hourmm: Minutess: Secoundエージェントは、これらのtimestampフィールドをファイルローテーションの時刻に自動的に置き換えます。例を以下に示します。
log:level: infofile: /var/log/newrelic-infra/newrelic-infra.logrotate:max_size_mb: 1000file_pattern: rotated.YYYY-MM-DD_hh-mm-ss.logYMLオプション名
環境変数
タイプ
デフォルト
バージョン
file_patternNRIA_LOG_ROTATE_FILE_PATTERN文字列
file_YYYY-MM-DD_hh-mm-ss.file_extension
ヒント
infrastructureエージェントバージョン1.28.0では、ロギング設定における下位互換性が改善されました。レガシー設定とそれを新しい構造にマッピングする方法については、 github のドキュメントを参照してください。
メトリクス変数
カスタムアトリビュートとは、infrastructureエージェントからのデータに注釈を付けるために使用されるキーの値のペア(他のツールのタグに似ています)です。このメタデータを使用して、エンティティをフィルタリングしたり、結果をグループ化したり、データに注釈を付けたりすることができます。たとえば、マシンの環境(ステージングまたは本番)、マシンがホストするサービス(ログインサービスなど)、またはそのマシンを担当するチームなどを示すことができます。
ヒント
エージェントは、Amazon Elastic Compute Cloud(Amazon EC2)タグなど、デフォルト属性の一部として環境に関する多くの詳細を収集します。
YMLオプション名 | 環境変数 | タイプ |
|---|---|---|
|
| map[string]interface{} |
カスタムアトリビュートのリストを使用して、このエージェントインスタンスからのデータに注釈を付けます。キーと値はコロン:(例:KEY: VALUE)で区切り、各キーの値のペアは改行で区切ります。キーにはスラッシュ/を除く有効なYAMLを使用できます。値にはスペースを含む任意のYAML文字列を指定できます。キーをlabel.で始めると、そのホストが異なるcloud環境で実行されていても、 cloudタグまたはcloudラベルがタグの組み合わせたデコレーション内でキーと対話する可能性がある場合でも、キーはそのまま残ります。対照的に、これらの環境で実行している場合や、infrastructureエージェントからのデータとクラウドモニタリングを組み合わせている場合は、 custom_labelsにgcp.またはazure.というプレフィックスが付けられる場合があります。
YAML属性としての例:
custom_attributes: label.environment: production label.service: login service label.team: alpha-team環境変数としての例:
NRIA_CUSTOM_ATTRIBUTES='{"label.customAttribute_1":"SOME_ATTRIBUTE","label.customAttribute_2": "SOME_ATTRIBUTE_2"}'カスタムアトリビュートによるNRQLフィルタリングの例:
FROM SystemSample SELECT * WHERE label.environment = 'production'重要
infrastructureエージェントバージョン 1.12.0以降が必要です。 2020 年7月20日より前に作成されたアカウント、または新しいガイド付きインストールを使用してインストールされたinfrastructureエージェントでは、この変数がデフォルトで有効になっています。
New Relicへのプロセスメトリクスの送信を有効にします。
デフォルトでは、infrastructureエージェントはOSのプロセスに関するデータを送信しません。metrics_process_sample_rateが-1に設定されていない限り、エージェントはそのようなデータを引き続き収集します。
すべてのOSプロセスに関するメトリクスデータをレポートするには、 enable_process_metricsをtrueに設定します。無効にするには、 falseに設定します。
すべてのプロセスデータを送信する場合、New Relicに送信されるデータの量が増加する可能性があります。監視するプロセスを調整するには、 include_matching_metricsまたはexclude_matching_metricsを設定します。
デフォルトでは、メモリ使用量が少ないプロセスはサンプリングから除外されます。詳細については、 disable-zero-mem-process-filterを参照してください。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
有効にすると、プロセスがコンテナ内で実行される場合、エージェントはプロセスサンプルをコンテナ情報でデコレーションします。
この情報には、コンテナ ID、コンテナ名、イメージ ID、イメージ名、コンテナラベルが含まれます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
| 1.55.0 |
重要
現在、この設定はOSのプロセスメトリクスにのみ適用されます。
New Relicに送信されるデータの量を制御するには、 include_matching_metricsを設定します。これにより、メトリクス属性の値に基づいてメトリクスデータの送信を制限できます。
メトリクスデータを含めるには、メトリクスの属性のリテラル値または部分値を定義します。たとえば、 process.nameが正規表現「^java」に一致するすべてのプロセスのhost.process.cpuPercentを送信するように選択できます。
この例では、実行可能ファイルと名前を使用してプロセスメトリクスを含めます。
include_matching_metrics: # You can combine attributes from different metrics process.name: - regex "^java" # Include all processes starting with "java" process.executable: - "/usr/bin/python2" # Include the Python 2.x executable - regex "\\System32\\svchost" # Include all svchost executablesいずれかの値にコマンドライン引数を含める必要がある場合は、 strip_command_lineをfalseに設定します(機密情報の漏洩を防ぐために、infrastructureエージェントはデフォルトでCLI引数を削除します)。
同じアイテムにinclude_matching_metricsとexclude_matching_metricsの両方が存在する場合は、前者が優先されます。
include_matching_metrics をKubernetesインテグレーションの環境変数として設定するには、それをenv:オブジェクト内のマニフェストに追加します。
env: - name: NRIA_INCLUDE_MATCHING_METRICS value: | process.name: - regex "^java" process.executable: - "/usr/bin/python2" - regex "\\System32\\svchost"デフォルト
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| metric.attribute: - regex "pattern" - "string" - "string-with-wildcard*" |
重要
現在、この設定はOSのプロセスメトリクスにのみ適用されます。
New Relicに送信されるデータの量を制御するには、 exclude_matching_metricsを設定します。これにより、メトリクス 属性の値に基づいてメトリクスデータの送信を制限できます。
メトリクスデータを除外するには、メトリクスの属性のいずれかに対してリテラル値または部分値を定義します。たとえば、 process.nameが正規表現「^java」に一致するすべてのプロセスのhost.process.cpuPercentを送信しないように選択できます。
この例では、実行可能ファイルと名前を使用してプロセスメトリクスを除外します。
exclude_matching_metrics: # You can combine attributes from different metrics process.name: - regex "^java" # Exclude all processes starting with "java" process.executable: - "/usr/bin/python2" # Exclude the Python 2.x executable - regex "\\System32\\svchost" # Exclude all svchost executablesexclude_matching_metricsをKubernetesインテグレーションの環境変数として設定するには、それをenv:オブジェクト内のマニフェストに追加します。
env: - name: NRIA_EXCLUDE_MATCHING_METRICS value: | process.name: - regex "^java" process.executable: - "/usr/bin/python2" - regex "\\System32\\svchost"デフォルト
1.57.0
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| metric.attribute: - regex "pattern" - "string" - "string-with-wildcard*" |
ネットワークインターフェースフィルター設定を使用すると、未使用または使用する予定のないネットワークインターフェースをinfrastructureエージェントから非表示にすることができます。これにより、リソースの使用量、作業、データ内のノイズを削減できます。
重要
この構成設定では環境変数はサポートされていません。
設定では、次のいずれかのパターンに従う特定の文字列または数字の並びで始まるインターフェースを検索できる単純なパターンマッチングメカニズムが使用されます。
{name}[other characters]``prefixオプションを使用して名前を指定します[number]{name}[other characters]``index-1オプションを使用して名前を指定しますNew Relic Infrastructureは、 LinuxとWindows両方で使用できる、厳選されたデフォルトリストを実装しています(編集可能)。
YMLオプション名
環境変数
タイプ
デフォルト
バージョン
network_interface_filtersサポートされていない
map[string][]string
1.0.220
Linuxのデフォルトのネットワークインタフェースフィルター:
dummy、lo、vmnet、sit、tun、tapで始まるネットワークインタフェース、またはvethtun含むネットワークインタフェース、またはtap次の例(設定ファイルに追加)は、デフォルトのフィルターを上書きします。これにより、
dummyまたはloで始まるネットワークインターフェース、または数字の並びが先頭に付いて他の文字が続くtunを含むネットワークインターフェースは無視されます。network_interface_filters:prefix:- dummy- loindex-1:- tun
Windowsのデフォルトのネットワークインタフェースフィルター:
Loop、isatapで始まるネットワークインタフェース、またはLocal次の例(設定ファイルに追加)は、デフォルトのフィルターを上書きします。これにより、
Loopで始まるネットワークインターフェースは無視されます。network_interface_filters:prefix:- Loop
ZeroRSSFilterは、メモリを使用していないプロセスをサンプリングの対象から除外します。エージェントがこれらのプロセスをProcessSampleに含めるように、フィルターを無効にします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
| 1.0.832 |
プラグイン変数
ヒント
DisableAllPluginsをtrueに設定することですべての変数をすぐに無効にし、必要なオプションのみをオンにすることができます。
すべてのプラグインを無効にするには、このオプションをtrueに設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
CloudSecurityGroupsプラグインのサンプリング期間(秒)。最小値は30です。無効にするには、 -1に設定します。
重要
このプラグインは、エージェントがAWSインスタンスで実行されている場合にのみ有効です。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
Daemontoolsプラグインのサンプリング期間(秒)。最小値は10です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
Dpkgプラグインのサンプリング期間(秒)。最小値は30です。無効にするには、 -1に設定します。パラメーターが設定ファイルで明示的に設定されていない場合は、 DisableAllPluginsをtrueに設定して無効にすることができます。
重要
rootまたはprivileged実行モードおよびDebianベースのディストリビューションでのみ有効です。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
Facterプラグインのサンプリング期間(秒)。最小値は30です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
KernelModulesプラグインのサンプリング期間(秒)。最小値は10です。無効にするには、 -1に設定します。
重要
kernel_modules_refresh_sec rootまたはprivileged実行モードでのみ有効です。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
| 1.0.755 |
NetworkInterfaceプラグインのサンプリング期間(秒)。最小値は30です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
| 1.0.329 |
Rpmプラグインのサンプリング期間(秒)。最小値は30です。無効にするには、 -1に設定します。
重要
rpm_interval_sec RedHat、RedHat AWS、またはSUSEディストリビューションでは、エージェントがルートモードまたは特権モードで実行される場合にのみ有効です。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
SELinuxプラグインのサンプリング期間(秒)。最小値は30です。無効にするには、 -1に設定します。SelinuxEnableSemoduleがfalseに設定されている場合、このオプションは無視されます。詳細については、 SELinuxモジュールの無効化に関するトラブルシューティングドキュメントを参照してください。
重要
SELinux エージェントがルートモードで実行されている場合にのみ有効です。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
Sshdプラグインのサンプリング期間(秒)。最小値は10です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
| 1.0.755 |
Supervisorプラグインのサンプリング期間(秒)。最小値は10です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
Sysctlプラグインのサンプリング期間(秒)。最小値は30です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
Systemdプラグインのサンプリング期間(秒)。最小値は10です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
sysvプラグインのサンプリング期間(秒)。最小値は10です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
Upstartプラグインのサンプリング期間(秒)。最小値は10です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
Usersプラグインのサンプリング期間(秒)。最小値は10です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
| 1.0.755 |
スーパーバイザソケットの場所。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
| 1.0.2 |
PuppetのFacterのHOME環境変数を設定します。設定されていない場合は、現在のユーザーのホームディレクトリがデフォルトになります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
プロキシ変数
infrastructureエージェントバージョン1.3.1以降の場合、プロキシ設定の優先順位は次のとおりです。
NRIA_PROXYproxyHTTP_PROXYHTTPS_PROXY
システムによっては、設定されているファイアウォールルールにより、エージェントがNew Relicと通信するためにプロキシの使用が必要になる場合があります。その場合は、プロキシURLをhttps\://user:password\@hostname:portの形式で設定してください。HTTPまたはHTTPSが使用できます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 | 空 |
例:
https://proxy_user:access_10@proxy_01:1080trueに設定すると、 HTTPS_PROXYおよびHTTP_PROXY環境変数は無視されます。この設定は、エージェントが既存のシステムプロキシをスキップしてメトリクスコレクターに直接接続する必要がある場合に便利です。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
HTTPS_PROXYオプションが自己署名証明書を持つプロキシを参照する場合、このオプションはプロキシ証明書が使用可能なディレクトリへのパスを指定します。ディレクトリ内の証明書は.pem拡張子である必要があります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
HTTPS_PROXYオプションが自己署名証明書を持つプロキシを参照する場合、このオプションは証明書ファイルへのパスを指定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 文字列 |
trueに設定すると、プロキシがHTTPS接続を使用するように設定されている場合にのみ機能します:
HTTPSプロキシに有効な証明機関からの証明書がある場合。
ca_bundle_fileまたはca_bundle_dir設定プロパティに HTTPS プロキシ証明書が含まれている場合。YMLオプション名
環境変数
タイプ
デフォルト
バージョン
proxy_validate_certificatesNRIA_PROXY_VALIDATE_CERTIFICATESboolean
false1.3.0
次のプロキシ設定情報をインベントリとして送信します。
HTTPS_PROXYHTTP_PROXYproxy ca_bundle_dirca_bundle_fileignore_system_proxyproxy_validate_certificatesYMLオプション名
環境変数
タイプ
デフォルト
バージョン
proxy_config_pluginNRIA_PROXY_CONFIG_PLUGINboolean
true1.3.0
プロキシ設定で問題が発生した場合は、「プロキシに関するトラブルシューティング」を参照してください。
サンプル変数
ネットワークサンプルのサンプルレート(秒)。最小値は10です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
プロセスサンプルのサンプルレート(秒)。最小値は20です。プロセスサンプルを完全に無効にするには、 metrics_process_sample_rateを-1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
ストレージサンプルのサンプルレート(秒)。最小値は5です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
システムサンプルのサンプルレート(秒)。最小値は5です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
NFSストレージサンプルのサンプルレート(秒)。最小値は5です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
詳細なNFSメトリクス。有効にすると、エージェントはNFSメトリクスの完全なリストを提供します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
NTPオフセット変数
ntp_metrics 時間オフセットメトリクスを設定するために使用されるキーの値マップ。有効にすると、NTPホストリストが提供されている場合、エージェントはホストのntp offsetメトリクス(秒)を提供します。この値に応じて、指定されたNTPホストプールに対し、interval分ごとにチェックされます(デフォルトおよび最小値は 15 分)。間隔の間に、最後の既知のオフセットが報告されます。報告されたオフセットが数秒を超える場合、アラート条件、NRQLクエリ、ダッシュボードのデータギャップに問題が発生する可能性があります。
YAML属性としての例:
ntp_metrics: enabled: true pool: - time.cloudflare.com - time.google.com interval: 15 timeout: 10環境変数としての例:
NRIA_NTP_METRICS_POOL='time.cloudflare.com,time.google.com'NRIA_NTP_METRICS_ENABLED='true'NRIA_NTP_METRICS_INTERVAL='15'NRIA_NTP_METRICS_TIMEOUT='10'NTPオフセットメトリクスを有効または無効にするフラグ。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
NTPホストのリストを定義します。複数のホストが定義されている場合、それらすべてが照会されることになり、その平均値となるメトリクスが報告されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| []string | 空。パブリックNTPサーバーを確認してください。 |
指定されたプールからNTPオフセットを要求する間隔を分単位で定義します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
NTPホストへのrequestsのタイムアウトを秒単位で定義します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
|
セキュリティ変数
SEModuleを使用してインストールされたポリシーモジュールのバージョンを取得します。無効にすると、SELinuxプラグインはSEStatusのみを使用してステータスを取得します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
| 1.0.864 |
trueの場合、エージェントはProcessSampleのcommandLine属性からコマンド引数を削除します。
ヒント
これは機密情報の漏洩を防ぐためのセキュリティ対策です。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
| 1.0.149 |
ステータスエンドポイント変数
ローカルの健全性情報を提供するエージェント上のステータスサーバーを有効にします。利用可能なエンドポイントは次のとおりです。
メインステータスエンドポイントの例(エラーなし):
$curl http://localhost:8003/v1/status{ "checks": { "endpoints": [ { "url": "https://infrastructure-command-api.newrelic.com/agent_commands/v1/commands", "reachable": true }, { "url": "https://infra-api.newrelic.com/infra/v2/metrics", "reachable": true }, { "url": "https://identity-api.newrelic.com/identity/v1", "reachable": true }, { "url": "https://infra-api.newrelic.com/inventory", "reachable": true } ] }, "config": { "reachability_timeout": "10s" }}メインステータスエンドポイント(エラーあり):
$curl http://localhost:8003/v1/status{ "checks": { "endpoints": [ { "url": "https://staging-infra-api.newrelic.com/infra/v2/metrics", "reachable": false, "error": "endpoint check timeout exceeded" }, { "url": "https://infra-api.newrelic.com/infra/v2/metrics", "reachable": true }, { "url": "https://identity-api.newrelic.com/identity/v1", "reachable": true }, { "url": "https://infra-api.newrelic.com/inventory", "reachable": true } ] }, "config": { "reachability_timeout": "10s" }}エラーエンドポイントの例:
$curl http://localhost:18003/v1/status/errors{ "checks": { "endpoints": [ { "url": "https://staging-infra-api.newrelic.com/infra/v2/metrics", "reachable": false, "error": "endpoint check timeout exceeded" } ] }, "config": { "reachability_timeout": "10s" }}これはメインステータスエンドポイントに似ていますが、エラーのあるものだけに絞り込みます。
エンティティエンドポイントの例:
$curl http://localhost:8003/v1/status/entity{ "guid":"MMMMNjI0NjR8SU5GUkF8TkF8ODIwMDg3MDc0ODE0MTUwNTMy", "key":"your-host-name"}エージェント/ホストエンティティに関する情報を返します。エージェントがエージェント/ホストエンティティに関する情報をまだ持っていない場合は、応答ステータスコード「204」(「コンテンツなし」)が返されます。したがって、エージェントがエンティティデータを提供するまでに数回のrequestsが必要になる場合があります。
重要
ガイド付きインストールを使用する場合、この設定はデフォルトで有効になります。これは、エージェントのインストレーションが成功したことを確認するのに役立ちます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
| 1.19.0 |
ステータスサーバーエンドポイントのポートを定義します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| 整数 |
| 1.19.0 |
Windows変数
Windows サービスプラグインのサンプリング期間(秒)。最小値は10です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
Windows更新プラグインのサンプリング期間(秒)。最小値は10です。無効にするには、 -1に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| int64 |
|
プログラムファイルディレクトリとは異なるパスにデータを保存するパスを定義します。
%AppDir%/data:デルタデータを保存するために使用されます%AppDir%/user_data:ユーザーが生成したJSONファイル用の外部ディレクトリ%AppDir%/newrelic-infra.log:ログファイル設定オプションが定義されていない場合は、このディレクトリパスがデフォルトとして使用されます。YMLオプション名
環境変数
タイプ
デフォルト
バージョン
app_data_dirNRIA_APP_DATA_DIR文字列
Windows:
env(ProgramData)\New Relic\newrelic-infraLinux:該当なし
ホストにインストールされている緊急修正プログラムのリストを取得するWindows更新プラグインを有効にします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
| 1.0.274 |
trueに設定すると、エージェントはWindows WMI(Windowsのメトリクスを取得するエージェントのレガシーメソッド。例: StorageSampler)の使用が強制され、新しいメソッド(PDH ライブラリを使用するもの)が無効になります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
この設定オプションを使用すると、 newrelic-infra.exeプロセスの優先度を次のいずれかの値に上げることができます。
NormalIdleHighRealTimeBelowNormalAboveNormalYMLオプション名
環境変数
タイプ
デフォルト
バージョン
win_process_priority_classNRIA_WIN_PROCESS_PRIORITY_CLASS文字列
1.0.989
例:
Normal
ドライブ「A:」および「B:」がリムーバブルドライブとしてマップされている場合、Windowsエージェントがそれらのドライブを報告できるようにします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
有効にすると、 WindowsエージェントはネットワークメトリクスにGetIfEntry(32 ビットカウンター)の代わりにGetIfEntry2(64 ビットカウンター)を使用します。これにより、32 ビットカウンターがオーバーフローする可能性がある高帯域幅インターフェースのネットワーク統計がより正確になります。
ヒント
このフラグは下位互換性のために残されており、将来のリリースで削除される可能性があります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
trueに設定すると、WMIからプロセス情報が取得され、制限された環境でのクエリアクセスチェックがスキップされます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
|---|---|---|---|---|
|
| boolean |
|
HttpClient
バックエンド通信に使用するHTTPクライアントを設定します。
New Relicバックエンドへのすべてのrequestsに含めるカスタムHTTPヘッダー。
http: headers: "Proxy-Authorization": "myToken"YMLオプション名 | 環境変数 | タイプ | バージョン |
|---|---|---|---|
|
| キーの値マップ |
次のステップ
以下のことを検討してください。
- エージェントの設定をさらに理解する。
- テンプレートを使用して設定ファイルを作成する。
- どのようにエージェントを管理するかを確認する。