igormatkovic/laravel-newrelic

Minimal NewRelic Functionality for Laravel

v0.1.2 2022-10-06 20:05 UTC

Requires

• php: ^8.0
• guzzlehttp/guzzle: ^7.4
• illuminate/contracts: ^8.0 || ^9.0
• illuminate/support: ^8.0 || ^9.0

Requires (Dev)

• orchestra/testbench: ^7.0 || ^6.0
• phpunit/phpunit: ^9.3

MIT

• laravel
• newrelic

README

Simple NewRelic integration that names the APP in Newrelic for both CLI and Web requests.
It also includes a helper for the synthetics monitor and a deployment command helper.

Installation

You can install the package via composer:

composer require igormatkovic/laravel-newrelic

You can publish the config file with:

php artisan vendor:publish

These are the ENV variables you can edit

NEWRELIC_APP_NAME=MY.domain.com
NEWRELIC_API_KEY=some-api-key
NEWRELIC_APP_ID=1234567
NEWRELIC_DEFAULT_USER=[e-mail]

# Optional
NEWRELIC_ENABLED=true
NEWRELIC_MONITOR_ENABLED=true
NEWRELIC_MONITOR_ENDPOINT="newrelic/ping"
NEWRELIC_MONITOR_RESPONSE=pong

Usage

Out of the box the App will automatically name the APP in NewRelic.

Synthetics Monitor Setup

NewRelic > Synthetic monitoring
Click on the Create Monitor > Availability

Populate the fields:

Name: Ping Monitor 
Url: https://mydomain.com/newrelic/ping

#Advanced Options
Text validation: pong

Deployment Logging

After each deployment you should run the Deployment trigger

Example if you are using Envoyer

php artisan newrelic:deploy "{{message}}" --user="{{author}}" --revision="{{sha}}" --changelog="Deployed from: {{branch}}"

Testing

composer test

Credits

• Igor Matkovic
• JackWH/laravel-new-relic

License

The MIT License (MIT)