Documentation forSolarWinds Observability

Configure NGINX integration

To integrate NGINX with SolarWinds Observability:

  1. In SolarWinds Observability, click Add Data in the upper-right corner.

  2. In the Add Data dialog, click Integration, and then click NGINX.

  3. In the Add NGINX dialog, select a host with the SolarWinds Observability Agent (SWO Agent) you want to use for NGINX and click Next.

    If you want to install a dedicated SWO Agent on a dedicated host, add the host and then add the NGINX integration. See Add a self-managed host

  4. Select where the NGINX service is located:

    • On Host: The NGINX service runs on the same physical or virtual machine as the SWO Agent.

    • Off Host: The NGINX service runs on a different physical or virtual machine than the SWO Agent.

  5. Make sure that NGINX is ready to be integrated. NGINX must expose status information.

    1. Run a command to check that the status module is enabled.

    2. nginx -V 2>&1 | grep -o with-http_stub_status_module
    3. Search for with-http_stub_status_module in the output. If the output file doesn't include it, enable the https_stub_status_module. Refer to NGINX documentation for details.

    4. Open the NGINX configuration file and make sure the stub_status_module is enabled. By default, the configuration file is located at /etc/nginx/sites-available/default.

      Example: enabled stub_status_module

      location /status {
      	stub_status;
      	allow 127.0.0.1; #only allow requests from localhost
      	deny all; #deny all other hosts}

      Example: stub_status_module not configured

      server {
      	listen 80 default_server;
      	listen [::]:80 default_server;
      							
      	root /var/www/html;
      							
      	server_name_;
      							
      	location /status {ADD STUB_STATUS INFO HERE}
      } 
    5. Run the following command to check the NGINX configuration file for errors. If there are errors, resolve them.

      nginx -t
    6. If there are no errors, restart the NGINX service using this command.

      nginx -s reload
    7. Run the command to call the status URL. The call should return basic status data.

      curl http://localhost:80/status
    8. Click Next.

  6. Review the configuration and click Next to deploy the changes to the agent.

    • Review the NGINX Endpoint.

    • Review the Collection interval.

    • Review the logs location and make sure the Agent has access to the NGINX log folder. You can grant the access using the following command.

      sudo usermod -a -G adm swagent
  7. Optional: When the installation is complete, you can continue to observe NGINX data. Use the buttons on the Summary screen.

When you complete the configuration, SolarWinds Observability displays data collected for the NGINX instance entity. See Entity Explorer for details.