deployer/docs/contrib/newrelic.md
Anton Medvedev 3216576680 Add docs
2021-09-26 15:25:58 +02:00

68 lines
1.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- DO NOT EDIT THIS FILE! -->
<!-- Instead edit contrib/newrelic.php -->
<!-- Then run bin/docgen -->
# newrelic
[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)
Notifying New Relic of deployment.