OpenTracing
Instrument NGINX with OpenTracing-compliant requests for a range of distributed tracing services, such as Zipkin, Jaeger and Datadog. Note that the opentracing module provides the framework for recording traces; you will also need to install a service-specific tracing module. This module (“tracer”) pushes traces to the collector and analyser provided by that service.
Note: Since NGINX Plus Release 29, the OpenTelemetry module is available that incorporates the features of the OpenTracing module.
Installation Instructions
-
Install the OpenTracing module.
For Amazon Linux, CentOS, Oracle Linux, and RHEL:
$ yum install nginx-plus-module-opentracing
Note: the OpenTracing module cannot be installed on CentOS 6, Oracle Linux 6, and RHEL 6.
For Debian and Ubuntu:
$ apt-get install nginx-plus-module-opentracing
For SLES:
$ zypper install nginx-plus-module-opentracing
Note:: the OpenTracing module cannot be installed on SLES 12.
For Alpine:
$ apk add nginx-plus-module-opentracing
-
Put the
load_module
directive in the top‑level (“main
”) context of NGINX Plus configuration file, nginx.conf:load_module modules/ngx_http_opentracing_module.so;
-
Perform additional configuration as required by the module. You will also need to install a tracer (“portable binary plugin”) for your selected service.
-
Reload NGINX Plus to enable the module:
$ nginx -t && nginx -s reload