|
| 1 | +--- |
| 2 | +title: Review and configure features |
| 3 | +weight: 350 |
| 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 them using the NGINX Agent configuration file, CLI flags, environment variables, and gRPC updates. |
| 12 | + |
| 13 | +## Before you begin |
| 14 | + |
| 15 | +Before you start, make sure that you have: |
| 16 | + |
| 17 | +- [NGINX Agent installed]({{< ref "/nginx-one/agent/install-upgrade/" >}}) in your system. |
| 18 | +- Access to the NGINX Agent configuration file, CLI, or container environment. |
| 19 | + |
| 20 | +## Features |
| 21 | + |
| 22 | +The following table lists the NGINX Agent features: |
| 23 | + |
| 24 | +{{< table "features" >}} |
| 25 | +| Feature Name | Description | Default | |
| 26 | +| ------------------- | --------------------------------------------------------------------------- | ------- | |
| 27 | +| configuration | Full read/write management of configurations, controlled by DataPlaneConfig ConfigMode. | On | |
| 28 | +| certificates | Inclusion of public keys and other certificates in the configurations toggled by DataPlaneConfig CertMode | Off | |
| 29 | +| file-watcher | Monitoring of file changes in the allowed directories list and references from product configs. | On | |
| 30 | +| metrics | Full metrics reporting. | On | |
| 31 | +| > metrics-host | Host-level metrics (cpu, disk, load, fs, memory, network, paging). | On | |
| 32 | +| > metrics-container | Container-level metrics from cgroup information. | On | |
| 33 | +| > metrics-instance | OSS and Plus metrics depending on NGINX instance. | On | |
| 34 | +| logs | Collection and reporting of NGINX error logs. | Off | |
| 35 | +| > logs-nap | F5 WAF for NGINX logs. | Off | |
| 36 | +{{< /table >}} |
| 37 | + |
| 38 | +## Configuration sources |
| 39 | + |
| 40 | +You can enable or disable features using several configuration sources: |
| 41 | + |
| 42 | +### CLI parameters |
| 43 | + |
| 44 | +Enable features at launch: |
| 45 | + |
| 46 | + ```shell |
| 47 | + ./nginx-agent --features=configuration,metrics,file-watcher |
| 48 | + ``` |
| 49 | + |
| 50 | +### Environment variables |
| 51 | + |
| 52 | +Use environment variables for containerized deployments: |
| 53 | + |
| 54 | + ```shell |
| 55 | + export NGINX_AGENT_FEATURES="configuration,metrics,file-watcher" |
| 56 | + ``` |
| 57 | + |
| 58 | +### Configuration file |
| 59 | + |
| 60 | +Define features in the `nginx-agent.conf` file: |
| 61 | + |
| 62 | + ```yaml |
| 63 | + features: |
| 64 | + - configuration |
| 65 | + - metrics |
| 66 | + - file-watcher |
| 67 | + ``` |
| 68 | +
|
| 69 | +## Use cases |
| 70 | +
|
| 71 | +### Enable metrics only |
| 72 | +
|
| 73 | +1. Access the NGINX instance: Connect using SSH to the VM or server where NGINX Agent is running. |
| 74 | +
|
| 75 | + `ssh user@your-nginx-instance` |
| 76 | + |
| 77 | +1. Open the NGINX Agent configuration file in a text editor. |
| 78 | + |
| 79 | + `sudo vim /etc/nginx-agent/nginx-agent.conf` |
| 80 | + |
| 81 | +1. Add the features section: Add the following to the end of the configuration file if it doesn't already exist. |
| 82 | + |
| 83 | + ```yaml |
| 84 | + features: |
| 85 | + - metrics |
| 86 | + - metrics-host |
| 87 | + - metrics-container |
| 88 | + - metrics-instance |
| 89 | + ``` |
| 90 | + |
| 91 | +1. Restart the NGINX Agent service to apply the changes. |
| 92 | + |
| 93 | + `sudo systemctl restart nginx-agent` |
| 94 | + |
| 95 | +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. |
| 96 | + |
0 commit comments