Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .cloudcannon/schemas/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ To do xzy, take the following steps:

2. Format as numbered lists.

{{< note >}}Add notes like this.{{</note>}}
{{< call-out "note" >}}Add notes like this.{{< /call-out >}}

3. If there is only one step, you don't need to format it as a numbered list.
Expand Down
2 changes: 1 addition & 1 deletion .cloudcannon/schemas/nms/policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The following table lists the configurable settings and their default values for

{{%tab name="API"%}}

{{<see-also>}}{{< include "acm/how-to/access-acm-api.md" >}}{{</see-also>}}
{{< call-out "note" >}}{{< include "acm/how-to/access-acm-api.md" >}}{{< /call-out >}}

To create an XYZ policy using the REST API, send an HTTP `POST` request to the Add-Endpoint-Name-Here endpoint.

Expand Down
24 changes: 12 additions & 12 deletions content/agent/configuration/configuration-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ nd-content-type: how-to

The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables.

{{<note>}}
{{< call-out "note" >}}

- NGINX Agent interprets configuration values set by configuration files, CLI flags, and environment variables in the following priorities:

Expand All @@ -19,7 +19,7 @@ The following sections explain how to configure NGINX Agent using configuration

- You must open any required firewall ports or add SELinux/AppArmor rules for the ports and IPs you want to use.

{{</note>}}
{{< /call-out >}}

## Configure with Config Files

Expand All @@ -30,9 +30,9 @@ Examples of the configuration files are provided below:
<details open>
<summary>example nginx-agent.conf</summary>

{{<note>}}
{{< call-out "note" >}}
In the following example `nginx-agent.conf` file, you can change the `server.host` and `server.grpcPort` to connect to the control plane.
{{</note>}}
{{< /call-out >}}

```nginx {hl_lines=[13]}
#
Expand Down Expand Up @@ -118,11 +118,11 @@ nginx_app_protect:
<details open>
<summary>example dynamic-agent.conf</summary>

{{<note>}}
{{< call-out "note" >}}
Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`

Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
{{</note>}}
{{< /call-out >}}

```yaml
# Dynamic configuration file for NGINX Agent.
Expand Down Expand Up @@ -169,13 +169,13 @@ nginx-agent

### CLI Flags and Environment Variables

{{< warning >}}
{{< call-out "warning" >}}

Before version 2.35.0, the environment variables were prefixed with `NMS_` instead of `NGINX_AGENT_`.

If you are upgrading from an older version, update your configuration accordingly.

{{< /warning >}}
{{< /call-out >}}

{{<bootstrap-table "table table-responsive table-bordered">}}
| CLI flag | Environment variable | Description |
Expand Down Expand Up @@ -218,7 +218,7 @@ If you are upgrading from an older version, update your configuration accordingl

<br>

{{<note>}}
{{< call-out "note" >}}
Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories NGINX Agent can read from or write to. This setting also defines the location to which you can upload config files when using a control plane.

NGINX Agent cannot write to directories outside the specified location when updating a config and cannot upload files to directories outside of the configured location.
Expand All @@ -227,15 +227,15 @@ NGINX Agent follows NGINX configuration directives to file paths outside the des

- [`ssl_certificate`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate)

{{</note>}}
{{< /call-out >}}

{{<note>}} Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location.
{{< call-out "note" >}} Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location.

Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`

Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`

{{</note>}}
{{< /call-out >}}

## Log Rotation

Expand Down
2 changes: 1 addition & 1 deletion content/agent/configuration/encrypt-communication.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ NGINX_AGENT_TLS_ENABLE=true

## Enable Server-Side TLS With Self-Signed Certificate

{{< warning >}}These steps are not recommended for production environments.{{< /warning >}}
{{< call-out "warning" >}}These steps are not recommended for production environments.{{< /call-out >}}

To enable server-side TLS with a self-signed certificate, you must have TLS enabled and set `skip_verify` to `true`, which disables hostname validation. Setting `skip_verify` can be done done only by updating the configuration file. See the following example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This guide provides instructions on how to build images with NGINX Agent and NGI

You can use [Docker](https://docs.docker.com/engine/install/) or [Podman](https://podman.io/docs/installation) to manage NGINX Agent container images. Follow the installation instructions for your preferred container engine and be sure the service is running before proceeding with the instructions in this document.

{{<note>}}The examples in this document primarily use Docker commands. You can adapt these using the appropriate [Podman commands](https://docs.podman.io/en/latest/Commands.html) if you're not using Docker.{{</note>}}
{{< call-out "note" >}}The examples in this document primarily use Docker commands. You can adapt these using the appropriate [Podman commands](https://docs.podman.io/en/latest/Commands.html) if you're not using Docker.{{< /call-out >}}

### Install the GNU Make package

Expand Down Expand Up @@ -112,7 +112,7 @@ docker tag docker-registry.nginx.com/nginx/agent:mainline nginx-agent
docker run --name nginx-agent -d nginx-agent
```

{{<note>}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< ref "/agent/configuration/configuration-overview" >}}).{{</note>}}
{{< call-out "note" >}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< ref "/agent/configuration/configuration-overview" >}}).{{< /call-out >}}

### Enable the gRPC interface

Expand Down Expand Up @@ -166,7 +166,7 @@ If the REST Interface is configured correctly, then you should see a JSON object

## Build the NGINX Agent images for specific OS targets

{{<important>}}The only **officially supported** base operating system is **Alpine**. The instructions below for other operating systems are provided for informational and **testing purposes only**.{{</important>}}
{{< call-out "important" >}}The only **officially supported** base operating system is **Alpine**. The instructions below for other operating systems are provided for informational and **testing purposes only**.{{< /call-out >}}

The NGINX Agent GitHub repo has a set of Make commands that you can use to build a container image for an specific operating system and version:

Expand Down Expand Up @@ -200,7 +200,7 @@ IMAGE_BUILD_TARGET=install-agent-repo NGINX_AGENT_VERSION=2.37.0~bullseye OS_REL

### Build NGINX Plus images

{{<important>}}You need a license to use NGINX Agent with NGINX Plus. You must complete the steps in the [Download the certificate and key files from MyF5](#myf5-download) section before proceeding.{{</important>}}
{{< call-out "important" >}}You need a license to use NGINX Agent with NGINX Plus. You must complete the steps in the [Download the certificate and key files from MyF5](#myf5-download) section before proceeding.{{< /call-out >}}

Run the following `make` command to build the default image, which uses Ubuntu 24.04 (Noble) as the base image.

Expand Down
4 changes: 2 additions & 2 deletions content/agent/installation-upgrade/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,8 @@ sudo systemctl enable nginx-agent

NGINX Agent uses formatted log files to collect metrics. Expanding log formats and instance counts will also increase the size of the NGINX Agent log files. We recommend adding a separate partition for `/var/log/nginx-agent`.

{{< important >}}
{{< call-out "important" >}}
Without log rotation or storage on a separate partition, log files could use up all the free drive space and cause your system to become unresponsive to certain services.

For more information, see [NGINX Agent Log Rotation]({{< ref "/agent/configuration/configuration-overview.md#nginx-agent-log-rotation" >}}).
{{< /important >}}
{{< /call-out >}}
4 changes: 2 additions & 2 deletions content/agent/installation-upgrade/installation-oss.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Before you install NGINX Agent for the first time on your system, you need to se
uid nginx signing key <[email protected]>
```

{{< important >}}If the fingerprint is different, remove the file.{{< /important >}}
{{< call-out "important" >}}If the fingerprint is different, remove the file.{{< /call-out >}}

1. Add the nginx agent repository:

Expand Down Expand Up @@ -159,7 +159,7 @@ Before you install NGINX Agent for the first time on your system, you need to se
uid nginx signing key <[email protected]>
```

{{< important >}}If the fingerprint is different, remove the file.{{< /important >}}
{{< call-out "important" >}}If the fingerprint is different, remove the file.{{< /call-out >}}

1. Add the `nginx-agent` repository:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ The installation process involves installing NGINX Plus without root privileges

You can install NGINX Plus without root privileges following the steps on the [NGINX Plus installation page]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus/#unpriv_install" >}}). The steps include a script that will allow you to install NGINX Plus in a non-root environment.

{{< note >}}
{{< call-out "note" >}}
NGINX Agent has its own user group (`nginx-agent`) which is created when NGINX Agent is installed. The user NGINX is running under is added to this user group during the installation of NGINX Agent. If you change the NGINX user after installing NGINX Agent, you will need to [manually add the new NGINX user]({{< ref "/agent/configuration/configure-nginx-agent-group.md" >}}) to the `nginx-agent` group.
{{< /note >}}
{{< /call-out >}}

### Install NGINX Agent

Expand Down
2 changes: 1 addition & 1 deletion content/amplify/faq/metrics-and-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ nd-docs: DOCS-957

[NGINX Amplify Agent Metrics and Metadata]({{< ref "/amplify/nginx-amplify-agent/metadata-metrics-collection" >}})

{{< note >}}For a complete list of metrics, refer to the [Metrics and Metadata documentation]({{< ref "/amplify/metrics-metadata" >}}).{{< /note >}}
{{< call-out "note" >}}For a complete list of metrics, refer to the [Metrics and Metadata documentation]({{< ref "/amplify/metrics-metadata" >}}).{{< /call-out >}}
2 changes: 1 addition & 1 deletion content/amplify/faq/user-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ To completely delete a previously monitored object follow these steps:

To delete a system using the web interface — find it in the [Inventory]({{< ref "/amplify/user-interface/inventory" >}}), and select the [i] icon. You can delete objects from the popup window that appears next.

{{< important >}}Deleting objects in the User Interface will not stop NGINX Amplify Agent. To completely remove a system from monitoring, please stop or uninstall NGINX Amplify Agent, clean it up in the web interface, and clean up any alerts.{{< /important >}}
{{< call-out "important" >}}Deleting objects in the User Interface will not stop NGINX Amplify Agent. To completely remove a system from monitoring, please stop or uninstall NGINX Amplify Agent, clean it up in the web interface, and clean up any alerts.{{< /call-out >}}
4 changes: 2 additions & 2 deletions content/amplify/metrics-metadata/nginx-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ To use the extended log format with your access log configuration:
access_log /var/log/nginx/access.log main_ext;
```

{{< note >}} Please keep in mind that by default, NGINX Amplify Agent will process all access logs that are found in your log directory. If you define a new log file with the extended log format that will contain the entries being already logged to another access log, your metrics might be counted twice. Please refer to the NGINX Amplify Agent configuration section above to learn how to exclude specific log files from processing.{{< /note >}}
{{< call-out "note" >}} Please keep in mind that by default, NGINX Amplify Agent will process all access logs that are found in your log directory. If you define a new log file with the extended log format that will contain the entries being already logged to another access log, your metrics might be counted twice. Please refer to the NGINX Amplify Agent configuration section above to learn how to exclude specific log files from processing.{{< /call-out >}}

The [error.log](http://nginx.org/en/docs/ngx_core_module.html#error_log) log level should be set to `warn`.

Expand Down Expand Up @@ -459,7 +459,7 @@ nginx.http.request.current = requests.current

The NGINX Plus metrics below are collected *per zone*. When configuring a graph using these metrics, please make sure to pick the correct server, upstream, or cache zone. A more granular peer-specific breakdown of the metrics below is currently not supported in NGINX Amplify.

{{< note >}}NGINX Amplify Agent does not support reporting the following metrics *per zone* but it can be used to display a cumulative sum of values from each zone.{{< /note >}}
{{< call-out "note" >}}NGINX Amplify Agent does not support reporting the following metrics *per zone* but it can be used to display a cumulative sum of values from each zone.{{< /call-out >}}

A cumulative metric set is also maintained internally by summing up the per-zone metrics. If you don't configure a specific zone when building graphs, this will result in an "all zones" visualization. E.g., for something like **plus.http.status.2xx** omitting zone will display the instance-wide sum of the successful requests across all zones.

Expand Down
2 changes: 1 addition & 1 deletion content/amplify/metrics-metadata/os-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ nd-docs: DOCS-974

## Agent Metrics

{{< note >}} Agent metrics are available only if you are using F5 NGINX Amplify Agent.{{< /note >}}
{{< call-out "note" >}} Agent metrics are available only if you are using F5 NGINX Amplify Agent.{{< /call-out >}}

- #### **amplify.agent.status**

Expand Down
6 changes: 3 additions & 3 deletions content/amplify/metrics-metadata/other-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ toc: true
nd-docs: DOCS-975
---

{{< note >}}Monitoring PHP-FPM and MySQL metrics is only supported by F5 NGINX Amplify Agent.{{< /note >}}
{{< call-out "note" >}}Monitoring PHP-FPM and MySQL metrics is only supported by F5 NGINX Amplify Agent.{{< /call-out >}}

## PHP-FPM metrics

Expand All @@ -24,7 +24,7 @@ To start monitoring PHP-FPM, follow the steps below:
service php7.0-fpm restart
```

2. {{< important >}} Check that NGINX, NGINX Amplify Agent, and the PHP-FPM workers are all run under the same user ID (e.g. `www-data`). You may have to change the used ID for the nginx workers, fix the nginx directories permissions, and then restart NGINX Amplify Agent too. If there are multiple PHP-FPM pools configured with different user IDs, make sure NGINX Amplify Agent's user ID is included in the group IDs of the PHP-FPM workers. This is required in order for NGINX Amplify Agent to access the PHP-FPM pool socket when querying for metrics.{{< /important >}}
2. {{< call-out "important" >}} Check that NGINX, NGINX Amplify Agent, and the PHP-FPM workers are all run under the same user ID (e.g. `www-data`). You may have to change the used ID for the nginx workers, fix the nginx directories permissions, and then restart NGINX Amplify Agent too. If there are multiple PHP-FPM pools configured with different user IDs, make sure NGINX Amplify Agent's user ID is included in the group IDs of the PHP-FPM workers. This is required in order for NGINX Amplify Agent to access the PHP-FPM pool socket when querying for metrics.{{< /call-out >}}

3. Confirm that the listen socket for the PHP-FPM pool you want to monitor and for which you enabled `pm.status_path`, is correctly configured with `listen.owner` and `listen.group`. Look for the following directives inside the pool configuration file.

Expand Down Expand Up @@ -219,7 +219,7 @@ To start monitoring MySQL, follow the instructions below.
353 rows in set (0.01 sec)
```

{{< note >}} NGINX Amplify Agent doesn't use *mysql(1)* for metric collection, however it implements a similar query mechanism via a Python module.{{< /note >}}
{{< call-out "note" >}} NGINX Amplify Agent doesn't use *mysql(1)* for metric collection, however it implements a similar query mechanism via a Python module.{{< /call-out >}}

3. [Update]({{< ref "/amplify/nginx-amplify-agent/install/updating-amplify-agent.md" >}}) NGINX Amplify Agent to the most recent version.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ NGINX Amplify can currently monitor and collect performance metrics for:

The NGINX Amplify Agent identifies an NGINX instance as any running NGINX master process with either a unique binary path or a unique configuration.

{{< note >}}There's no need to manually add or configure anything in the web interface after installing NGINX Amplify Agent. When NGINX Amplify Agent is started, the metrics and the metadata are automatically reported to the Amplify backend and visualized in the web interface.{{< /note >}}
{{< call-out "note" >}}There's no need to manually add or configure anything in the web interface after installing NGINX Amplify Agent. When NGINX Amplify Agent is started, the metrics and the metadata are automatically reported to the Amplify backend and visualized in the web interface.{{< /call-out >}}

When an NGINX instance is no longer in use it must be manually deleted in the web interface. The "Remove object" button can be found in the metadata viewer popup — see the [User Interface]({{< ref "/amplify/user-interface/">}}) documentation.
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ F5 NGINX Amplify Agent can automatically find all relevant NGINX configuration f

After NGINX Amplify Agent finds a particular NGINX configuration, it then automatically starts to keep track of its changes. When a change is detected with NGINX — for example, a master process restarts, or the NGINX config is edited, an update is sent to the Amplify backend.

{{< note >}} NGINX Amplify Agent never sends the raw unprocessed config files to the backend system. In addition, the following directives in the NGINX configuration are never analyzed — and their parameters aren't exported to the SaaS backend:
[ssl_certificate_key](http://nginx.org/en/docs/mail/ngx_mail_ssl_module.html#ssl_certificate_key), [ssl_client_certificate](http://nginx.org/en/docs/mail/ngx_mail_ssl_module.html#ssl_client_certificate), [ssl_password_file](http://nginx.org/en/docs/mail/ngx_mail_ssl_module.html#ssl_password_file), [ssl_stapling_file](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_stapling_file), [ssl_trusted_certificate](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_trusted_certificate), [auth_basic_user_file](http://nginx.org/en/docs/http/ngx_http_auth_basic_module.html#auth_basic_user_file), [secure_link_secret](http://nginx.org/en/docs/http/ngx_http_secure_link_module.html#secure_link_secret).{{< /note >}}
{{< call-out "note" >}} NGINX Amplify Agent never sends the raw unprocessed config files to the backend system. In addition, the following directives in the NGINX configuration are never analyzed — and their parameters aren't exported to the SaaS backend:
[ssl_certificate_key](http://nginx.org/en/docs/mail/ngx_mail_ssl_module.html#ssl_certificate_key), [ssl_client_certificate](http://nginx.org/en/docs/mail/ngx_mail_ssl_module.html#ssl_client_certificate), [ssl_password_file](http://nginx.org/en/docs/mail/ngx_mail_ssl_module.html#ssl_password_file), [ssl_stapling_file](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_stapling_file), [ssl_trusted_certificate](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_trusted_certificate), [auth_basic_user_file](http://nginx.org/en/docs/http/ngx_http_auth_basic_module.html#auth_basic_user_file), [secure_link_secret](http://nginx.org/en/docs/http/ngx_http_secure_link_module.html#secure_link_secret).{{< /call-out >}}
Loading
Loading