-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a docs page to explain NGINX Agent features
- Loading branch information
1 parent
e54218a
commit b89bac9
Showing
1 changed file
with
62 additions
and
0 deletions.
There are no files selected for viewing
62 changes: 62 additions & 0 deletions
62
site/content/configuration/configure-nginx-agent-features.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# Configure NGINX Agent Features | ||
|
||
## Overview | ||
|
||
This guide explains how to enable or disable NGINX Agent features. | ||
|
||
## Before you begin | ||
|
||
Before you begin ensure: | ||
|
||
- NGINX Agent has been installed. | ||
- Access to the NGINX Agent configuration file. | ||
|
||
|
||
## Features | ||
|
||
The following table details the NGINX Agent features available. | ||
|
||
| Feature Name | Description | | ||
| ------------- | ------------- | | ||
| registration | Registering the NGINX Agent with the management plane.| | ||
| nginx-config-async | Enable the publishing and uploading of NGINX configurations from the management plane.| | ||
| metrics | Enable collecting of NGINX metrics.| | ||
| metrics-throttle | Batch metrics before sending.| | ||
| metrics-sender | Reports metrics over the gRPC connection.| | ||
| dataplane-status | Report the health of the NGINX Instance.| | ||
| process-watcher | Observe changes to the NGINX process.| | ||
| file-watcher | Observe changes to the NGINX configuration or any changes to files on disk.| | ||
| activity-events | Send NGINX or NGINX Agent related events to the management plane.| | ||
| agent-api | Enable the NGINX Agent REST API.| | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
### Use Cases | ||
|
||
#### Enable metrics only | ||
1. **Access the NGINX Instance:** SSH to the virtual machine/server where NGINX Agent is running. | ||
``` | ||
ssh user@your-nginx-instance | ||
``` | ||
2. **Edit NGINX Agent configuration:** | ||
``` | ||
sudo vim /etc/nginx-agent/nginx-agent.conf | ||
``` | ||
3. **Add Features section:** Add the following yaml to the end of the file: | ||
|
||
``` | ||
features: | ||
- metrics | ||
- metrics-throttle | ||
- dataplane-status | ||
``` | ||
|
||
4. **Restart the NGINX Agent service:** Restart the NGINX Agent service to enable changes. | ||
|
||
|
||
|