Nudger is a New Relic metrics importer for StatusPage.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
vendor
.gitignore
CODE_OF_CONDUCT.md
Dockerfile
LICENCE
Procfile
README.markdown
cibuild.sh
circle.yml
docker_build.sh
nudger.go
nudger.sample.json
nudger_test.go

README.markdown

Nudger

Nudger is a New Relic metrics importer for StatusPage.

It periodically queries the New Relic REST API (v2), and sends those metrics to StatusPage.

Nudger is different to StatuPage's built-in New Relic integration because it allows you to:

  • Pull metrics from multiple New Relic accounts into a single StatusPage account.
  • Pull metrics from one New Relic account into multiple StatusPage accounts.
  • Pull metrics from multiple New Relic accounts into multiple StatusPage accounts.

Using

Nudger can pass the following metrics for an application from New Relic to StatusPage:

  • Response time
  • Throughput
  • Error rate

StatusPage config

On StatusPage, for each of the metrics you want to display (i.e. response time, throughput, error rate) you need to add a new Public Metric with a custom data source.

Once you set up a custom data source with a Display Name and Display Suffix, you'll be provided with:

  • An API key (sp_api_key in the Nudger config)
  • A page id (sp_page_id in the Nudger config)
  • A metric id (the value of metrics[key] in the Nudger config)

You'll need these to configure Nudger.

New Relic config

To get the application id, from the New Relic console, browse to the application, and pick the application id out of the URL.

For example, the application id in https://rpm.newrelic.com/accounts/1246480/applications/12325670 is 12325670.

This value maps to the nr_app_id field in the Nudger config.

To get the API key, from the New Relic console, go to the Account Settings, and under Integrations browse to the API keys section.

Reveal the API key, and note it down into the Nudger config as nr_api_key.

Nudger config

In the Nudger config file, you define New Relic applications that should be scraped, and the StatusPage page + metric that should be updated:

[
  {
    "nr_api_key": "b1946ac92492d2347c6235b4d2611184",
    "nr_app_id": 12345678,
    "sp_api_key": "a1b271ae-3444-48ac-9060-a1b3c4444",
    "sp_page_id": "trx08hfqyabc",
    "metrics": {
      "response_time": "abcw0cv8wh6l",
      "error_rate": "defd9hl632ch",
      "throughput": "ghizztk3p4t4"
    }
  }
]

You can define multiple applications in this config file by giving each app its own configuration section:

[
  {
    "nr_api_key": "b1946ac92492d2347c6235b4d2611184",
    "nr_app_id": 12345678,
    "sp_api_key": "a1b271ae-3444-48ac-9060-a1b3c4444",
    "sp_page_id": "trx08hfqyabc",
    "metrics": {
      "response_time": "abcw0cv8wh6l",
      "error_rate": "defd9hl632ch",
      "throughput": "ghizztk3p4t4"
    }
  },
  {
    "nr_api_key": "591785b794601e212b260e25925636fd",
    "nr_app_id": 98765412,
    "sp_api_key": "a1b3c4444-9060-48ac-3444-a1b271ae",
    "sp_page_id": "qwop8hfqy123",
    "metrics": {
      "response_time": "defd9hl632ch",
      "error_rate": "abcw0cv8wh6l",
      "throughput": "jik123hk3pabc"
    }
  }
]

You can omit metrics you don't want to push to StatusPage by not including a definition for them. For example:

[
  {
    "nr_api_key": "b1946ac92492d2347c6235b4d2611184",
    "nr_app_id": 12345678,
    "sp_api_key": "a1b271ae-3444-48ac-9060-a1b3c4444",
    "sp_page_id": "trx08hfqyabc",
    "metrics": {
      "response_time": "abcw0cv8wh6l",
    }
  }
]

Running Nudger

Start nudger by running:

nudger

By default it tries to read a config file from ./nudger.json

You can change the path to read the config from with:

nudger --config=/path/to/my/nudger.json

You can enable extra debugging messages with:

nudger --debug

Finally, you can see all the options for configuring Nudger by running:

nudger --help

These arguments can also be configured with environment variables:

Name Description Example
DEBUG Toggle debug mode. true or false
CONFIG_PATH Path to Nudger's config file. /etc/nudger.json
INTERVAL Frequency to poll New Relic. 30s or 5m or 1h
PORT Where Nudger's stats can be accessed. 8080

Operating

Nudger exposes metrics about how it is behaving via http.

By default Nudger exposes these metrics at http://localhost:8181/debug/vars. You can control the port by setting the PORT environment variable.

Along with the standard expvar metrics (cmdline, memstats), Nudger also exposes the following metrics:

Name Type Description
newrelic.requests Counter Number of requests to New Relic made by Nudger.
newrelic.apps.response_time Counter Number of times a response time metric was pulled from an application on New Relic.
newrelic.apps.throughput Counter Number of times a throughput metric was pulled from an application on New Relic.
newrelic.apps.error_rate Counter Number of times an error rate metric was pulled from an application on New Relic.
newrelic.errors.http.new Counter Unsuccessful attempts at creating a request to New Relic.
newrelic.errors.http.do Counter Unsuccessful attempts at performing a request to New Relic.
newrelic.errors.http.readbody Counter Unsuccessful attempts at reading a response from New Relic.
newrelic.errors.json.decode Counter Unsuccessful attempts at decoding JSON response from New Relic.
statuspage.requests Counter Number of requests to StatusPage made by Nudger.
statuspage.errors.json.marshal Counter Unsuccessful attempts at encoding JSON request to be sent to StatusPage.
statuspage.errors.http.new Counter Unsuccessful attempts at creating a request to StatusPage.
statuspage.errors.http.do Counter Unsuccessful attempts at performing a request to StatusPage.
statuspage.errors.http.readbody Counter Unsuccessful attempts at reading a response from StatusPage.
statuspage.errors.http.status Counter Number of times response status from StatusPage was not 201.

Developing

git clone git@github.com:ausdto/nudger.git
cd nudger
cp nudger.sample.json nudger.test.json
foreman start