deployer/docs/contrib/newrelic.md
robertsimionescu dfd89e254f
moved newrelic endpoint to config and used it when posting to api (#3374)
* moved newrelic endpoint to config and used it when posting to api

* ran bin/docgen for the commit

* mentioned the new setting for documentation

Co-authored-by: RobertOS <robert.simionescu@gmail.com>
2023-01-08 21:34:11 +01:00

1.5 KiB
Raw Blame History

Newrelic Recipe

require 'contrib/newrelic.php';

Source

Configuration

  • newrelic_app_id newrelic's app id
  • newrelic_api_key newrelic's api key
  • newrelic_description message to send
  • newrelic_endpoint newrelic's REST API endpoint

Usage

Since you should only notify New Relic of a successful deployment, the newrelic:notify task should be executed right at the end.

after('deploy', 'newrelic:notify');

Configuration

newrelic_app_id

Source

:::info Required Throws exception if not set. :::

newrelic_description

Source

return runLocally('git log -n 1 --format="%an: %s" | tr \'"\' "\'"');

newrelic_revision

Source

return runLocally('git log -n 1 --format="%h"');

newrelic_endpoint

Source

'api.newrelic.com'

Tasks

newrelic:notify

Source

Notifies New Relic of deployment.