With the NGINX code module of OneAgent, you can get observability for your NGINX instances and processed web requests.
Observability for
Including
Incoming web requests
All incoming web requests to NGINX
Outgoing web requests
Outgoing web requests originating from a supported module of NGINX
NGINX HTTP connection metrics
NGINX Plus metrics
Server zones
Upstreams
Caches
NGINX deep monitoring is currently not supported on Windows.
See OneAgent support matrix for more details.
Dynatrace supports a variety of NGINX, NGINX Plus, OpenResty, and Tengine versions, see the tables below. A notification appears on the NGINX process page in the Dynatrace web UI if an attempt is made to instrument an unsupported version.
If your OneAgent build date is newer than a specific NGINX release date, the NGINX code module may be able to instrument your NGINX release even if it's not listed in the supported version tables.
The OneAgent build date is part of the OneAgent intaller version, for example 1.254.0.20221012-201831.
Support for the latest NGINX release is typically included in the next subsequent OneAgent releases.
The NGINX code module uses debug information from the NGINX packages for instrumenting NGINX. Standard NGINX package sources are regularly discovered by Dynatrace to support new binaries. If you use other binaries (for example, custom builds), you need to provide their debug packages locally.
The following image can help you to determine if a NGINX release is qualified for support:
Support for the latest NGINX Plus release may differ from the NGINX support lifecycle, but we aim to stay current.
Support for the latest OpenResty release may differ from the NGINX support lifecycle, but we aim to stay current.
Support for the latest Tengine release may differ from the NGINX support lifecycle, but we aim to stay current.
The NGINX module captures HTTP connection metrics if you build your NGINX with http_stub_status_module.
Use the --with-http_stub_status_module
configuration parameter.
Invoke nginx -V
on your command line. This will return the NGINX configuration parameters.
Make sure that the output contains the --with-http_stub_status_module
parameter.
The NGINX module captures NGINX Plus metrics from NGINX Plus Status API (up to R15) or NGINX Plus API (R16+).
The API needs to be turned on and accessible by the NGINX module. If the API is protected by NGINX authentication, ensure it's accessible from localhost for HTTP GET requests. The Nginx module requires the API configuration to be available from the start (adding the configuration during Nginx runtime and reloading it is not supported).
A notification appears on the NGINX process page in Dynatrace if the API for extended NGINX Plus metrics is not accessible.