Skip to content

Commit 341d617

Browse files
authored
Merge branch 'agent-release-3.0' into update-export-metrics-docs
2 parents 03f08f5 + 8ec3646 commit 341d617

File tree

2 files changed

+58
-8
lines changed

2 files changed

+58
-8
lines changed

content/agent/about.md

Lines changed: 50 additions & 5 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,11 +34,58 @@ 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-
4037

38+
### How Agent works
4139

40+
```mermaid
41+
graph BT
4242
43-
{{< img src="agent-flow.png" caption="How Agent works" alt="How NGINX Agent works" width="99%">}}
43+
%% Define colors for the subgraphs
44+
style ManagementPlane fill:#d0eac4,stroke:#228B22,stroke-width:2px,color:#000000
45+
style CommandControl fill:#cfe2f1,stroke:#1E90FF,stroke-width:2px,color:#000000
46+
style OTelManagementPlane fill:#cfe2f1,stroke:#1E90FF,stroke-width:2px,color:#000000
47+
style Compute fill:#cfe2f1,stroke:#1E90FF,stroke-width:2px,color:#000000
48+
style NGINX fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
49+
style NGINXConfig fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
50+
style ErrorLogs fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
51+
style Agent fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
4452
45-
---
53+
subgraph ManagementPlane["NGINX One"]
54+
CommandControl["Command Server"]
55+
OTelManagementPlane["OTel Receiver"]
56+
end
57+
58+
subgraph Compute["NGINX Instance"]
59+
subgraph Agent["Agent Process"]
60+
OTelDataPlane["OTel Collector"]
61+
end
62+
63+
subgraph NGINX["NGINX Process"]
64+
NGINXMetrics["Metrics"]
65+
end
66+
NGINXConfig["NGINX Configuration Files"]
67+
ErrorLogs["NGINX Error Logs"]
68+
69+
Metrics["Host Metrics"] --> |Collects| OTelDataPlane
70+
NGINXMetrics --> |Reads| OTelDataPlane["OTel Collector"]
71+
Agent --> |Watch/Reload| NGINX
72+
Agent --> |Reads| ErrorLogs
73+
OTelDataPlane --> |Reads| AccessLogs["NGINX Access Logs"]
74+
Agent <--> |Reads/Writes| NGINXConfig
75+
end
76+
77+
Compute <--> |gRPC| ManagementPlane
78+
```
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, and perform integrity tests.
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, automatically roll back to last good configuration if issues are detected.
88+
- Embedding an OpenTelemetry Collector, collecting metrics from NGINX processes, 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) by the Agent OTel collector.
90+
- Collected data is made available on the NGINX One Cloud Console for monitoring, alerting, troubleshooting, and capacity planning purposes.
4691

content/agent/support.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
---
22
title: Support
33
weight: 800
4-
docs: DOCS-000
4+
toc: false
5+
type: reference
6+
product: Agent
57
---
68

79
## Support policy
810
F5 NGINX Agent adheres to the support policy detailed in the following knowledge base article: [K000140156](https://my.f5.com/manage/s/article/K000140156).
911

12+
1013
## Contact F5 Support
11-
For questions and/or assistance with installing, troubleshooting, or using NGINX Agent, contact Support via the [MyF5 Customer Portal](https://account.f5.com/myf5).
14+
15+
For questions and/or assistance with installing, troubleshooting, or using NGINX Agent, contact support via the [MyF5 Customer Portal](https://account.f5.com/myf5).
1216

1317
## Community support
18+
1419
- If you experience issues with NGINX Agent, please [open an issue in GitHub](https://github.com/nginx/agent/issues/new).
15-
- If you have any suggestions or feature requests, please [open an idea in GitHub discussions](https://github.com/nginx/agent/discussions).
20+
- If you have any suggestions or feature requests, please [open an idea in GitHub discussions](https://github.com/nginx/agent/discussions).

0 commit comments

Comments
 (0)