SEJeff / nginx-opentracing

NGINX plugin for OpenTracing

nginx-opentracing

Enable requests served by nginx for distributed tracing via The OpenTracing Project.

Dependencies

• The C++ OpenTracing Library
• A C++ OpenTracing Tracer. It currently works with Jaeger, Zipkin, or LightStep.
• Source for Nginx 1.9.13 or later.

Docker

A docker image rnburn/nginx-opentracing is provided to support using nginx with OpenTracing in a manner analogous to the nginx Docker image. See here for examples of how to use it.

Building

$ tar zxvf nginx-1.9.x.tar.gz
$ cd nginx-1.9.x
$ ./configure --add-dynamic-module=/absolute/path/to/nginx-opentracing/opentracing \
              # To enable tracing with Jaeger
              --add-dynamic-module=/absolute/path/to/nginx-opentracing/jaeger \
              # To enable tracing with Zipkin
              --add-dynamic-module=/absolute/path/to/nginx-opentracing/zipkin \  
              # To enable tracing with LightStep
              --add-dynamic-module=/absolute/path/to/nginx-opentracing/lightstep
$ make && sudo make install

Getting Started

# Load the OpenTracing dynamic module.
load_module modules/ngx_http_opentracing_module.so;

# Load a vendor OpenTracing dynamic module.
# For example,
#   load_module modules/ngx_http_jaeger_module.so;
# or
#   load_module modules/ngx_http_zipkin_module.so;
# or
#   load_module modules/ngx_http_lightstep_module.so;

http {
  # Configure your vendor's tracer.
  # For example,
  #     jaeger_service_name my-nginx-server;
  #     ...
  # or
  #     zipkin_collector_host localhost;
  #     ...
  # or
  #     lightstep_access_token ACCESSTOKEN;
  #     ....

  # Enable tracing for all requests.
  opentracing on;

  # Optionally, set additional tags.
  opentracing_tag http_user_agent $http_user_agent;

  location ~ \.php$ {
    # The operation name used for spans defaults to the name of the location
    # block, but you can use this directive to customize it.
    opentracing_operation_name $uri;

    fastcgi_pass 127.0.0.1:1025;
  }
}

See Tutorial for a more complete example, Reference for a list of available OpenTracing-related directives, and Jaeger, Zipkin, and LightStep for a list of vendor tracing directives.