From cbc67a2ee450b09c495f0e1f41a7e009da2c929e Mon Sep 17 00:00:00 2001 From: Donal Hurley Date: Wed, 14 Jan 2026 10:03:15 +0000 Subject: [PATCH] Add section for how to configure NGINX Agent with a NGINX Plus API --- .../monitoring/enable-nginx-plus-api-with-ssl.md | 10 +++++++++- .../use-cases/monitoring/enable-nginx-plus-api.md | 8 ++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/content/includes/use-cases/monitoring/enable-nginx-plus-api-with-ssl.md b/content/includes/use-cases/monitoring/enable-nginx-plus-api-with-ssl.md index e81b70d92..edcb9786f 100644 --- a/content/includes/use-cases/monitoring/enable-nginx-plus-api-with-ssl.md +++ b/content/includes/use-cases/monitoring/enable-nginx-plus-api-with-ssl.md @@ -75,4 +75,12 @@ Here is an example of how to generate self-signed certificates ``` openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /etc/nginx/certs/nginx-selfsigned.key -out /etc/nginx/certs/nginx-selfsigned.crt -subj "/CN=localhost" -addext "subjectAltName=IP:127.0.0.1" ``` -{{}} \ No newline at end of file +{{}} + +If there are issues with NGINX Agent discovering the NGINX Plus API, NGINX Agent can be manually configured with the address of the NGINX Plus API. Here is an example of a NGINX Agent configuration that is manually configured with the NGINX Plus API. +``` +data_plane_config: + nginx: + api: + url: "https://127.0.0.1:9000/api" +``` diff --git a/content/includes/use-cases/monitoring/enable-nginx-plus-api.md b/content/includes/use-cases/monitoring/enable-nginx-plus-api.md index f860f9934..809eab4f6 100644 --- a/content/includes/use-cases/monitoring/enable-nginx-plus-api.md +++ b/content/includes/use-cases/monitoring/enable-nginx-plus-api.md @@ -17,4 +17,12 @@ To collect comprehensive metrics for NGINX Plus, including bytes streamed, infor - To restrict write methods (`POST`, `PATCH`, `DELETE`), uncomment and configure the `limit_except GET` block and set up [HTTP basic authentication](https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html). {{}} +If there are issues with NGINX Agent discovering the NGINX Plus API, NGINX Agent can be manually configured with the address of the NGINX Plus API. Here is an example of a NGINX Agent configuration that is manually configured with the NGINX Plus API. +``` +data_plane_config: + nginx: + api: + url: "http://127.0.0.1:9000/api" +``` + For more details, see the [NGINX Plus API module](https://nginx.org/en/docs/http/ngx_http_api_module.html) documentation and [Configuring the NGINX Plus API]({{< ref "/nginx/admin-guide/monitoring/live-activity-monitoring.md#configuring-the-api" >}}).