Skip to content

Commit d959cea

Browse files
committed
Add Agent V3 diagram description
1 parent e8c3f32 commit d959cea

File tree

3 files changed

+20
-11
lines changed

3 files changed

+20
-11
lines changed

content/agent/about.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,7 @@ The F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX
2121

2222
- [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.
2323

24-
---
2524

26-
## How it works
2725

2826
### Configuration management
2927

@@ -36,12 +34,9 @@ The F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX
3634
- This embedded collector gathers vital performance and health metrics for both NGINX and the underlying instance it operates on.
3735
- 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.
3836
- Collected metrics can be seamlessly exported to the NGINX One Console or integrated with third-party data aggregators.
39-
40-
41-
42-
43-
{{< img src="agent-flow.png" caption="How Agent works" alt="How NGINX Agent works" width="99%">}}
4437

38+
### How Agent works
39+
---
4540
```mermaid
4641
graph BT
4742
@@ -55,9 +50,9 @@ graph BT
5550
style ErrorLogs fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
5651
style Agent fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
5752
58-
subgraph ManagementPlane["Management Plane"]
53+
subgraph ManagementPlane["NGINX One"]
5954
CommandControl["Command Server"]
60-
OTelManagementPlane["OTel Collector"]
55+
OTelManagementPlane["OTel Receiver"]
6156
end
6257
6358
subgraph Compute["NGINX Instance"]
@@ -81,5 +76,17 @@ graph BT
8176
8277
Compute <--> |gRPC| ManagementPlane
8378
```
84-
---
79+
80+
The figure shows:
81+
82+
- An NGINX Instance running on bare metal, virtual machine or container
83+
- The NGINX One Cloud Console includes:
84+
- Command Server to manage NGINX configurations, push new/updated configuration files remotely, perform integrity tests, and automatically roll back to last good configuration if issues are detected.
85+
- OpenTelemetry (OTel) Receiver that receives observability data from connected Agent instances.
86+
- An Agent Process running on the NGINX Instance. The Agent is responsible for:
87+
- Watching, applying, validating, and managing rollback operations on NGINX configuration files.
88+
- Embedding an OpenTelemetry Collector, collecting metrics from both NGINX processes and host system performance data, then securely passing metric data to the NGINX One Cloud Console.
89+
- Collection and monitoring of Host Metrics (CPU usage, Memory utilization, Disk I/O).
90+
- Management and troubleshooting features leveraging NGINX Configuration Files, NGINX Logs (both access and error), and process-level metrics.
91+
- Collected data is made available on the NGINX One Cloud Console for monitoring, alerting, troubleshooting, and capacity planning purposes.
8592

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ module github.com/nginxinc/docs
22

33
go 1.19
44

5-
require github.com/nginxinc/nginx-hugo-theme v0.42.24 // indirect
5+
require github.com/nginxinc/nginx-hugo-theme v0.42.25 // indirect

go.sum

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,5 @@ github.com/nginxinc/nginx-hugo-theme v0.41.27 h1:M8ttO1ZkTGY06o0MYvnm3kc/sA6lOmI
44
github.com/nginxinc/nginx-hugo-theme v0.41.27/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=
55
github.com/nginxinc/nginx-hugo-theme v0.42.24 h1:aQkkTob0EpK+1ID+31E3y+RIdThldC4HgA2LcJL4TXU=
66
github.com/nginxinc/nginx-hugo-theme v0.42.24/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=
7+
github.com/nginxinc/nginx-hugo-theme v0.42.25 h1:QkLTREuOohkq+hmBZCfWELAri4AOvhc6gmIJA1esUfo=
8+
github.com/nginxinc/nginx-hugo-theme v0.42.25/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=

0 commit comments

Comments
 (0)