NGINX Plusサーバで何か起こっているのかを把握する必要がある場合、DDoS攻撃が疑われる場合、ユーザがWebサイトのエラーを報告する場合には、NGINX Plusのリアルタイム アクティビティ監視インターフェイスで、主要な負荷とパフォーマンスの指標を確認できます。シンプルなRESTful JSONインターフェイスを採用しており、統計情報をライブ ダッシュボードやサードパーティの監視ツールに簡単に接続できます。
NGINX Plus APIによりライブ アクティビティ監視データが生成されます。ライブ アクティビティ監視は次のように設定できます。
server {
listen 8080;
location /api {
api write=on;
# directives limiting access to the API
}
location = /dashboard.html {
root /usr/share/nginx/html;
}
# Redirect requests made to the pre-NGINX Plus API dashboard
location = /status.html {
return 301 /dashboard.html;
}
}
APIを使用してアップストリーム グループの再設定または収集された統計情報の消去を行う場合は、write=on
パラメータが必要です。ステータス情報を取得する場合は、このパラメータを指定する必要はありません。
/apiロケーションへのアクセスを制限することをお勧めします。NGINX Plus Admin Guideに、適切なセキュリティ方式の詳細な説明があります。
APIにアクセスすると、NGINX Plusから現在の統計情報が含まれているJSON形式のドキュメントが返されます。/api/api-version/ (api-versionはNGINX Plus APIのバージョン番号)で完全な統計情報をリクエストできます。また、ドリルダウンして特定のAPIエンドポイントのデータのサブセットや単一のデータポイントを取得できます。以下の情報があります。
すべてのエンドポイントのリストについては、参照ドキュメントまたはSwagger UI at demo.nginx.comをご覧ください。
使用する外部監視ツールにNGINX Plusの指標をエクスポートできます。NGINX Plusは、次のような人気の高いサードパーティツールやNGINXツールと連携します。