ersoy-insider/newrelic-custom-event

Sends custom events to newrelic insights

1.0.2 2018-03-04 09:52 UTC

This package is not auto-updated.

Last update: 2020-08-13 06:46:34 UTC


README

Simple Library to send custom events to NewRelic Insights

Coverage Status Build Status StyleCI Scrutinizer Code Quality

Installation For Lumen

Require this package with Composer

$ composer require ersoy-insider/newrelic-custom-event

or composer.json

"require": {
  "ersoy-insider/newrelic-custom-event": "^1.0"
},

Configuration

Add service provider

$app->register(\ErsoyInsider\NewrelicCustomEvent\NewRelicCustomEventServiceProvider::class);

If you want to use facade, add following line

$app->withFacades(true, [
    '\ErsoyInsider\NewrelicCustomEvent\Facades\NewRelicDispatcher' => 'NewRelicDispatcher'
]);

Copy the /vendor/ersoy-insider/newrelic-custom-event/config/new-relic-custom-event.php file to your local config directory. Edit config/new-relic-custom-event.php for your NewRelic credentials.

Basic usage

app('new-relic-dispatcher')->fire($properties);

or

\NewRelicDispatcher::fire($properties);
$properties = [
    'jobName' => 'test',
    'users' => [
        ['id' => 5, 'name' => 'testasdada'],
        ['id' => 55, 'name' => 'test3'],
        ['id' => 555, 'name' => 'test2'],
        ['id' => 5555, 'name' => 'test4'],
    ],
    'test' => 'another-parameter',
    'yet-another' => 'parameter',
    'will-be' => ['discarded'] // it will be discarded
    'will-not-be' => 'discarded' // it will not be discarded
];
  • $properties is basic array consist of key values.
  • Only users key's value is allowed to array, any other key of which value is discarded because of NewRelic's policy.
  • Events will be queued for delivery to NewRelic's Insights.