NGINXインテグレーションでは、NGINXデータベースからインベントリとメトリクスを収集して当社のプラットフォームに送信します。このプラットフォームで、接続やクライアントのリクエストについてのデータを確認し、問題の原因を見つけることができます。
インテグレーションのインストールと、当社がどのようなデータを収集するかについてお読みください。
互換性および要件
当社のインテグレーションは、NGINX Open SourceとNGINX Plusの両方と互換性があります。
インテグレーションをインストールする前に、以下の要件を満たしていることを確認してください。
New Relicアカウント。アカウントをお持ちでない場合無料サインアップクレジットカードは不要です。
インテグレーションの設定セクションで説明しているとおり、NGINXエクステンションが有効になっています。
NGINXが、KubernetesまたはAmazon ECSで実行されていない場合、Infrastructureエージェントが、NGINXを実行しているLinux OSホストにインストールされている必要があります。その他の場合:
クイックスタート
NGINXサーバーを迅速に計装し、ガイド付きインストールでテレメトリデータを送信します。ガイド付きインストールは、New Relic CLIおよびインフラストラクチャエージェントをダウンロードおよびインストールする環境用にカスタマイズされたCLIコマンドを作成します。
始める準備はできていますか?ボタンの1つをクリックし、試行してください。
当社のガイド付きインストールは、インフラストラクチャエージェントを使用してNGINXインテグレーションを設定します。それだけではなく、環境内で実行中のその他のアプリケーションとログソースを発見し、どれを計装するべきかを推奨します。
ガイド付きインストールは、ほとんどの設定と連動します。ただし、ニーズに合わない場合は、その他の方法を検索し、NGINXサーバーのモニターを開始できます。
インテグレーションのインストールとアクティブ化
NGINXインテグレーションをインストールするには、環境の指示に従います。
追加の注:
- アドバンスト:インテグレーションはtarball書式で使用すると、パッケージマネージャ以外にもインストールできます。
- オンホストインテグレーションは、自動的にアップデートしません。最善の結果を得るため、インテグレーションパッケージの更新とInfrastructureエージェントの更新を定期的に実施してください。
インテグレーションの設定
インテグレーションのYAML形式設定では、必要なログインクレデンシャルやデータの収集方法を設定できます。どのオプションを変更するかは、設定とプリファレンスにより異なります。
NGINXインテグレーションからデータを取得するには、まず該当する拡張モジュールを有効化し、設定する必要があります。
- NGINX Open Sourceの場合:HTTPスタブステータスモジュール
- NGINX Plusの場合:HTTPステータスモジュールおよびHTTP APIモジュール
インストールの方法により、インテグレーションの設定方法はいくつかあります。
- Kubernetesで有効化した場合:Kubernetes上で実行中のサービスの監視を参照してください。
- Amazon ECSで有効化した場合:ECS上で実行中のサービスの監視を参照してください。
- オンホストにインストールする場合:インテグレーションのYAML設定ファイルである
nginx-config.yml
で設定を編集します。
設定オプションには次のものが含まれます。
metrics
:このコマンドは特定のNGINXサーバーのメトリクスを取得します。引数:status_url
:ステータスモジュールを使用してメトリクスを提供するために設定されているURL。デフォルト値127.0.0.1
が正しくない場合、システムのaddress/FQDN/URLを代用してください。例:status_url: http://127.0.0.1/status
inventory
:このコマンドはNGINX設定ファイルに設定されている設定パラメーターをインベントリデータとして取得します。引数:config_path
:NGINX設定ファイルへのパス。status_url
:このURLは、メトリクスを収集するのと同じNGINXインスタンスにインベントリデータを添付するために使用されます。
インベントリデータの収集を無効にするには、インベントリコマンドを削除します。
重要
コンテナで実行する場合、インベントリデータを取得するには、ローカルのconfig_pathをコンテナにマッピングする必要があります。マッピングしないと、インテグレーションは終了します。ボリュームのマッピングを行い、ホストとコンテナの間でファイルを共有する方法に関する、Dockerの指示を参照してください。
KubernetesとECS、場合によっては複数のインスタンスを実行できるその他の環境では、
インベントリ
の設定は複雑になります。この場合、インベントリを無効にすることを強く
推奨します。labels
:env
ラベルは、environment
属性を制御します。デフォルト値はproduction
です。
遠隔監視を起動する
remote_monitoring
設定パラメーターを使用して、このインテグレーションの遠隔監視とマルチテナンシーを可能にします。remote_monitoring
を使用するには、Infrastructureエージェントバージョン1.2.25以降も必要です。
重要
remote_monitoring
を起動すると、一部の属性が変更されるおよび/または設定アラートに影響が及ぶ可能性があります。詳しくは、オンホストインテグレーションにおける遠隔監視を参照してください。
環境変数パススルー
環境変数は、ライセンスキーなどの構成設定の管理に使用された後、Infrastructureエージェントにパススルーされます。この機能の利用手順に関しては、Infrastructureエージェントを設定するを参照してください。
重要
シークレット管理を使用すると、New Relic Infrastructureのエージェントでオンホストインテグレーションを設定し、インテグレーションの設定ファイルにプレーンテキストとして書き込みしないで(パスワードのような)機密データを使用できます。詳細については、シークレット管理を参照してください。
オンホストインテグレーション設定の一般的な構成の詳細については、設定を参照してください。
データの検索と使用
このサービスからのデータは、インテグレーションダッシュボードにレポートされます。
メトリクスが、NginxSample
イベントタイプに関連付けられます。トラブルシューティング目的で、またはカスタムのチャートとダッシュボードを作成するために、このデータのクエリを行えます。
データの検索・使用方法の詳細については、 インテグレーションデータを理解するを参照してください。
メトリクス
NGINXインテグレーションは、以下のメトリクスデータ属性を収集します。これらの属性を見つけるには、NginxSample
イベントタイプをクエリしてください。
NGINX Open Source
メトリック | 説明 |
---|---|
| 現在アクティブな接続数 |
| 受け入れたクライアント接続数(秒単位) |
| 受け入れたものの、処理できなかったために中断された接続数(秒単位) |
| NGINXがリクエストヘッダを読み込み中の現在の接続数 |
| リクエストを待機しているアイドル状態の現在のクライアント接続数 |
| NGINXがレスポンスをクライアントに書き戻している現在の接続数 |
| クライアントリクエストの合計(秒単位) |
NGINX Plus
当社のインテグレーションは、以下のHTTP APIエンドポイント: /nginx
、/processes
、/connections
、/http/requests
および/ssl
から、使用できるすべてのメトリックデータを取得します。
メトリック | 説明 |
---|---|
| リクエストとして受け入れたクライアント接続数(秒単位) |
| リクエストとして中断したクライアント接続数(秒単位) |
| 現在アクティブなクライアント接続数 |
| 現在アイドル状態のクライアント接続数 |
| 現在のリクエスト数 |
| 現在のリスエスト数(秒単位) |
| 正常に終了せず再度作成された子プロセスの現在の数 |
| 正常なSSLハンドシェイクの現在の数 |
| 失敗したSSLハンドシェイクの現在の数 |
| SSLハンドシェイクの間のセッション再使用の現在の数 |
インベントリデータ
インテグレーションは、NGINXマスター設定ファイル(通常はnginx.conf
)で定義された設定オプションを取得します。
ヒント
マスターNGINX設定ファイルには、設定を複数のファイルに分割する"include OTHER_FILE_NAME"
コマンドを含めることができます。Infrastructureエージェントは、include
コマンドによる設定を無視します(解析しません)。
システムメタデータ
インテグレーションは、NGINXサービスについて、以下の追加属性を収集します。
名前 | 説明 |
---|---|
| NGINXエディション: |
| NGINXのバージョン。 |
ソースコードのチェック
このインテグレーションはオープンソースソフトウェアです。つまり、ソースコードを参照して改善を送信したり、独自のフォークを作成して構築したりできます。
その他のヘルプ
さらに支援が必要な場合は、これらのサポートと学習リソースを確認してください:
- Explorers Hubでは、コミュニティからのサポートを受けたり、ディスカッションに参加したりすることができます。
- 当社サイトで答えを見つけて、サポートポータルの使用方法を確認してください。
- Linux、Windows、およびmacOS向けトラブルシューティングツールであるNew Relic Diagnosticsを実行してください。
- New Relicの とandドキュメント をご確認ください。