Ansibleによるインフラストラクチャエージェントの設定

New Relic の Ansible ロールを使用すると、New Relic CLI および New Relic Open Installation リポジトリを使用して New Relic Observability の取り組みを拡張できます。Ansible の使用方法については、 Ansible のドキュメントを参照してください。これはコミュニティの支援による取り組みです。

Ansibleを使ってインフラストラクチャエージェントを設定してみませんか？ New Relicアカウントを作成してください無料でご利用いただけます。クレジットカードは必要ありません。

重要

このロールは常に New Relic エージェントの最新リリースバージョンをインストールし、古いバージョンのインストールはサポートしません。

サンプルコード

New Relicでは、多くのOpsチームに共通するワークフローやツールを使用して、当社のインフラ監視エージェントをインストールするための構成管理サンプルコードを提供しています。これは基本的なAnsibleの役割であり、独自にカスタマイズしたワークフローを作成するための出発点として使用することを目的としています。

構成は、特定のセットアップと標準によって異なります。Ansible サンプルロールとその他の統合情報を表示するには、 Ansible Galaxy ドキュメントを参照してください。

互換性と要件

New Relic のインフラストラクチャ監視エージェントでの Ansible ロールには、サポートされているオペレーティングシステムが必要です。

Windows OS 用の Ansible に関するヘルプが必要な場合は、 Ansible ドキュメントサイトの「Windows ホストのセットアップ」を参照してください。

このロールは、Ansible Core 2.13、2.14、および Python 3.10 でテストされています。Ansible Core 2.10 より前のバージョンはサポートされていません。

AnsibleによるNew Relicのセットアップ

インストール

アンシブルギャラクシー

ギャラクシーへのリンク

bash

$ansible-galaxy install newrelic.newrelic_install

ansible.windows と ansible.utils がまだインストールされていない場合は、インストールされていることを確認します。

bash

$ansible-galaxy collection install ansible.windows ansible.utils

手動

ロールのローカルコピーを使用する場合は、リポジトリのクローンを作成し、プロジェクトルートで make を実行してこのリポジトリを ~/.ansible/roles/newrelic.newrelic_installにコピーします。これにより、ロールが Galaxy からインストールされたかのように動作できるようになります。

はじめに

ロール newrelic.newrelic_installの使用を開始するには:

その役割をプレイブックに盛り込む。
必要な変数をカスタマイズします。

インストール後、新規または既存のハンドブックに newrelic.newrelic_install ロールを含めます。インフラストラクチャエージェントをインストールするようにロールを構成する例を次に示します。

---
- name: Install New Relic
  hosts: all
  roles:
    - role: newrelic.newrelic_install
      vars:
        targets:
          - infrastructure
          - logs
        tags:
          foo: bar
  environment:
    NEW_RELIC_API_KEY: <API key>
    NEW_RELIC_ACCOUNT_ID: <Account ID>
    NEW_RELIC_REGION: <Region>

役割の設定変数

newrelic.newrelic_installロールの構成に使用できる変数は次のとおりです。

変数	必要とされている	説明
`targets`	必須	ホスト上で実行する対象のインストールのリスト。利用可能なオプションは次のとおりです。 `infrastructure` (Linux および Windows) `logs` (Linux および Windows) `apm-php` (Linux) `apm-nodejs` (Linux) `apm-dotnet` (Linux および Windows) `apm-java` (Linux) `apache` (Linux) `mssql` （ウィンドウズ） `mysql` (Linux) `nginx` (Linux)
`tags`	オプション	インストールに渡されるタグのキーと値のペア。
`install_timeout_seconds`	オプション	インストールタスクのタイムアウトを設定します。デフォルトのタイムアウトである 600 秒をオーバーライドします。
`verbosity`	オプション	インストールの詳細オプション (`debug` または `trace`) は、ホスト上のログファイルに詳細な出力を書き込みます。

初期設定

defaults/main.ymlで設定します。

cli_install_url
cli_install_download_location
target_name_map
verbosity_on_log_file_path_linux
verbosity_on_log_file_path_windows
default_install_timeout_seconds

環境変数

値は、ハンドブックの environment キーワードで設定されます。

NEW_RELIC_API_KEY （必要）
NEW_RELIC_ACCOUNT_ID （必要）
NEW_RELIC_REGION (オプション: 'US' または 'EU'、デフォルトは 'US')

さらに、オプションの HTTPS_PROXY 変数を設定して、インストールのプロキシを有効にすることができます。

NEW_RELIC_APACHE_STATUS_URL (オプション) Apache Web サーバーのステータスを確認するための URL。これは、Apache オンホスト統合のインストールを試行する前に、Apache Web サーバーがホスト上で実行されており、正常な状態であることを確認するために使用されます。デフォルトは次のとおりです。 http://127.0.0.1/server-status?auto

NEW_RELIC_MSSQL_DB_HOSTNAME (オプション) MS SQL サーバーが実行されているホスト名または IP。指定しない場合は、デフォルトで検出されたホスト名が使用されます。
NEW_RELIC_MSSQL_DB_PORT (オプション) MS SQL サーバーがリッスンするポート。デフォルトは 1433
NEW_RELIC_MSSQL_DB_USERNAME (オプション) MS SQL サーバーにアクセスするためのユーザー名。デフォルトは newrelicです。ドメインユーザーを使用する場合は、次の構文を使用します。 domain\user
NEW_RELIC_MSSQL_DB_PASSWORD (オプション) 指定された SQL またはドメインユーザーのパスワード。パスワードを指定しない場合は、ランダムなパスワードが生成されます。
NEW_RELIC_MSSQL_SQL_USERNAME (オプション) NEW_RELIC_MSSQL_DB_USERNAMEで指定された SQL ユーザーを作成するときに、 sqlcmd に渡されるオプションの資格情報のオーバーライド。省略した場合、デフォルトのログインユーザー名が使用されます。
NEW_RELIC_MSSQL_SQL_PASSWORD (オプション) NEW_RELIC_MSSQL_DB_USERNAMEで指定された SQL ユーザーを作成するときに、 sqlcmd に渡されるオプションの資格情報のオーバーライド。省略した場合は、デフォルトのログインパスワードが使用されます。
NEW_RELIC_MSSQL_ENABLE_BUFFER_METRICS (オプション) バッファープールメトリックの収集を有効にします。デフォルトは true
NEW_RELIC_MSSQL_ENABLE_RESERVE_METRICS (オプション) データベースパーティションの予約スペースの収集を有効にします。デフォルトは true

NEW_RELIC_MYSQL_PORT (オプション) 指定しない場合、デフォルトは 3306 になります。
NEW_RELIC_MYSQL_USERNAME (オプション) 他に指定がない場合、デフォルトは newrelic になります。これは、 mysql 統合がセットアップするユーザー名であり、データレポートの目的で統合の構成ファイル (例: mysql-config.yml) にも設定されます。詳細については、「MySQL 統合」を参照してください。
NEW_RELIC_MYSQL_PASSWORD (オプション) NEW_RELIC_MYSQL_USERNAMEで指定されたユーザーのパスワード。詳細については、「MySQL 統合」を参照してください。
NEW_RELIC_MYSQL_ROOT_PASSWORD (必須) mysql 統合は、適切な認証情報を作成するために mysql に接続する必要があります。

詳細については、 ansible のリモート環境を参照してください。

重要な注意点

logs ターゲットには infrastructureが必要であり、 infrastructureを指定せずに logs を指定するとエラーがスローされます。
apm-nodejs エージェントのインストールは、 PM2によって管理されるアプリでのみサポートされます。 npm や yarn などのパッケージマネージャーを使用するか、他のインストールパスを介してエージェントをインストールするには、ドキュメントを参照してください。
Windows の apm-dotnet エージェントのインストールは、 IISによってホストされるアプリでのみサポートされます。Linux インストールは、 systemd サービスとして実行される .NET アプリケーションでのみサポートされます。
apm-java エージェントのインストールは、Tomcat、Wildfly/Jboss、Jetty (スタンドアロン) で実行される Java をサポートします。
次の統合では、インフラストラクチャエージェントをインストールする必要があります。
- apm-java
- apache
- mssql
- mysql
- nginx

追加のサンプルプレイブック

- name: Install New Relic
  hosts: all
  roles:
    - role: newrelic.newrelic_install
      vars:
        targets:
          - infrastructure
          - logs
          - apm-php
        tags:
          foo: bar
        install_timeout_seconds: 1000
        verbosity: debug
  environment:
    NEW_RELIC_API_KEY: <API key>
    NEW_RELIC_ACCOUNT_ID: <Account ID>
    NEW_RELIC_REGION: <Region>
    NEW_RELIC_APPLICATION_NAME: "My Application"
    HTTPS_PROXY: "http://my.proxy:8888"

この機械翻訳は参考用に提供されます。