• EnglishEspañol日本語한국어Português
  • Log inStart now

NGINX monitoring integration

Our NGINX integration collects and sends inventory, logs, and metrics from your NGINX server to our platform, where you can see data on connections and client requests so that you can find the source of any problems.

To install the NGINX monitoring integration, you must run through the following steps:

  1. Enable your NGINX Server.
  2. Install and activate the integration.
  3. Configure the integration.
  4. Find and use data.
  5. Optionally, see NGINX's configuration settings.

Important

For best results, regularly update the integration package and the infrastructure agent.

Compatibility and requirements

Our integration is compatible with both NGINX Open Source and NGINX Plus. Before installing the integration, ensure you meet the following requirements:

Supported operating systems

  • Windows Windows
  • Linux Linux

For a comprehensive list of specific Windows and Linux versions, check the table of compatible operating systems.

Enable your NGINX Server

To capture data from the NGINX integration, you must first enable and configure the applicable extension module:

Install and activate the integration

To install the NGINX integration, follow the instructions for your environment:

Linux installation

  1. Install the infrastructure agent, and replace the INTEGRATION_FILE_NAME variable with nri-nginx.

  2. Change the directory to the integrations configuration folder by running:

    bash
    $
    cd /etc/newrelic-infra/integrations.d
  3. Copy the sample configuration file by running:

    bash
    $
    sudo cp nginx-config.yml.sample nginx-config.yml
  4. Edit the nginx-config.yml configuration file with your favorite editor. Check out some configuration file examples..

  5. To enable automatic NGINX access and error log parsing and forwarding, copy (or rename) the nginx-log.yml.example file to nginx-log.yml. No need to restart the agent.

    bash
    $
    sudo cp /etc/newrelic-infra/logging.d/nginx-log.yml.example /etc/newrelic-infra/logging.d/nginx-log.yml

Other environments

Additional notes:

Did this doc help with your installation?

Configure the integration

There are several ways to configure the integration, depending on how it was installed:

  • If it was enabled via KubernetesKubernetes, see Monitor services running on Kubernetes.
  • If it was enabled via ECSAmazon ECS, see Monitor services running on ECS.
  • If it was installed on-host, edit the integration's nginx-config.yml configuration file. An integration's YAML-format configuration is where you can place required login credentials and configure how data is collected. The options you change depend on your setup and preference. The configuration file has common settings applicable to all integrations such as interval, timeout, or inventory_source. To read about these common settings, see configuration format.

Important

If you are still using our Legacy configuration and definition files, refer to this document for help.

Specific settings related to NGINX are defined using the env section of the configuration file. These settings control the connection to your NGINX instance as well as other security settings and features. The list of valid settings is described in the next section of this document.

nginx-config.yml sample files

Configuration options for the integration

For more on how to find and use your data, see NGINX's configuration settings.

Find and use data

After you've configured and installed the integration, you can start monitoring:

For more on how to find and use your data, see how to understand integration data.

Metrics collected by the integration

The NGINX integration collects the following metrics:

Copyright © 2024 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.