インフラストラクチャ・エージェントには、その動作を微調整するための の設定が多数用意されています 。ここでは
- すべての設定オプションを(YAMLと環境変数名の両方で)一覧表示します。
- 各設定の役割と使用するタイミングを説明します。
- 変数のタイプとデフォルト値(ある場合)を指定します。
- 最低限必要なエージェントのバージョンを該当するものを記載してください。
重要
シークレット管理を使用すると、統合の構成ファイルにプレーン テキストとして機密データ (パスワードなど) を書き込むことなく、機密データ (パスワードなど) を使用するようにエージェントのオンホスト統合をインフラストラクチャと構成できます。詳細については、 「シークレット管理」を参照してください。
まだNewRelicアカウントがありませんか?永久に無料でサインアップ します。
始めましょう
New Relic アカウント (永久に無料です)を作成し、 インフラストラクチャエージェント をインストールすると、お客様の環境に合わせてインフラストラクチャエージェントを設定することができます。
必要な設定はlicense_key
のみです。
これらすべての変数の使用方法の例については、 GitHub のサンプル構成テンプレートを参照してください。
環境変数
リストされている設定オプションの多くは、環境変数を使用して値を設定することもできます。環境変数は YAML 設定よりも優先されます。
重要
多くの場合、インフラストラクチャエージェントはホスト内のシステムサービスとして実行され、グローバルに管理されます(例: systemd
(Linux、Windows サービスの場合)、 launchd
(macOS の場合) など。 このセットアップで環境変数を使用して設定の変更を適用するには、これらの環境変数を設定し、infrastructureagent サービスが実行されている分離されたコンテキストに表示できるようにする必要があります。 これを行う方法はプラットフォームによって異なります。システム サービスに環境変数を追加する方法については、プラットフォームのサービス マネージャーのドキュメントを確認してください。
エージェント変数
New Relic アカウントのを指定します。 エージェントはこのキーを使用して、サーバーのメトリクスを New Relic アカウントに関連付けます。 この設定は、標準のインストレーション プロセスの一部として作成されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング |
例:
license_key: 1234567890abcdefghijklmnopqrstuvwxyz1234
FedRAMP エンドポイントを使用するかどうかを指定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
エージェントが使用できる論理プロセッサの数を指定します。この値を増やすことで、異なるコア間で負荷を分散することができます。
-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オプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 整数 |
|
クラウド変数
エージェントがクラウドインスタンスで実行されている場合、エージェントはクラウドタイプを検出し、基本的なメタデータを取得しようとします。 クラウドプロバイダーアカウントをNewRelicに接続するときに、メトリックを拡張クラウドメタデータ(カスタムリソースタグを含む)で強化することもできます。
クラウドの検出に失敗した場合に、エージェントが接続を再試行する回数を設定します。
エージェントの初期化中にクラウド検出が失敗した場合、エージェントはCloudRetryBackOffSec
秒待機した後に再試行します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 整数 |
| 1.2.6 |
エージェントがメタデータを破棄するまでの待ち時間を秒単位で設定します。この時間が経過すると、メタデータは失効し、エージェントは再びメタデータを取得します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 整数 |
| 1.2.6 |
クラウドの検出に失敗した場合に、エージェントがクラウドディテクションの再試行を行うまでの時間を秒単位で設定します。
エージェントの初期化中にクラウド検出が失敗した場合、エージェントはCloudMaxRetryCount
回再試行します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 整数 |
| 1.2.6 |
エージェントが実行されているクラウド プロバイダーを指定します。これがデフォルトとは異なる値に設定されている場合、エージェントは、データをバックエンドに送信する前に、クラウド プロバイダーからメタデータ (インスタンス ID) を正常に取得するまで待機します。
デフォルトの動作では、エージェントはクラウド プロバイダーの検出とメタデータの取得も試みますが、エージェントをブロックすることはありません。
許可された値: ""
、 "aws"
、 "azure"
、 "gcp"
、 "alibaba"
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング |
| 1.40.1 |
DisableCloudMetadata
に似ていますが、ホストエイリアスプラグインのクラウドメタデータの収集のみを無効にします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
| 1.0.220 |
クラウドメタデータの収集を無効にします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
ドッカー変数
キャッシュされたコンテナのメタデータが期限切れになり、エージェントが再度取得する必要が生じるまでの時間(秒単位)。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 整数 |
| 1.0.801 |
DockerクライアントのAPIバージョンを指定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング |
|
ファイルシステム変数
エージェントがサポートしているファイルシステムの種類のリストです。この値は、デフォルトのリストのサブセットである必要があり、デフォルトのリストにない項目は破棄されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| []文字列 | Linux: ウィンドウズ: | 1.0.220 |
StorageSample
データを収集するときにエージェントが無視するストレージデバイスのリスト。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| []文字列 | 1.0.220 |
YAML属性の例。
file_devices_ignored: - sda1 - sda2
環境変数としての例
FILE_DEVICES_IGNORED="sda1,sda2"
ホスト名の変数
レポート用に自動生成されたホスト名を上書きします。これは、同じ名前のホストが複数ある場合に便利です。インフラストラクチャモニタリングでは、ホスト名を各ホストの一意の識別子として使用します。この値は、エンティティ名のループバックアドレスの置換にも使用されることに注意してください。
詳しくは、 エンティティ名解決の仕組み についてのドキュメントをご覧ください。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング | 空 | 1.0.266 |
例:
display_name: teslaOne
true
の場合、ホストのアドレスの逆引き参照を実行することにより、完全なホスト名が解決されます。それ以外の場合は、Linuxではhostnameコマンドを使用して、WindowsではレジストリのTCP/IPパラメータから取得されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
設定されている場合、これは完全なホスト名に対して報告される値であり、そうでない場合は、エージェントは通常の検索動作を行います。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング | 1.0.1015 |
例:
my.custom-hostname.co.org
設定されている場合、これはホスト名に対して報告される値です。そうでない場合、エージェントは通常の検索動作を行います。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング | 1.0.1015 |
例:
my.custom-hostname
インストール変数
エージェントがキャッシュ、インベントリ、統合などのファイルを保存するディレクトリ。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング | Linux: ウィンドウズ: | 1.0.2 |
インテグレーションの設定ファイルを含むディレクトリ。
各統合には、デフォルトで<integration_name>-config.yml
という名前の独自の構成ファイルがあり、エージェントが初期化時にロードする事前定義された場所に配置されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング | Linux: ウィンドウズ: | 1.0.2 |
統合をインストールするためのカスタムパスを指定します。これにより、統合をagent_dir
の外部にインストールできます。エージェントがインストール済みの統合を探している場合は、これが優先されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング | エンプティ | 1.0.2 |
積算変数
すべての統合に渡される環境変数のリストです。インテグレーションに同じ名前の既存の設定オプションがある場合は、環境変数が優先されます。
インフラストラクチャエージェント1.24.1以降、 passthrough_environment
は変数名の正規表現をサポートします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| []文字列 | エンプティ |
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オプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
| 1.2.15 |
この構成パラメーターをtrue
に設定すると、エージェントはHTTPポート(デフォルトでは8001
)を開き、NewRelicStatsDバックエンドからデータを受信します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
この値を設定すると、エージェントはHTTPServerPort
のリッスンを開始して、NewRelicStatsDバックエンドからデータを受信します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング |
|
New Relic StatsD バックエンドからデータを受信するための http サーバーのポートを設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 整数 |
|
この期間に情報が報告されていないエンティティの削除処理を開始します。
有効な時間単位: s
(秒)、 m
(分)、およびh
(時間)。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング |
|
例:
1h
ホスト上に多数のプロセスがある場合、または統合全体で収集された大量のデータがある場合、エージェント キューがオーバーランする可能性があります。キューの深さを増やして、キューがいっぱいになることによるエラー メッセージを防ぎます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| int64 |
|
統合 SDK 同期の永続ストレージとして使用される一時ディレクトリを定義します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング |
|
インフラストラクチャ エージェント以外のソース ( OpenTelemetry Collector や Prometheus ノード エクスポータなど) からホストをインストゥルメントされており、他のインフラを監視するためにインフラストラクチャ オンホストエージェント統合を使用し続けたい場合は、この設定を使用します。ストラクチャサービス。 有効にすると、エージェントはホストのメタデータで修飾されたホスト インベントリと統合テレメトリー (イベント メトリクスとインベントリ) を報告しますが、ホスト メトリクス (CPU、メモリ、ディスク、ネットワーク、プロセス) は無効になります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
在庫変数
キャッシュされたインベントリがこの値よりも古くなった場合(エージェントがオフラインになった場合など)、エージェントは自動的にデルタストアを削除し、再作成します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング |
|
true に設定すると、インベントリの非同期処理が有効になり、より大きなインベントリ ペイロードを処理できるようになります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| bool |
|
エージェントが無視するインベントリパスのリストです。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 文字列[] | 空のリスト |
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オプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
変数のロギング
Log は、インフラストラクチャ エージェント ロガーの構成に使用されるキーと値のマップです。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オプション名
環境変数
タイプ
デフォルト
バージョン
level
NRIA_LOG_LEVEL
ストリング
設定されていません
ログの出力形式を定義します。利用可能な値
text
:プレーンテキスト出力、ログエントリごとに1行。json
:JSON形式の出力、ログエントリごとに1行。YMLオプション名
環境変数
タイプ
デフォルト
バージョン
format
NRIA_LOG_FORMAT
ストリング
text
エージェント ログをログ UI に転送できるようにします。無効にするには、この構成オプションを false
に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
デフォルトでは、すべてのログは標準出力とログファイルの両方に表示されます。標準出力でログを無効にするには、この構成オプションをfalse
に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
smart_level_entry_limit
エラーがログに記録されるときにログに記録される以前のデバッグ メッセージの数を指します。 たとえば、制限が5
に設定されている場合、デバッグ ログはエラーがログになるまでメモリにキャッシュされ、その時点で以前の 5 つのデバッグ メッセージもログになります。
重要
この構成オプションは、 level
がsmart
(スマートレベルが有効)に設定されている場合にのみ使用されます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 整数 |
|
バージョンv1.28.0以降では、組み込みのログローテーション機能を使用できます。デフォルトでは、ログローテーションは無効になっています。これを有効にするには、 max_size_mb
オプションを使用してログファイルの最大サイズを指定する必要があります。インフラストラクチャエージェントのログファイルがそのサイズに達すると、現在のログファイルが新しいファイルにローテーションされます。
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 # Optional
max_size_mb
インフラストラクチャエージェントログファイルの最大サイズをメガバイト単位で指定します。ファイルがこのサイズに達すると、現在のログが新しいファイルにローテーションされます。max_size_mb
が0
の場合、組み込みのログローテーションは無効になります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 整数 |
|
max_files
保持するアーカイブログファイルの数を定義します。この値を超えると、古いファイルが削除されます。max_files
が0
の場合、ファイル数の制限は無効になります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 整数 |
|
compression_enabled
をtrue
に設定すると、ログファイルの圧縮を有効にできます。圧縮がアクティブになっている場合、ローテーションされたファイルはgzip
形式になり、使用するディスク容量が少なくなります。
重要
ログローテーション中に圧縮が有効になっている場合、特にmax_size_mb
値が1000
より大きい場合、エージェントのCPU使用率が増加する可能性があります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
file_pattern
アーカイブされたログファイルの名前の形式を指定します。デフォルトでは、新しいファイル名は次の名前パターンを使用します: original-file_YYYY-MM-DD_hh-mm-ss.log
。
次のタイムスタンプフィールドを使用して、ファイル名パターンをカスタマイズできます。
YYYY
: 年MM
: 月DD
: 日hh
: 時間mm
: 分ss
:セカンドエージェントは、これらのタイムスタンプフィールドをファイルローテーションの時刻に自動的に置き換えます。例えば:
log:level: infofile: /var/log/newrelic-infra/newrelic-infra.logrotate:max_size_mb: 1000file_pattern: rotated.YYYY-MM-DD_hh-mm-ss.logYMLオプション名
環境変数
タイプ
デフォルト
バージョン
file_pattern
NRIA_LOG_ROTATE_FILE_PATTERN
ストリング
file_YYYY-MM-DD_hh-mm-ss.file_extension
ヒント
インフラストラクチャ エージェント バージョン 1.28.0 では、ロギング構成の下位互換性の向上が導入されました。従来の設定と、それらを新しい構造にマッピングする方法を理解するには、 GitHub ドキュメントを参照してください。
メトリクス変数
カスタム属性は、インフラストラクチャ エージェントからのデータに注釈を付けるために使用されるキーと値のペア (他のツールのタグと同様) です。このメタデータを使用して、エンティティをフィルタリングし、結果をグループ化し、データに注釈を付けることができます。たとえば、マシンの環境 (ステージングまたは運用)、マシンがホストするサービス (ログイン サービスなど)、またはそのマシンを担当するチームを指定できます。
ヒント
エージェントは、 デフォルトの属性 の一部として、 Amazon Elastic Compute Cloud(Amazon EC2)タグ を含む、お客様の環境に関する多くの詳細情報を収集します。
YMLオプション名 | 環境変数 | タイプ |
---|---|---|
|
| map[string]interface{} |
カスタムアトリビュートのリストを使用して、このエージェントインスタンスからのデータに注釈を付けます。 キーと値はコロン:
で区切ります (例: KEY: VALUE
。また、各キーと値のペアは改行で区切ります。 キーには、スラッシュ/
を除く有効な YAML を使用できます。 値には、スペースを含む任意の YAML 文字列を指定できます。 キーをlabel.
で開始すると、そのホストが異なるクラウド環境で実行され、クラウド タグまたはクラウド ラベルがタグの組み合わせによる装飾でキーとやり取りする場合でも、キーはそのまま残ります。 対照的に、これらの環境で実行している場合や、インフラストラクチャ エージェントからのデータとクラウド モニタリングを組み合わせる場合は、 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'
重要
インフラストラクチャエージェントバージョン 1.12.0 以降が必要です。 2020 年 7 月 20 日より前に作成されたアカウント、および/または新しいガイド付きインストールを使用してインストールされたインフラストラクチャ エージェントでは、この変数がデフォルトで有効になっています。
プロセスメトリクス の New Relic への送信を有効にします。
デフォルトでは、インフラストラクチャエージェントはオペレーティングシステムのプロセスに関するデータを送信しません。 metrics_process_sample_rate
が-1
に設定されていない限り、エージェントは引き続きそのようなデータを収集します。
すべてのオペレーティングシステムのプロセスに関するメトリックデータをレポートするには、 enable_process_metrics
をtrue
に設定します。無効にするには、 false
に設定します。
すべてのプロセス データを送信すると、New Relic に送信されるデータの量が増加する可能性があります。 監視するプロセスを微調整するには、 include_matching_metrics
またはexclude_matching_metrics
を構成します。
デフォルトでは、低メモリを使用しているプロセスはサンプリングの対象から除外されます。詳しくは、 disable-zero-mem-process-filter をご覧ください。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
有効にすると、プロセスがコンテナ内で実行される場合、エージェントはプロセス サンプルをコンテナ情報で装飾します。
この情報には、コンテナ ID、コンテナ名、イメージ ID、イメージ名、コンテナ ラベルが含まれます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
| 1.55.0 |
重要
現在のところ、この設定はオペレーティングシステムのプロセスメトリクスにのみ適用されます。
include_matching_metrics
を設定することで、New Relicに送信されるデータの量を制御できます。これにより、メトリック属性の値に基づいてメトリックデータの送信を制限できます。
メトリックの属性のいずれかにリテラル値または部分値を定義することにより、メトリックデータを含めます。たとえば、 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に設定します(インフラストラクチャエージェントは、シークレットが漏洩しないように、デフォルトで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"パターン" -"文字列" -"文字列-ワイルドカード*付き" |
重要
現在のところ、この設定はオペレーティングシステムのプロセスメトリクスにのみ適用されます。
exclude_matching_metrics
を構成することで、 New Relicに送信されるデータの量を制御できます。これにより、メトリクス プロパティの値に基づいてメトリクス データの送信を制限できます。
メトリクス データを除外するには、メトリクスのプロパティのいずれかに対してリテラル値または部分値を定義します。 たとえば、 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 executables
exclude_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"パターン" -"文字列" -"文字列-ワイルドカード*付き" |
ネットワーク・インターフェース・フィルター設定を使用すると、使用していないネットワーク・インターフェースや興味のないネットワーク・インターフェースをインフラストラクチャ・エージェントから隠すことができます。これにより、リソースの使用、作業、データのノイズを減らすことができます。
重要
この設定では、環境変数はサポートされていません。
この設定では、シンプルなパターンマッチングメカニズムを使用しており、いずれかのパターンに続く特定の文字または数字のシーケンスで始まるインターフェースを探すことができます。
{name}[other characters]
、ここでprefix
オプションを使用して名前を指定します[number]{name}[other characters]
、ここでindex-1
オプションを使用して名前を指定しますNew Relic のインフラでは、厳選されたデフォルトのフィルターリストが実装されており、 Linux と Windows の両方で利用でき、お客様が変更することも可能です。
YMLオプション名
環境変数
タイプ
デフォルト
バージョン
network_interface_filters
対応していません
マップ[文字列][]文字列
1.0.220
Linuxのデフォルトのネットワークインターフェイスフィルタ。
dummy
、lo
、vmnet
、sit
、tun
、tap
、またはveth
tun
またはを含むネットワークインターフェース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オプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
| 1.0.832 |
プラグインの変数
ヒント
DisableAllPlugins
をtrue
に設定することですべての変数をすばやく無効にし、必要なオプションのみをオンにすることができます。
すべてのプラグインを無効にするには、このオプションをtrue
に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
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'sFacterのHOME
環境変数を設定します。定義されていない場合、デフォルトで現在のユーザーのホームディレクトリになります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング |
代理変数
インフラストラクチャーエージェントのバージョン1.3.1以降では、プロキシ設定の優先順位が
NRIA_PROXY
proxy
HTTP_PROXY
HTTPS_PROXY
お使いのシステムには、エージェントがプロキシを使用して New Relic と通信することを要求するファイアウォール ルールがある場合があります。その場合、プロキシ URL を https://user:password@hostname:port の形式で設定します。 HTTP または HTTPS にすることができます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング | エンプティ |
例:
https://proxy_user:access_10@proxy_01:1080
true
に設定すると、 HTTPS_PROXY
およびHTTP_PROXY
環境変数は無視されます。これは、エージェントがメトリックコレクターに直接接続し、既存のシステムプロキシをスキップする必要がある場合に役立ちます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
HTTPS_PROXY
オプションが自己署名証明書を持つプロキシを参照している場合、このオプションは、プロキシ証明書が使用可能なディレクトリへのパスを指定します。ディレクトリ内の証明書は、 .pem
拡張子で終わる必要があります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング |
HTTPS_PROXY
オプションが自己署名証明書を持つプロキシを参照している場合、このオプションは証明書ファイルへのパスを指定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ストリング |
true
に設定されている場合、プロキシがHTTPS接続を使用するように構成されていると、次の場合にのみ機能します。
HTTPS プロキシに有効な認証局からの証明書がある場合。
ca_bundle_file
またはca_bundle_dir
構成プロパティにHTTPSプロキシ証明書が含まれている場合。YMLオプション名
環境変数
タイプ
デフォルト
バージョン
proxy_validate_certificates
NRIA_PROXY_VALIDATE_CERTIFICATES
ブール値
false
1.3.0
以下のプロキシ設定情報をインベントリとして送信します。
HTTPS_PROXY
HTTP_PROXY
proxy ca_bundle_dir
ca_bundle_file
ignore_system_proxy
proxy_validate_certificates
YMLオプション名
環境変数
タイプ
デフォルト
バージョン
proxy_config_plugin
NRIA_PROXY_CONFIG_PLUGIN
ブール値
true
1.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オプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
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オプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
照会する NTP ホストのリストを定義します。複数のホストが定義されている場合、それらすべてが照会され、レポートされるメトリックはそれらの間の平均値になります。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| []文字列 | 空の。公開 NTP サーバーを確認してください。 |
提供されたプールから NTP オフセットを要求する間隔を分単位で定義します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 整数 |
|
NTP ホストに対する要求のタイムアウトを秒単位で定義します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 整数 |
|
セキュリティ変数
SEModule を使用してインストールされたポリシーモジュールのバージョンを取得します。無効にした場合、SELinuxプラグインはSEStatusを使ってステータスを取得するだけです。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
| 1.0.864 |
true
の場合、エージェントはProcessSample
のcommandLine
属性からコマンド引数を削除します。
ヒント
これは、機密情報の漏洩を防ぐためのセキュリティ対策です。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
| 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 (「コンテンツなし」) が返されます。したがって、エージェントがエンティティ データを提供するまでに、いくつかのリクエストが必要になる場合があります。
重要
ガイド付きインストールを使用する場合、この設定はデフォルトで有効になります。 これは、エージェントの注入が成功したことを確認するのに役立ちます。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
| 1.19.0 |
ステータス サーバー エンドポイントのポートを定義します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| 整数 |
| 1.19.0 |
Windows変数
Windowsサービスプラグインのサンプリング期間(秒単位)。最小値は10
です。無効にするには、 -1
に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| int64 |
|
Windows Updateプラグインのサンプリング期間(秒単位)。最小値は10
です。無効にするには、 -1
に設定します。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| int64 |
|
データをプログラムファイルのディレクトリとは別のパスに格納することを定義します。
%AppDir%/data
:デルタデータの保存に使用されます%AppDir%/user_data
:ユーザーが生成したJSONファイルの外部ディレクトリ%AppDir%/newrelic-infra.log
:ログファイル設定オプションが定義されていない場合は、このディレクトリパスをデフォルトとして使用します。YMLオプション名
環境変数
タイプ
デフォルト
バージョン
app_data_dir
NRIA_APP_DATA_DIR
ストリング
ウィンドウズ:
env(ProgramData)\New Relic\newrelic-infra
Linux: 適用されません
ホストにインストールされているHotfixの一覧を取得するWindows Updateプラグインを有効にします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
| 1.0.274 |
true
の場合、エージェントはWindows WMI(Windowsのメトリックを取得するためのエージェントのレガシーメソッド。たとえば、 StorageSampler
)を使用するように強制され、新しいメソッド(PDHライブラリを使用する)を無効にします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
この設定オプションを使用すると、 newrelic-infra.exe
プロセスの優先度を次のいずれかの値に上げることができます。
Normal
Idle
High
RealTime
BelowNormal
AboveNormal
YMLオプション名
環境変数
タイプ
デフォルト
バージョン
win_process_priority_class
NRIA_WIN_PROCESS_PRIORITY_CLASS
ストリング
1.0.989
例:
Normal
リムーバブルドライブとしてマップされている場合、WindowsエージェントがドライブA:
およびB:
を報告できるようにします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
true に設定すると、WMI からプロセス情報を取得し、制限された環境でのクエリ アクセス チェックをスキップします。
YMLオプション名 | 環境変数 | タイプ | デフォルト | バージョン |
---|---|---|---|---|
|
| ブール値 |
|
HTTPクライアント
バックエンド通信に使用するHTTPクライアントを構成します。
New Relic バックエンドへのすべてのリクエストに含めるカスタム HTTP ヘッダー。
http: headers: "Proxy-Authorization": "myToken"
YMLオプション名 | 環境変数 | タイプ | バージョン |
---|---|---|---|
|
| キーと値のマップ |
次は何ですか?
もできます。
- さらに理解を深めるために エージェントの構成 。
- テンプレートを使用して構成ファイルを作成します。
- エージェントを管理する方法をご覧ください 。