/nginx-otel

Our fork of Nginx inc's Opentelemetry module, extended to build better in containerized environments.

Primary LanguagePerlApache License 2.0Apache-2.0

NGINX OpenTelemetry module container

This repository

This repository contains our fork of NGINX inc's OpenTelemetry module. This module is useful for using OpenTelemetry tracing in NGINX, to help keep track of microservice dataflow in production environments.

Our changes

Our changes to upstream include:

  • Improving the CMAKE config to make it build faster on systems that already have GRPC and Protobuf headers installed
  • Bundling the module into NGINX inc's nginx-unprivileged container image to make a production-ready NGINX container image with OpenTelemetry tracing support.

Using this container image

This container image is functionally identical to nginx-unprivileged; The only change is that the ngx_otel_module.so module is installed and loaded, enabling NGINX to send trace data to OpenTelemetry.

Image tags are identical to those published by nginx-unprivileged, we track against the alpine3.18-slim series. We build for both amd64 and arm64 architectures.

Configuring the NGINX OpenTelemetry module

Documentation for configuring the NGINX OpenTelemetry module can be found here.

License

Apache License, Version 2.0

NGINX is a trademark of F5, inc.

© F5, Inc. 2023