https://github.com/nitro/nginx-nr-agent

12-factor, Go re-implementation of the Nginx New Relic plugin
https://github.com/nitro/nginx-nr-agent

golang newrelic nginx

Last synced: 4 months ago
JSON representation

12-factor, Go re-implementation of the Nginx New Relic plugin

• Host: GitHub
• URL: https://github.com/nitro/nginx-nr-agent
• Owner: Nitro
• License: mit
• Created: 2017-05-11T10:03:39.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-09-20T13:58:56.000Z (over 6 years ago)
• Last Synced: 2024-10-11T18:05:38.417Z (4 months ago)
• Topics: golang, newrelic, nginx
• Language: Go
• Homepage:
• Size: 612 KB
• Stars: 5
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Nginx New Relic Plugin

----------------------

[![](https://travis-ci.org/Nitro/nginx-nr-agent.svg?branch=master)](https://travis-ci.org/Nitro/nginx-nr-agent)

[![](https://goreportcard.com/badge/github.com/Nitro/nginx-nr-agent)](https://goreportcard.com/report/github.com/Nitro/nginx-nr-agent)

This is a re-implementation of the official [NGiNX New Relic plugin][1] in Go so

that it compiles down to a static binary with no Python runtime required. It

only grabs the stats that are including the [http-stub-status][2] module and does

not add all the stats available from NGiNX Plus.

Aside from being just a static binary, it's also a [12-factor][3] app which is good

for running in containers:

* All configuration is from environment variables

* Logging is to stdout

On startup the plugin prints its configuration to the log so you can see how

it ran.

Build

------

You need [Golang/dep](https://github.com/golang/dep) in order to build the

project. Run the following commands to fetch dependencies:

```

$ go get github.com/golang/dep/cmd/dep

$ dep ensure

```

Then build:

```

$ go build

```

Example Config

--------------

```

AGENT_NEW_RELIC_APP_NAME="NGiNX Gateway Foo" \

AGENT_STATS_URL=http://localhost:32768/health \

AGENT_NEW_RELIC_LICENSE_KEY="" \

./nginx-nr-agent

```

You can also change the New Relic API URL used like this:

```

AGENT_NEW_RELIC_API_URL=""

```

Generally this is not a setting you'll need to change.

[1]: https://github.com/skyzyx/nginx-nr-agent

[2]: http://nginx.org/en/docs/http/ngx_http_stub_status_module.html

[3]: https://www.12factor.net