インテグレーション用構成ファイルの仕様

New Relic Infrastructure インテグレーション は、実行可能ファイル、定義ファイル、構成ファイルの3つのファイルで構成されています。ここでは、そのうちの構成ファイルを作成する方法について説明しています。

この機能を利用できるかは契約しているサブスクリプションレベルによります。

構成ファイルのフォーマット

構成ファイルは、実行ファイルとその実行に必要なパラメータを指定する YAML 形式のファイルです。インスタンスが定義されていない場合、インテグレーションは実行されません。

以下は、インスタンスを1つ定義した構成ファイルの例です。

integration_name: com.myorg.nginx
instances:
  - name: nginx1.myorg.com-metrics
    command: metrics
    arguments:
      status_url: http://127.0.0.1/status​
    labels: 
      environment: production
      role: load_balancer

上記で強調表示されている項目については、以下の表で説明します。

項目 説明
integration_name 必須。ヘッダーです。実行する実行可能ファイルの識別に使用します。インテグレーション定義ファイルで指定された名前と正確に一致しなくてはなりません。
name 必須。このインテグレーションの呼び出しの名前です。インテグレーションが生成するログメッセージの識別に役立ちます。
command 必須。実行されるコマンドです。インテグレーションの定義ファイルで指定されたユニークなエイリアス名のいずれかと正確に一致する必要があります。
arguments 任意。YAML オブジェクトです。キーは引数名で、値は引数の値を示します。引数は、環境変数のセットとしてインテグレーションで利用されます。引数名は、環境変数として設定されるため、大文字に変換されます。値はそのまま渡されます。
labels 任意。YAML オブジェクトです。キーはラベル名、値はラベルの値です。

構成ファイルの例

以下は、2つの実行対象を指定している構成ファイルの例です。

integration_name: com.myorg.nginx
instances:
   - name: nginx1.myorg.com-metrics
     command: metrics
     arguments:
        status_url: http://127.0.0.1/status
     labels:
        environment: production
        role: load_balancer
   - name: nginx1.myorg.com-inventory
     command: metrics
     arguments:
        status_url: http://127.0.0.1/status
     labels:
        environment: production
        role: load_balancer

カスタムインテグレーションの完全な例については、インテグレーションの例をご覧ください。

ファイルの配置と有効化

インテグレーションファイルを配置して、有効にする方法については、インテグレーションを有効にするをご覧ください。