Skip to content

docs: Update agent features configuration examples #1260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 6, 2025
Merged

docs: Update agent features configuration examples #1260

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions content/nginx-one/agent/configure-instances/configure-agent-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,7 @@ The following table lists the NGINX Agent features:
| ------------------- | --------------------------------------------------------------------------- | ------- |
| configuration | Full read/write management of configurations, controlled by DataPlaneConfig ConfigMode. | On |
| certificates | Inclusion of public keys and other certificates in the configurations toggled by DataPlaneConfig CertMode | Off |
| connection | Sends an initial connection message reporting instance information on presence of Command ServerConfig Host and Port | On |
| file-watcher | Monitoring of file changes in the allowed directories list and references from product configs. | On |
| agent-api | REST API for NGINX Agent. | Off |
| metrics | Full metrics reporting. | On |
| > metrics-host | Host-level metrics (cpu, disk, load, fs, memory, network, paging). | On |
| > metrics-container | Container-level metrics from cgroup information. | On |
Expand All @@ -46,15 +44,15 @@ You can enable or disable features using several configuration sources:
Enable features at launch:

```shell
./nginx-agent --features=connection,configuration,metrics,file-watcher,agent-api
./nginx-agent --features=configuration,metrics,file-watcher
```

### Environment variables

Use environment variables for containerized deployments:

```shell
export NGINX_AGENT_FEATURES="connection,configuration,metrics,file-watcher,agent-api"
export NGINX_AGENT_FEATURES="configuration,metrics,file-watcher"
```

### Configuration file
Expand All @@ -63,11 +61,9 @@ Define features in the `nginx-agent.conf` file:

```yaml
features:
- connection
- configuration
- metrics
- file-watcher
- agent-api
```

## Use cases
Expand Down