|
| 1 | +--- |
| 2 | +title: Features configuration |
| 3 | +weight: 150 |
| 4 | +toc: true |
| 5 | +nd-docs: DOCS-000 |
| 6 | +nd-content-type: how-to |
| 7 | +--- |
| 8 | + |
| 9 | +## Overview |
| 10 | + |
| 11 | +This guide describes the F5 NGINX Agent features, and how to enable and disable features using the NGINX Agent configuration file. |
| 12 | + |
| 13 | +## Before you begin |
| 14 | + |
| 15 | +Before you start, make sure that you have: |
| 16 | + |
| 17 | +- [NGINX Agent installed]({{< ref "/agent/installation-upgrade/" >}}) in your system. |
| 18 | +- Access to the NGINX Agent configuration file. |
| 19 | + |
| 20 | +## Features |
| 21 | + |
| 22 | +The following table lists the NGINX Agent features: |
| 23 | + |
| 24 | +{{< table "features" >}} |
| 25 | +| Feature Name | Description | Default/Non-default | |
| 26 | +| ---------------- | ----------------------------------------------------------------------- | ------------------- | |
| 27 | +| registration | Registering the NGINX Agent with the management plane. | Default | |
| 28 | +| nginx-config-async | Enable the publishing and uploading of NGINX configurations from the management plane. | Default | |
| 29 | +| metrics | Enable collecting of NGINX metrics. | Default | |
| 30 | +| metrics-throttle | Batch metrics before sending. | Non-default | |
| 31 | +| metrics-sender | Reports metrics over the gRPC connection. | Non-default | |
| 32 | +| dataplane-status | Report the health of the NGINX Instance. | Default | |
| 33 | +| process-watcher | Observe changes to the NGINX process. | Default | |
| 34 | +| file-watcher | Observe changes to the NGINX configuration or any changes to files on disk. | Default | |
| 35 | +| activity-events | Send NGINX or NGINX Agent related events to the management plane. | Default | |
| 36 | +| agent-api | Enable the NGINX Agent REST API. | Default | |
| 37 | +{{< /table >}} |
| 38 | + |
| 39 | +## Use cases |
| 40 | + |
| 41 | +### Enable metrics only |
| 42 | + |
| 43 | +1. Access the NGINX instance: Connect using SSH to the VM or server where NGINX Agent is running. |
| 44 | + |
| 45 | + `ssh user@your-nginx-instance` |
| 46 | + |
| 47 | +1. Open the NGINX Agent configuration file in a text editor. |
| 48 | + |
| 49 | + `sudo vim /etc/nginx-agent/nginx-agent.conf` |
| 50 | + |
| 51 | +1. Add the features section: Add the following to the end of the configuration file if it doesn't already exist. |
| 52 | + |
| 53 | + ```nginx |
| 54 | + features: |
| 55 | + - metrics |
| 56 | + - metrics-throttle |
| 57 | + - dataplane-status |
| 58 | + ``` |
| 59 | + |
| 60 | +1. Restart the NGINX Agent service to apply the changes. |
| 61 | + |
| 62 | + `sudo systemctl restart nginx-agent` |
| 63 | + |
| 64 | +Once the steps have been completed, users will be able to view metrics data being sent but will not have the capability to push NGINX configuration changes. |
| 65 | + |
| 66 | +### Enable the publishing of NGINX configurations and disable the collection of metrics |
| 67 | + |
| 68 | +1. Access the NGINX instance: Connect using SSH to the VM or server where NGINX Agent is running. |
| 69 | + |
| 70 | + `ssh user@your-nginx-instance` |
| 71 | + |
| 72 | +1. Open the NGINX Agent configuration file in a text editor. |
| 73 | + |
| 74 | + `sudo vim /etc/nginx-agent/nginx-agent.conf` |
| 75 | + |
| 76 | +1. Add the fetures section: Add the following to the end of the configuration file if it doesn't already exist. |
| 77 | + |
| 78 | + ```nginx |
| 79 | + features: |
| 80 | + - nginx-config-async |
| 81 | + - dataplane-status |
| 82 | + - file-watcher |
| 83 | +
|
| 84 | +1. Restart the NGINX Agent service to apply the changes. |
| 85 | +
|
| 86 | + `sudo systemctl restart nginx-agent` |
| 87 | +
|
| 88 | +Once the steps have been completed, users will be able to publish NGINX configurations but metrics data will not be collected by the NGINX Agent. |
0 commit comments