New Relic Infrastructure Integration for NGINX

New Relic Infrastructure Integration for NGINX captures critical performance metrics and inventory reported by NGINX server. There is an open source and a commercial version of NGINX, both supported by this integration.

Inventory data is obtained from the configuration files and metrics from the status modules.

Configuration

Depending on which NGINX edition you use please update your configuration enabling
- HTTP stub status module for NGINX Open Source
- HTTP status module for NGINX Plus

Installation

download an archive file for the NGINX Integration
extract nginx-definition.yml and /bin directory into /var/db/newrelic-infra/newrelic-integrations
add execute permissions for the binary file nr-nginx (if required)
extract nginx-config.yml.sample into /etc/newrelic-infra/integrations.d

Usage

This is the description about how to run the NGINX Integration with New Relic Infrastructure agent, so it is required to have the agent installed (see agent installation).

In order to use the NGINX Integration it is required to configure nginx-config.yml.sample file. Firstly, rename the file to nginx-config.yml. Then, depending on your needs, specify all instances that you want to monitor. Once this is done, restart the Infrastructure agent.

You can view your data in Insights by creating your own custom NRQL queries. To do so use the NginxSample event type.

Integration development usage

Assuming that you have source code you can build and run the NGINX Integration locally.

Go to directory of the NGINX Integration and build it

$ make

The command above will execute tests for the NGINX Integration and build an executable file called nr-nginx in bin directory.

$ ./bin/nr-nginx

If you want to know more about usage of ./nr-nginx check

$ ./bin/nr-nginx -help

For managing external dependencies govendor tool is used. It is required to lock all external dependencies to specific version (if possible) into vendor directory.

Contributing Code

We welcome code contributions (in the form of pull requests) from our user community. Before submitting a pull request please review these guidelines.

Following these helps us efficiently review and incorporate your contribution and avoid breaking your code with future changes to the agent.

Custom Integrations

To extend your monitoring solution with custom metrics, we offer the Integrations Golang SDK which can be found on github.

Refer to our docs site to get help on how to build your custom integrations.

Support

You can find more detailed documentation on our website, and specifically in the Infrastructure category.

If you can't find what you're looking for there, reach out to us on our support site or our community forum and we'll be happy to help you.

Find a bug? Contact us via support.newrelic.com, or email support@newrelic.com.

New Relic, Inc.

djenniex-bene / nri-nginx