Add support for Queued Job transactions (#48)

Queued jobs should also have intelligent naming, and be marked properly as background tasks.

Author: danhunsaker

src/Intouch/LaravelNewrelic/LumenNewrelicServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace Intouch\LaravelNewrelic;
 
+use Illuminate\Queue\Events\JobProcessed;
 use Illuminate\Support\ServiceProvider;
 use Intouch\Newrelic\Newrelic;
 
@@ -21,5 +22,43 @@ function ( $app ) {
 				return new Newrelic( $app['config']->get( 'newrelic.throw_if_not_installed' ) );
 			}
 		);
+
+		app('queue')->before(function (JobProcessed $event) {
+			app('newrelic')->backgroundJob( true );
+			app('newrelic')->startTransaction( ini_get('newrelic.appname') );
+			if (app('config')->get( 'newrelic.auto_name_jobs' )) {
+				app('newrelic')->nameTransaction( $this->getJobName($event) );
+			}
+		});
+
+		app('queue')->after(function (JobProcessed $event) {
+			app('newrelic')->endTransaction();
+		});
+	}
+
+	/**
+	* Build the job name
+	*
+	* @return string
+	*/
+	public function getJobName(JobProcessed $event)
+	{
+		return str_replace(
+			[
+				'{connection}',
+				'{class}',
+				'{data}',
+				'{args}',
+				'{input}',
+			],
+			[
+				$event->connectionName,
+				get_class($event->job),
+				json_encode($event->data),
+				implode(', ', array_keys($event->data)),
+				implode(', ', array_values($event->data)),
+			],
+			$this->app['config']->get( 'newrelic.job_name_provider' )
+		);
 	}
 }

src/Intouch/LaravelNewrelic/NewrelicServiceProvider.php

@@ -16,6 +16,7 @@
  */
 namespace Intouch\LaravelNewrelic;
 
+use Illuminate\Queue\Events\JobProcessed;
 use Illuminate\Routing\Events\RouteMatched;
 use Illuminate\Support\ServiceProvider;
 use Intouch\Newrelic\Newrelic;
@@ -42,6 +43,7 @@ public function boot()
 		$this->publishes( [ $config => config_path( 'newrelic.php' ) ], 'config' );
 
 		$this->registerNamedTransactions();
+		$this->registerQueueTransactions();
 	}
 
 	/**
@@ -83,6 +85,26 @@ protected function registerNamedTransactions()
 		}
 	}
 
+	/**
+	 * Registers the queue transactions with the NewRelic PHP agent
+	 */
+	protected function registerQueueTransactions()
+	{
+		$app = $this->app;
+
+		$app['queue']->before(function (JobProcessed $event) use ( $app ) {
+			$app['newrelic']->backgroundJob( true );
+			$app['newrelic']->startTransaction( ini_get('newrelic.appname') );
+			if ($app['config']->get( 'newrelic.auto_name_jobs' )) {
+				$app['newrelic']->nameTransaction( $this->getJobName($event) );
+			}
+		});
+
+		$app['queue']->after(function (JobProcessed $event) use ( $app ) {
+			$app['newrelic']->endTransaction();
+		});
+	}
+
 	/**
 	 * Build the transaction name
 	 *
@@ -109,6 +131,32 @@ public function getTransactionName()
 		);
 	}
 
+	/**
+	 * Build the job name
+	 *
+	 * @return string
+	 */
+	public function getJobName(JobProcessed $event)
+	{
+		return str_replace(
+			[
+			    '{connection}',
+			    '{class}',
+			    '{data}',
+			    '{args}',
+			    '{input}',
+			],
+			[
+			    $event->connectionName,
+			    get_class($event->job),
+			    json_encode($event->data),
+			    implode(', ', array_keys($event->data)),
+			    implode(', ', array_values($event->data)),
+			],
+			$this->app['config']->get( 'newrelic.job_name_provider' )
+		);
+	}
+
 	/**
 	 * Get the request method
 	 *

src/config/config.php

@@ -17,6 +17,15 @@
 	 */
 	'auto_name_transactions' => env('NEWRELIC_AUTO_NAME_TRANSACTION', true),
 
+	/*
+	 * Will automatically name queued jobs in NewRelic,
+	 * using the Laravel job class, data, or connection name.
+	 *
+	 * Set this to false to use the NewRelic default naming
+	 * scheme, or to set your own in your application.
+	 */
+	'auto_name_jobs' => env('NEWRELIC_AUTO_NAME_JOB', true),
+
 	/*
 	 * Define the name used when automatically naming transactions.
 	 * a token string:
@@ -33,6 +42,23 @@
 	 */
 	'name_provider' => env('NEWRELIC_NAME_PROVIDER', '{uri} {route}'),
 
+	/*
+	 * Define the name used when automatically naming queued jobs.
+	 * a token string:
+	 *      a pattern you define yourself, available tokens:
+	 *          {connection} = The name of the queue connection
+	 *          {class} = The name of the job class
+	 *          {data} = JSON string with all data passed to the job
+	 *          {args} = List of variable names passed to the job
+	 *          {input} = List of values passed to the job
+	 *      anything that is not a matched token will remain a string literal
+	 *      example:
+	 *          Given a job named App\MyJob, with data {"subject":"hello","to":"world"},
+	 *			the pattern 'I say {input} when I run {class}' would return:
+	 *			'I say hello, world when I run App\MyJob'
+	 */
+	'job_name_provider' => env('NEWRELIC_JOB_NAME_PROVIDER', '{class}'),
+
 	/*
 	 * Will cause an exception to be thrown if the NewRelic
 	 * PHP agent is not found / installed