This module is an nginx module for seemless reporting of every request to newrelic.

This enables you to monitor the latency and throughput of every nginx endpoint, including static content, native modules, lua modules, fastcgi, proxy requests and so on.

Reporting is done via the Newrelic Agent SDK. Implementation was based on an initial work done by the Newrelic team.

Inside your main nginx.conf, or any enabled config file, add on the http level config:

http {
	...
    newrelic on;
	newrelic_license_key my-newrelic-key;
	newrelic_app_name my-app-name;

This will enable newrelic transaction reporting on all defined servers and locations. The default newrelic transaction name will be the endpoint uri (without parameters). For each location, you can change the transaction name by

http {
  ...
  server {
    ...
	location /some_location {
	    newrelic_transaction_name some_other_name;
	...
	}
	
	
	location /no_report_location {
		newrelic off; # turn off newrelic reporting for this location
		...
	}

This module uses the Newrelic Agent SDK for communicating with newrelic.

Download and install it by running the following:

NR_SDK_VER=0.16.1.0
wget https://download.newrelic.com/agent_sdk/nr_agent_sdk-v${NR_SDK_VER}-beta.x86_64.tar.gz
tar xvfz nr_agent_sdk-v${NR_SDK_VER}-beta.x86_64.tar.gz
cd nr_agent_sdk-v${NR_SDK_VER}-beta.x86_64
sudo cp include/*h /usr/local/include/
sudo cp lib/*so /usr/local/lib/
sudo ldconfig

You will need to compile nginx from source in order to add this module.

• Clone this repository
• Install the Newrelic Agenst SDK - see here
• Download nginx source, extract and chdir to its root folder
• Configure with

./configure --add-module=/path/to/this/folder

• Run make && sudo make install

Check the nginx documentation for other configure options (it usually defaults to /opt/nginx)

Notes:

• If you use the tengine web server (an nginx fork which supports dynamic modules), you can compile this module using sudo /opt/nginx/sbin/dso_tool --add-module=/path/to/this/folder
• Tested on nginx 1.6, tengine 1.5.2, although should work on any nginx version, and also on the openresty fork.

Some of the information here was recevied from the newrelic team.

• Only 10K concurrent transactions are supported by the Newrelic Agent SDK
• The newrelic agent opens an additional thread for each worker, doing the harvesting and reporting. It reports once per minute.
• If you have internal locations or other non-standard locations, turn off newrelic for those locations by setting newrelic off;