以下のテキストを日本語に翻訳しました。

New Relic Ansible ロール

newrelic.newrelic_install は、あなたの New Relic の観察性を向上させるための Ansible ロール です。このロールは、New Relic CLI および New Relic Open Installation リポジトリ を使用して実現されます。

注意: 特定バージョンのエージェントのインストールはサポートされておらず、このロールは常に最新のリリースバージョンの New Relic エージェントをインストールします。

インストールの詳細、はじめ方、ロールの変数、依存関係、およびこのロールの使用例を示す ansible playbook のセクションを以下でご確認ください。

Windows OS 用の Ansible に関するヘルプが必要な場合は、Windows ホストの設定 を Ansible ドキュメント サイトでご覧ください。

インストール

Ansible Galaxy

ansible-galaxy install newrelic.newrelic_install

Galaxy へのリンク

ansible.windows と ansible.utils がインストールされていない場合は、以下のコマンドでインストールしてください：

ansible-galaxy collection install ansible.windows ansible.utils

手動

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

はじめ方

インストール後、newrelic.newrelic_install ロールを新しいまたは既存の playbook に含めます。例えば：

- name: New Relic をインストール
  hosts: all
  roles:
    - role: newrelic.newrelic_install
      vars:
        targets:
          - infrastructure
          - logs
          - apm-php
        tags:
          foo: bar
  environment:
    NEW_RELIC_API_KEY: <API key>
    NEW_RELIC_ACCOUNT_ID: <Account ID>
    NEW_RELIC_REGION: <Region>

変数

ロール変数

targets (必須)

ホストに対して実行するターゲットインストールのリストです。利用可能なオプションは次の通りです：

• infrastructure (Linux & Windows)
• logs (Linux & Windows)
• apm-php (Linux)
• apm-nodejs (Linux)
• apm-dotnet (Linux & Windows)
• apm-java (Linux)
• apache (Linux)
• mssql (Windows)
• mysql (Linux)
• nginx (Linux)

重要な注意点：

• logs ターゲットは infrastructure を必要とし、infrastructure なしで logs を指定するとエラーが発生します。
• apm-nodejs エージェントのインストールは、PM2 によって管理されるアプリにのみサポートされています。npm や yarn などのパッケージマネージャや他のインストール方法でのエージェントのインストールについては、ドキュメント を参照してください。
• Windows 用の apm-dotnet エージェントのインストールは、IIS にホストされたアプリにのみサポートされています。Linux インストールは、systemd サービスとして実行される .NET アプリケーションにのみサポートされます。
• apm-java エージェントのインストールは、Tomcat、Wildfly/Jboss、Jetty (スタンドアロン) での Java をサポートしています。このインストールは、New Relic の Java introspector を使用した動的アタッチを介して特定の Java アプリサーバーを計装する限られた APM インストールです。詳細は こちら をご覧ください。
• 次の統合には、インフラエージェントがインストールされている必要があります：
  • apm-java
  • apache
  • mssql
  • mysql
  • nginx

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

環境変数

値は playbook の environment キーワードの下に設定されます：

• NEW_RELIC_API_KEY (必須)
• NEW_RELIC_ACCOUNT_ID (必須)
• NEW_RELIC_REGION (オプション：'US' または 'EU', デフォルトは 'US')

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

apm-php:

• NEW_RELIC_APPLICATION_NAME (オプション) 計装する PHP アプリケーションの名前です。この名前は、New Relic の APM & Services に表示されます。省略すると、デフォルトは PHP Application になります。

apache:

• NEW_RELIC_APACHE_STATUS_URL (オプション) Apache ウェブサーバーのステータスを確認するための URL です。これは、Apache ウェブサーバーがホストで稼働していて健康な状態であることを確認するために使用されます。デフォルトは http://127.0.0.1/server-status?auto です。

mssql:

• 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 です。

mysql:

• 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 のリモート環境 をご覧ください。

バージョン互換性

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

依存関係

Python の要件: requirements.txt

Ansible の要件: requirements.yml

例 Playbook

- name: 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"

• ユーザーキーの確認: API keys UI

• アカウント ID の確認: アカウント ID ドキュメント

サポート

New Relic は、顧客が社員や他の顧客と交流して助けを得たり、ベストプラクティスを共有するためのオンラインフォーラムを主催および管理しています。すべての公式 New Relic オープンソースプロジェクトには、New Relic Explorers Hub に関連するコミュニティトピックがあります。このプロジェクトのトピック/スレッドは以下にあります：

• New Relic ドキュメント: プラットフォーム使用に関する包括的なガイダンス
• New Relic コミュニティ: トラブルシューティング質問に関与するのに最適な場所
• New Relic 開発者: カスタム観察性アプリケーション構築のためのリソース
• New Relic University: すべてのレベルの New Relic ユーザー向けのオンライン研修
• New Relic テクニカルサポート 24/7/365 のサポート。 テクニカルサポートの提供について詳しく読むことができます。

貢献

newrelic.newrelic_install Ansible ロールの改善にぜひご協力ください！ プルリクエストを送信する際には、CLA アシスタントを使用してクリックすることで CLA にサインする必要があります。プロジェクトごとに CLA にサインするのは一回だけです。

質問や、企業名義での貢献に必要な企業 CLA を実行したい場合は、opensource@newrelic.com までメールをお送りください。

脆弱性についての注意

セキュリティ方針で述べたように、New Relic は顧客とそのデータのプライバシーとセキュリティにコミットしています。私たちは、セキュリティ研究者による協調的開示を提供し、セキュリティコミュニティとの関与が、我々のセキュリティ目標を達成するために重要であると考えています。

このプロジェクトまたは New Relic の製品やウェブサイトにおいてセキュリティ脆弱性を発見した場合は、HackerOne を通じて New Relic にご報告いただけると幸いです。

このプロジェクトに貢献したい場合は、こちらのガイドライン をご覧ください。

すべての貢献者に感謝します！あなたの貢献がなければ、このプロジェクトは今日の姿にはなっていなかったでしょう。

ライセンス

このプロジェクトは Apache 2.0 ライセンスの下でライセンスされています。