From 6925b69fde0eba27662c23207d989213104a109f Mon Sep 17 00:00:00 2001 From: Jon Cahill-Torre Date: Mon, 7 Apr 2025 16:29:06 +0100 Subject: [PATCH 1/3] docs: about formatting --- content/agent/about.md | 27 +++++++++++++-------------- go.mod | 2 +- go.sum | 2 ++ 3 files changed, 16 insertions(+), 15 deletions(-) diff --git a/content/agent/about.md b/content/agent/about.md index 512ab92e9..048b43133 100644 --- a/content/agent/about.md +++ b/content/agent/about.md @@ -8,16 +8,16 @@ docs: DOCS-000 {{}} -### About F5 NGINX Agent -The F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX One, enabling remote management of the NGINX Instance(s). It also gathers performance metrics from NGINX and transmits them to the NGINX One Console for enhanced monitoring and control. +The F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX One, enabling remote management of the NGINX Instance(s). It also gathers performance metrics from NGINX and transmits them to the NGINX One Console for enhanced monitoring and control. -### Key Features -- Enable Access to Key NGINX One Use Cases - - Seamlessly integrates with essential NGINX One functionality, simplifying access to its core use cases and enhancing operational workflows. +## Key Features + +- Enable Access to Key NGINX One Use Cases + - Seamlessly integrates with essential NGINX One functionality, simplifying access to its core use cases and enhancing operational workflows. - [Connect to NGINX One Console]({{< relref "/agent/install-upgrade/install/#connect-an-instance-to-nginx-one-console" >}}) -- Real-Time Observability into NGINX One Data Plane Instances - - Provides live monitoring and actionable insights into the performance, status, and health of NGINX One Data Plane instances, improving decision-making and operational efficiency. +- Real-Time Observability into NGINX One Data Plane Instances + - Provides live monitoring and actionable insights into the performance, status, and health of NGINX One Data Plane instances, improving decision-making and operational efficiency. - [OpenTelemetry](https://opentelemetry.io/) support comes with F5 NGINX Agent, and the ability to [export the metrics data]({{< relref "/agent/otel/configure-otel-metrics.md" >}}) for use in other applications. @@ -25,17 +25,17 @@ The F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX ### Configuration management -- The F5 NGINX Agent provides an interface that enables users to deploy configuration changes to NGINX from a centralized management plane. +- The F5 NGINX Agent provides an interface that enables users to deploy configuration changes to NGINX from a centralized management plane. - Additionally, the F5 NGINX Agent verifies that the configuration changes are successfully applied to NGINX. - + ### Metrics Collection -- The F5 NGINX Agent comes pre-packaged with an embedded OpenTelemetry Collector . -- This embedded collector gathers vital performance and health metrics for both NGINX and the underlying instance it operates on. -- For example, it tracks key metrics such as active connections, requests per second, HTTP status codes, and response times. Additionally, it collects system-level data, including CPU usage, memory consumption, and disk I/O. These insights provide deep observability into NGINX's behavior, enabling teams to troubleshoot issues effectively, optimize performance, and maintain high availability. +- The F5 NGINX Agent comes pre-packaged with an embedded OpenTelemetry Collector . +- This embedded collector gathers vital performance and health metrics for both NGINX and the underlying instance it operates on. +- For example, it tracks key metrics such as active connections, requests per second, HTTP status codes, and response times. Additionally, it collects system-level data, including CPU usage, memory consumption, and disk I/O. These insights provide deep observability into NGINX's behavior, enabling teams to troubleshoot issues effectively, optimize performance, and maintain high availability. - Collected metrics can be seamlessly exported to the NGINX One Console or integrated with third-party data aggregators. -### How Agent works +## How Agent works ```mermaid graph BT @@ -88,4 +88,3 @@ The figure shows: - Embedding an OpenTelemetry Collector, collecting metrics from NGINX processes, host system performance data, then securely passing metric data to the NGINX One Cloud Console. - Collection and monitoring of host metrics (CPU usage, Memory utilization, Disk I/O) by the Agent OTel collector. - Collected data is made available on the NGINX One Cloud Console for monitoring, alerting, troubleshooting, and capacity planning purposes. - diff --git a/go.mod b/go.mod index 90217f278..a3d4d13aa 100644 --- a/go.mod +++ b/go.mod @@ -2,4 +2,4 @@ module github.com/nginxinc/docs go 1.19 -require github.com/nginxinc/nginx-hugo-theme v0.42.25 // indirect +require github.com/nginxinc/nginx-hugo-theme v0.42.26 // indirect diff --git a/go.sum b/go.sum index 10bea363f..8ff764f5f 100644 --- a/go.sum +++ b/go.sum @@ -6,3 +6,5 @@ github.com/nginxinc/nginx-hugo-theme v0.42.24 h1:aQkkTob0EpK+1ID+31E3y+RIdThldC4 github.com/nginxinc/nginx-hugo-theme v0.42.24/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= github.com/nginxinc/nginx-hugo-theme v0.42.25 h1:QkLTREuOohkq+hmBZCfWELAri4AOvhc6gmIJA1esUfo= github.com/nginxinc/nginx-hugo-theme v0.42.25/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= +github.com/nginxinc/nginx-hugo-theme v0.42.26 h1:DCJMXt/l3DY646sB+RgojnSRaWPNAz9o6imKfXZF8gA= +github.com/nginxinc/nginx-hugo-theme v0.42.26/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M= From 9003c7fb05c1c0d01eff1f5bfe2c34ac8fa84df1 Mon Sep 17 00:00:00 2001 From: Jon Cahill-Torre Date: Mon, 7 Apr 2025 16:32:56 +0100 Subject: [PATCH 2/3] fix: product name --- content/agent/about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/agent/about.md b/content/agent/about.md index 048b43133..4052ebb93 100644 --- a/content/agent/about.md +++ b/content/agent/about.md @@ -35,7 +35,7 @@ The F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX - For example, it tracks key metrics such as active connections, requests per second, HTTP status codes, and response times. Additionally, it collects system-level data, including CPU usage, memory consumption, and disk I/O. These insights provide deep observability into NGINX's behavior, enabling teams to troubleshoot issues effectively, optimize performance, and maintain high availability. - Collected metrics can be seamlessly exported to the NGINX One Console or integrated with third-party data aggregators. -## How Agent works +## How NGINX Agent works ```mermaid graph BT From ba6d3ba8a4456eb1b180c132dd9b8575d8e9ad40 Mon Sep 17 00:00:00 2001 From: Jon Cahill-Torre Date: Mon, 7 Apr 2025 16:34:05 +0100 Subject: [PATCH 3/3] fix: fix product name --- content/agent/about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/agent/about.md b/content/agent/about.md index 4052ebb93..f6449b15d 100644 --- a/content/agent/about.md +++ b/content/agent/about.md @@ -83,7 +83,7 @@ The figure shows: - The NGINX One Cloud Console includes: - Command Server to manage NGINX configurations, push new/updated configuration files remotely, and perform integrity tests. - OpenTelemetry (OTel) Receiver that receives observability data from connected Agent instances. -- An Agent process running on the NGINX Instance. The Agent is responsible for: +- An NGINX Agent process running on the NGINX instance. NGINX Agent is responsible for: - Watching, applying, validating, automatically roll back to last good configuration if issues are detected. - Embedding an OpenTelemetry Collector, collecting metrics from NGINX processes, host system performance data, then securely passing metric data to the NGINX One Cloud Console. - Collection and monitoring of host metrics (CPU usage, Memory utilization, Disk I/O) by the Agent OTel collector.