OpenTracing

Note:
The module no longer available since F5 NGINX Plus Release 34. The OpenTelemetry module is available since NGINX Plus Release 29 that incorporates the features of the OpenTracing module.

Installation

  1. Check the Technical Specifications page to verify that the module is supported by your operating system.

  2. Install the OpenTracing module package nginx-plus-module-opentracing.

    For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:

    sudo yum update && \
sudo yum install nginx-plus-module-opentracing
    Note:
    the OpenTracing module cannot be installed on CentOS 6, Oracle Linux 6, and RHEL 6.

    For Amazon Linux 2023, AlmaLinux, Rocky Linux:

    sudo dnf update && \
sudo dnf install nginx-plus-module-opentracing

    For Debian and Ubuntu:

    sudo apt update && \
sudo apt install nginx-plus-module-opentracing

    For SLES:

    sudo zypper refresh && \
sudo zypper install nginx-plus-module-opentracing
    Note:
    the OpenTracing module cannot be installed on SLES 12.

    For Alpine:

    apk add nginx-plus-module-opentracing

    For FreeBSD:

    sudo pkg update && \
sudo pkg install nginx-plus-module-opentracing

Configuration

After installation you will need to enable and configure the module in NGINX Plus configuration file nginx.conf.

  1. Enable dynamic loading of the module with the load_module directive specified in the top-level (“main”) context:

    load_module modules/ngx_http_opentracing_module.so;

http {
    # ...
}

  2. Perform additional configuration as required by the module. You will also need to install a tracer (“portable binary plugin”) for your selected service.

  3. Test the NGINX Plus configuration. In a terminal, type-in the command:

    nginx -t

    Expected output of the command:

    nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf is successful

  4. Reload the NGINX Plus configuration to enable the module:

    nginx -s reload

More Info