scott-kennedy/shipit-newrelic

Notify New Relic about your deploy

shipit-newrelic

Shipit plugin for notifying New Relic about your deploy. Defaults to using shipit-deploy events.

Features:

• Basic announce to New Relic

Install

No install yet, sorry.

Usage

Example shipitfile.js

module.exports = function (shipit) {
  require('shipit-deploy')(shipit);
  require('shipit-newrelic')(shipit);

  shipit.initConfig({
    default: {
      workspace: '/tmp/github-monitor',
      deployTo: '/tmp/deploy_to',
      repositoryUrl: 'https://github.com/user/repo.git',
      ignores: ['.git', 'node_modules'],
      keepReleases: 2,
      deleteOnRollback: false,
      key: '/path/to/key',
      shallowClone: true
    },
    staging: {
      servers: 'user@myserver.com'
      newrelic: {
        applicationId: '<my_new_relic_application_id>',
        apiKey: '<my_new_relic_api_key>'
      }
    }
  });
};

The notifier will trigger on the 'published' event so you can use shipit-deploy by default or your own shipit task so long as you emit a published event.

shipit staging deploy

Options

applicationId

Type: String (Either applicationId or applicationName is required)

Your New Relic application id.

applicationName

Type: String (Either applicationId or applicationName is required)

New Relic application name

apiKey

Type: String

New Relic API Key

Dependencies

Local

• git 1.7.8+

License

MIT