deployer/docs/contrib/newrelic.md

<!-- DO NOT EDIT THIS FILE! -->
<!-- Instead edit contrib/newrelic.php -->
<!-- Then run bin/docgen -->

# Newrelic Recipe

[Source](/contrib/newrelic.php)



## Installing

Add to your _deploy.php_

```php
require 'contrib/newrelic.php';
```

## Configuration

- `newrelic_app_id` – newrelic's app id
- `newrelic_api_key` – newrelic's api key
- `newrelic_description` – message to send

## Usage

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

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



## Configuration
### newrelic_app_id
[Source](https://github.com/deployphp/deployer/blob/master/contrib/newrelic.php#L30)





### newrelic_description
[Source](https://github.com/deployphp/deployer/blob/master/contrib/newrelic.php#L34)





### newrelic_revision
[Source](https://github.com/deployphp/deployer/blob/master/contrib/newrelic.php#L38)






## Tasks

### newrelic:notify
[Source](https://github.com/deployphp/deployer/blob/master/contrib/newrelic.php#L43)

Notifies New Relic of deployment.