NGINX

For NGINX, DESK provides information about:

  • All incoming requests.
  • Outgoing requests that originate from one of the following:
    • ngx_http_proxy_module (proxy_pass)
    • ngx_http_fastcgi_module (fastcgi_pass)
    • ngx_http_memcached_module (memcached_pass)
    • ngx_http_scgi_module (scgi_pass)
    • ngx_http_uwsgi_module (uwsgi_pass)|
  • Capture extended NGINX Plus metrics.

Supported NGINX versions

OneAgent support for NGINX is based on tested NGINX binaries. The following images will help you to determine if a release is qualified for OneAgent support:

NGINX supported versions

In DESK, an informational message appears on the NGINX process details when an attempt is made to instrument an unsupported binary or the API for extended NGINX Plus metrics is not accessible.

Nginx version Vendor released Vendor End of life Supported by DESK until First supported OneAgent Version Last supported OneAgent Version
1.4 - 1.11.4
1.11.5+ 1.145
1.11.5+ 1.169
Nginx Plus version Vendor released Vendor End of life Supported by DESK until First supported OneAgent Version Last supported OneAgent Version
R1 - R10
R11+ 1.145
R11+ 1.169
Tengine version Vendor released Vendor End of life Supported by DESK until First supported OneAgent Version Last supported OneAgent Version
1.4.2 - 2.2.3 1.173
OpenResty version Vendor released Vendor End of life Supported by DESK until First supported OneAgent Version Last supported OneAgent Version
1.11.2.x
1.13.6.x, 1.15.8.x

Support for NGINX 1.11.5+, NGINX Plus R11+

Standard NGINX package sources are regularly discovered by DESK to support the latest binaries.

Support for the latest NGINX releases is included in the next subsequent OneAgent releases (usually within two weeks of each NGINX release). Support for latest NGINX Plus API may differ from NGINX binary support.

Support for NGINX 1.4 - 1.11.4, NGINX Plus R1 - R10

OneAgent uses NGINX debug information from the NGINX packages for instrumentation of NGINX. Standard NGINX package sources are regularly discovered by DESK to support new binaries.

Here is the list of supported binaries, for which DESK has debug information available:

For other binaries (for example, custom builds), you need to provide the debug packages locally.

Support for Tengine

Tengine is based on NGINX and provides some advanced capabilties.

NGINX Plus metrics

NGINX Plus metrics are captured from NGINX Plus Status API (up to R15) or NGINX Plus API (R16+).

The API needs to be turned on and accessible from OneAgent. In case the API is protected by NGINX authentication, make sure that it's accessible from localhost for HTTP-GET requests.