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
+23-60
Original file line number
Diff line number
Diff line change
@@ -4,80 +4,43 @@ weight: 100
4
4
toc: true
5
5
docs: DOCS-000
6
6
---
7
+
{{<call-out "note" "F5 NGINX Agent v3.0 is available now">}}
8
+
<!-- (TODO: Link instructions ) -->
9
+
{{</call-out>}}
7
10
8
-
NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables:
11
+
### About F5 NGINX Agent
12
+
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.
9
13
10
-
- Remote management of NGINX configurations
11
-
- Collection and reporting of real-time NGINX performance and operating system metrics
12
-
- Notifications of NGINX events
14
+
### Key Features
15
+
- Enable Access to Key NGINX One Use Cases
16
+
- Seamlessly integrates with essential NGINX One functionality, simplifying access to its core use cases and enhancing operational workflows.
17
+
-[Connect to NGINX One Console]({{< relref "/agent/install-upgrade/install/#connect-an-instance-to-nginx-one-console" >}})
13
18
14
-
[OpenTelemetry](https://opentelemetry.io/) support comes with NGINX Agent v3, and the ability to [export the metrics data]({{< relref "/agent/how-to/export-metrics.md" >}}) for use in other applications.
19
+
- Real-Time Observability into NGINX One Data Plane Instances
20
+
- Provides live monitoring and actionable insights into the performance, status, and health of NGINX One Data Plane instances, improving decision-making and operational efficiency.
15
21
16
-
For an overview of the metrics available from NGINX Agent, read the following topics:
-[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.
22
23
23
24
---
24
25
25
26
## How it works
26
27
27
-
NGINX Agent runs as a companion process on a system running NGINX. It provides gRPC and REST interfaces for configuration management and metrics collection from the NGINX process and operating system.
28
-
29
-
NGINX Agent enables remote interaction with NGINX using common Linux tools and unlocks the ability to build sophisticated monitoring and control systems that can manage large collections of NGINX instances.
NGINX Agent provides an API interface for submission of updated configuration files. Upon receipt of a new file, it checks the output of `nginx -V` to determine the location of existing configurations. It then validates the new configuration with `nginx -t` before applying it via a signal HUP to the NGINX master process.
37
-
38
-
For additional information, view the [Configuration overview]({{< relref "/agent/how-to/configuration-overview.md" >}}) topic.
39
-
40
-
---
41
-
42
-
## Collecting metrics
43
-
44
-
NGINX Agent interfaces with NGINX process information and parses NGINX logs to calculate and report metrics. When interfacing with NGINX Plus, NGINX Agent pulls relevant information from the NGINX Plus API. Reported metrics may be aggregated by [Prometheus](https://prometheus.io/) and visualized with tools like [Grafana](https://grafana.com/).
28
+
### Configuration management
45
29
46
-
---
47
-
48
-
### NGINX Open Source
30
+
- The F5 NGINX Agent provides an interface that enables users to deploy configuration changes to NGINX from a centralized management plane.
31
+
- Additionally, the F5 NGINX Agent verifies that the configuration changes are successfully applied to NGINX.
32
+
33
+
### Metrics Collection
49
34
50
-
When running alongside an open source instance of NGINX, NGINX Agent requires that NGINX Access and Error logs are turned on and contain all default variables.
35
+
- The F5 NGINX Agent comes pre-packaged with an embedded OpenTelemetry Collector .
36
+
- This embedded collector gathers vital performance and health metrics for both NGINX and the underlying instance it operates on.
37
+
- 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
+
- Collected metrics can be seamlessly exported to the NGINX One Console or integrated with third-party data aggregators.
39
+
51
40
52
-
---
53
41
54
-
### NGINX Plus
55
42
56
-
For NGINX Agent to work properly with an NGINX Plus instance, the API needs to be configured in that instance's nginx.conf. View the [Instance Metrics Overview](https://docs.nginx.com/nginx-management-suite/nim/about/overview-metrics/) topic for more details. Once NGINX Plus is configured with the `/api/` endpoint, the Agent will automatically use it on startup.
NGINX Agent allows a gRPC connected control system to register a listener for a specific event. The control mechanism is then invoked when NGINX Agent sends an associated system signal. The source of a notification can be either the NGINX instance or NGINX Agent itself. Here's a list of currently supported events:
0 commit comments