• 27 Mar 2023
  • 1 Minute to read
  • PDF


  • PDF

Article Summary

The topic details steps to install and configure Traceable's NGINX tracing agent, along with the supported NGINX version. Traceable supports both NGINX enterprise and NGINX community editions.

Traceable provides an NGINX tracing agent that you can deploy for monitoring and blocking user requests. The NGINX tracing agent is agnostic to the type of NGINX deployment, for example, your NGINX could be deployed as a reverse proxy or as a load balancer. The Tracing agent connects to the Traceable Platform agent, which further sends the data to the Traceable platform for more in-depth analysis.

The following diagram shows an example of NGINX plugin deployment:

The plugin connects to the Traceable Platform Agent (TPA). The TPA further sends the data to Traceable’s platform for further analysis. The following flow chart summarizes the entire deployment steps:

Before you begin

Read through the following points before you install Traceable’s NGINX Tracing agent.

  • NGINX knowledge - Make sure you have basic knowledge of NGINX and nginx.conf. For more information, see Creating NGINX Plus and NGINX Configuration Files.
  • compat flag - NGINX to which the plugin attaches must be compiled with --with-compat flag.
Traceable only captures the default value set for client_body_buffer_size configuration. This NGINX configuration controls the memory allocated to hold the request body. If the request size is larger than the default value, Traceable does not capture the excess value. For more information on client_body_buffer_size, see NGINX directives documentation.

Choose your NGINX deployment

Choose your NGINX deployment to navigate to instructions specific to each flavor of NGINX.

Was this article helpful?

What's Next