You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/agent/about.md
+50-5Lines changed: 50 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,9 +21,7 @@ The F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX
21
21
22
22
-[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.
23
23
24
-
---
25
24
26
-
## How it works
27
25
28
26
### Configuration management
29
27
@@ -36,11 +34,58 @@ The F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX
36
34
- This embedded collector gathers vital performance and health metrics for both NGINX and the underlying instance it operates on.
37
35
- 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.
38
36
- Collected metrics can be seamlessly exported to the NGINX One Console or integrated with third-party data aggregators.
- 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.
F5 NGINX Agent adheres to the support policy detailed in the following knowledge base article: [K000140156](https://my.f5.com/manage/s/article/K000140156).
9
11
12
+
10
13
## 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).
12
16
13
17
## Community support
18
+
14
19
- 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