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/nms/policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Confirm the policy is being enforced:

<!-- Add troubleshooting steps for issues users might encounter and can self-solve. The purpose of this section is to deflect customer calls to Support. -->

For help resolving common issues when setting up and configuring the policy, follow the steps in this section. If you cannot find a solution to your specific issue, reach out to [NGINX Customer Support]({{< relref "support/contact-support.md" >}}) for assistance.
For help resolving common issues when setting up and configuring the policy, follow the steps in this section. If you cannot find a solution to your specific issue, reach out to [NGINX Customer Support]({{< ref "support/contact-support.md" >}}) for assistance.

### Issue 1

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Here are two examples:

```md
To install <software>, refer to the [installation instructions]({{< ref "install.md" >}}).
To install <integation>, refer to the [integration instructions]({{< relref "/integration/thing.md#section" >}}).
To install <integation>, refer to the [integration instructions]({{< ref "/integration/thing.md#section" >}}).
```

### How to add images
Expand Down
2 changes: 1 addition & 1 deletion content/agent/contribute/dev-environment-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ While most Linux or FreeBSD operating systems can be used to contribute to the N

## Install NGINX

Follow the steps in the [Installation]({{< relref "/agent/installation-upgrade/" >}}) section to download, install, and run NGINX and NGINX Agent.
Follow the steps in the [Installation]({{< ref "/agent/installation-upgrade/" >}}) section to download, install, and run NGINX and NGINX Agent.

## Clone the NGINX Agent Repository

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ NGINX Agent is a companion daemon for NGINX Open Source or NGINX Plus instances

If you want to use NGINX Agent with NGINX Plus, you need to purchase an NGINX Plus license. Contact your F5 Sales representative for assistance.

See the requirements and supported operating systems in the [NGINX Agent Technical Specifications]({{< relref "/agent/technical-specifications.md" >}}) topic.
See the requirements and supported operating systems in the [NGINX Agent Technical Specifications]({{< ref "/agent/technical-specifications.md" >}}) topic.

## Deploy Offical NGINX and NGINX Plus Containers

Expand Down Expand Up @@ -113,7 +113,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]({{< relref "/agent/configuration/configuration-overview" >}}).{{</note>}}
{{<note>}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< ref "/agent/configuration/configuration-overview" >}}).{{</note>}}

### Enable the gRPC interface

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ type:

## Overview

The NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "/agent/installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems.
The NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< ref "/agent/installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems.

See the [Technical Specifications]({{< relref "/agent/technical-specifications.md#container-support" >}}) for a list of supported operationg systems.
See the [Technical Specifications]({{< ref "/agent/technical-specifications.md#container-support" >}}) for a list of supported operationg systems.

NGINX Agent running in a container has some limitations that need to be considered, and are listed below.

Expand Down
2 changes: 1 addition & 1 deletion content/agent/installation-upgrade/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,5 +176,5 @@ NGINX Agent uses formatted log files to collect metrics. Expanding log formats a
{{< 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]({{< relref "/agent/configuration/configuration-overview.md#nginx-agent-log-rotation" >}}).
For more information, see [NGINX Agent Log Rotation]({{< ref "/agent/configuration/configuration-overview.md#nginx-agent-log-rotation" >}}).
{{< /important >}}
2 changes: 1 addition & 1 deletion content/agent/installation-upgrade/installation-oss.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Learn how to install NGINX Agent from the NGINX Open Source repository.
## Prerequisites

- NGINX installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-open-source/)
- A [supported operating system and architecture]({{< relref "/agent/technical-specifications.md#supported-distributions" >}})
- A [supported operating system and architecture]({{< ref "/agent/technical-specifications.md#supported-distributions" >}})
- `root` privilege

## Configure NGINX OSS Repository for installing NGINX Agent
Expand Down
2 changes: 1 addition & 1 deletion content/agent/installation-upgrade/installation-plus.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Learn how to install NGINX Agent from NGINX Plus repository

- An NGINX Plus subscription (purchased or trial)
- NGINX Plus installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX Plus](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/)
- A [supported operating system and architecture]({{< relref "/agent/technical-specifications.md#supported-distributions" >}})
- A [supported operating system and architecture]({{< ref "/agent/technical-specifications.md#supported-distributions" >}})
- `root` privilege
- Your credentials to the MyF5 Customer Portal, provided by email from F5, Inc.
- Your NGINX Plus certificate and public key (`nginx-repo.crt` and `nginx-repo.key` files), provided by email from F5, Inc.
Expand Down
2 changes: 1 addition & 1 deletion content/amplify/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ This release includes the following updates:

### Known Issues

- You can find information about known issues with NGINX Amplify in the [Known Issues]({{< relref "/amplify/known-issues.md" >}}) topic.
- You can find information about known issues with NGINX Amplify in the [Known Issues]({{< ref "/amplify/known-issues.md" >}}) topic.
4 changes: 2 additions & 2 deletions content/amplify/faq/metrics-and-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ docs: DOCS-957

### What Data Does F5 NGINX Amplify Agent Gather?

[NGINX Amplify Agent Metrics and Metadata]({{< relref "/amplify/nginx-amplify-agent/metadata-metrics-collection" >}})
[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]({{< relref "/amplify/metrics-metadata" >}}).{{< /note >}}
{{< note >}}For a complete list of metrics, refer to the [Metrics and Metadata documentation]({{< ref "/amplify/metrics-metadata" >}}).{{< /note >}}
18 changes: 9 additions & 9 deletions content/amplify/faq/nginx-amplify-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,37 +68,37 @@ Previous versions were powered by Python 2.6 and 2.7, depending on the target pl
2552 ? S 0:00 amplify-agent
```

For manual installation, please check the [user guide]({{< relref "/amplify/nginx-amplify-agent/install/installing-amplify-agent#installing-the-agent-manually" >}}).
For manual installation, please check the [user guide]({{< ref "/amplify/nginx-amplify-agent/install/installing-amplify-agent#installing-the-agent-manually" >}}).

### What Do I Need to Configure NGINX Amplify Agent to Report Metrics Correctly?

Once you install NGINX Amplify Agent, it will automatically begin sending metrics. You can expect to see real-time metrics in the Amplify web interface within about a minute.

If you don't see the new system or NGINX in the web interface, or (some) metrics aren't being collected, please check the following:

1. The NGINX Amplify Agent package has been successfully [installed]({{< relref "/amplify/nginx-amplify-agent/install/installing-amplify-agent.md" >}}), and no warnings were shown during the installation.
1. The NGINX Amplify Agent package has been successfully [installed]({{< ref "/amplify/nginx-amplify-agent/install/installing-amplify-agent.md" >}}), and no warnings were shown during the installation.

2. The `amplify-agent` process is running and updating its [log file]({{< relref "/amplify/nginx-amplify-agent/install/configuring-amplify-agent#agent-logfile" >}}).
2. The `amplify-agent` process is running and updating its [log file]({{< ref "/amplify/nginx-amplify-agent/install/configuring-amplify-agent#agent-logfile" >}}).

3. NGINX Amplify Agent is running under the same user as your NGINX worker processes.

4. The NGINX instance is started with an absolute path. Currently, NGINX Amplify Agent **can't** detect NGINX instances launched with a relative path (e.g., "./nginx").

5. The [user ID that is used by NGINX Amplify Agent and NGINX ]({{< relref "/amplify/nginx-amplify-agent/install/configuring-amplify-agent#overriding-the-effective-user-id" >}}), can run *ps(1)* to see all system processes. If *ps(1)* is restricted for non-privileged users, NGINX Amplify Agent won't be able to find and properly detect the NGINX master process.
5. The [user ID that is used by NGINX Amplify Agent and NGINX ]({{< ref "/amplify/nginx-amplify-agent/install/configuring-amplify-agent#overriding-the-effective-user-id" >}}), can run *ps(1)* to see all system processes. If *ps(1)* is restricted for non-privileged users, NGINX Amplify Agent won't be able to find and properly detect the NGINX master process.

6. The time is set correctly. If the time on the system where NGINX Amplify Agent runs is ahead or behind the world's clock, you won't be able to see the graphs.

7. *stub_status* is [properly configured]({{< relref "/amplify/nginx-amplify-agent/configuring-metric-collection" >}}), and the *stub_status module* is included in the NGINX build (this can be checked with `nginx -V`).
7. *stub_status* is [properly configured]({{< ref "/amplify/nginx-amplify-agent/configuring-metric-collection" >}}), and the *stub_status module* is included in the NGINX build (this can be checked with `nginx -V`).

8. NGINX [access.log](http://nginx.org/en/docs/http/ngx_http_log_module.html) and [error.log](http://nginx.org/en/docs/ngx_core_module.html#error_log) files are readable by the user `nginx` (or by the [user](http://nginx.org/en/docs/ngx_core_module.html#user) set in NGINX config).

9. All NGINX configuration files are readable by the NGINX Amplify Agent user ID (check owner, group, and permissions).

10. Extra [configuration steps have been performed as required]({{< relref "/amplify/metrics-metadata/nginx-metrics#additional-nginx-metrics" >}}) for the additional metrics to be collected.
10. Extra [configuration steps have been performed as required]({{< ref "/amplify/metrics-metadata/nginx-metrics#additional-nginx-metrics" >}}) for the additional metrics to be collected.

11. The system DNS resolver is correctly configured, and *receiver.amplify.nginx.com* can be successfully resolved.

12. Outbound TLS/SSL from the system to *receiver.amplify.nginx.com* is not restricted. This can be checked with *curl(1)*. [Configure a proxy server]({{< relref "/amplify/nginx-amplify-agent/install/configuring-amplify-agent#setting-up-a-proxy" >}}) for NGINX Amplify Agent if required.
12. Outbound TLS/SSL from the system to *receiver.amplify.nginx.com* is not restricted. This can be checked with *curl(1)*. [Configure a proxy server]({{< ref "/amplify/nginx-amplify-agent/install/configuring-amplify-agent#setting-up-a-proxy" >}}) for NGINX Amplify Agent if required.

13. *selinux(8)*, *apparmor(7)* or [grsecurity](https://grsecurity.net) are not interfering with the metric collection. E.g. for *selinux(8)* check **/etc/selinux/config**, try `setenforce 0` temporarily and see if it improves the situation for certain metrics.

Expand Down Expand Up @@ -146,7 +146,7 @@ Under 10% of the CPU and a few dozen MBs of RSS memory will be consumed. If you

### How Can I Uninstall NGINX Amplify Agent?

Guide to [uninstall NGINX Amplify Agent]({{< relref "/amplify/nginx-amplify-agent/install/uninstalling-amplify-agent" >}})
Guide to [uninstall NGINX Amplify Agent]({{< ref "/amplify/nginx-amplify-agent/install/uninstalling-amplify-agent" >}})

### How Can I Override System Hostname?

Expand All @@ -169,7 +169,7 @@ The hostname should be valid — the following aren't valid hostnames:

### How Can I Override the User ID for NGINX Amplify Agent to Use?

Refer to the [Configuring NGINX Amplify Agent]({{< relref "/amplify/nginx-amplify-agent/install/configuring-amplify-agent#overriding-the-effective-user-id" >}}) section in the documentation.
Refer to the [Configuring NGINX Amplify Agent]({{< ref "/amplify/nginx-amplify-agent/install/configuring-amplify-agent#overriding-the-effective-user-id" >}}) section in the documentation.

### Can I Use NGINX Amplify Agent with Docker?

Expand Down
2 changes: 1 addition & 1 deletion content/amplify/faq/user-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ To completely delete a previously monitored object follow these steps:
2. Delete objects from the web interface
3. Delete alarms

To delete a system using the web interface — find it in the [Inventory]({{< relref "/amplify/user-interface/inventory" >}}), and select the [i] icon. You can delete objects from the popup window that appears next.
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 >}}
4 changes: 2 additions & 2 deletions content/amplify/metrics-metadata/metrics-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ toc: true
docs: DOCS-972
---

Most metrics are collected by F5 NGINX Amplify Agent without requiring the user to perform any additional setup. For troubleshooting, see [Troubleshooting Metrics Collection]({{< relref "/amplify/nginx-amplify-agent/troubleshooting-metrics-collection.md" >}}).
Most metrics are collected by F5 NGINX Amplify Agent without requiring the user to perform any additional setup. For troubleshooting, see [Troubleshooting Metrics Collection]({{< ref "/amplify/nginx-amplify-agent/troubleshooting-metrics-collection.md" >}}).

Some additional metrics for NGINX monitoring will only be reported if the NGINX configuration file is modified accordingly. See [Additional NGINX Metrics]({{< relref "/amplify/metrics-metadata/nginx-metrics#additional-nginx-metrics" >}}), and review the *Source* and *Variable* fields in the metric descriptions that follow.
Some additional metrics for NGINX monitoring will only be reported if the NGINX configuration file is modified accordingly. See [Additional NGINX Metrics]({{< ref "/amplify/metrics-metadata/nginx-metrics#additional-nginx-metrics" >}}), and review the *Source* and *Variable* fields in the metric descriptions that follow.
Loading