Job tracking

[cykirsch]

Add job tracking via middleware available in Laravel 6+ as well as via job events.

This splits framework init into its own collector so that it doesn't log duplicates between HTTP and Job.

[cykirsch]

I'm actually thinking that this should be opposite. The order of execution is JobProcessing, Middleware, JobProcessed. So as it is now the Job processing span extends a few milliseconds beyond the end of the transaction.

I did it this way to intentionally be similar to the HTTP Request, but since it's not fully accurate, I'm wondering if you'd prefer it switched--the transaction would be handled by the events and the middleware would just provide an additional span. This would also have the benefit of automatic transactions for pre-L6 installs.

[cykirsch]

@arkaitzgarro Any thoughts on this one so far?

[cykirsch]

FWIW I'm about done with a re-implementation doing the opposite as described above; if it works out I could do a PR for that and then you can give feedback on whichever is your preferred approach.

[arkaitzgarro]

Do you have an example of how both implementations visually look like in ELastic APM?

[cykirsch]

Do you have an example of how both implementations visually look like in ELastic APM?

Pretty subtle difference in the demo, but you can see right at the end where the transaction ends in comparison to the "Job processing" span.

Transaction started/stopped in the event:

Transaction started/stopped in the middleware:

[cykirsch]

Building your own demo like the above is trivial. Sharing an artisan command below, but you can do the same thing in a controller to see the job-within-a-request.

<?php

namespace App\Console\Commands;

use App\Jobs\ApmJobDemoJob;
use Illuminate\Console\Command;
use Illuminate\Contracts\Bus\Dispatcher;

class ApmJobDemo extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'apm:job-demo';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Demo job tracking in Elastic APM';

    /**
     * Execute the console command.
     *
     * @param Dispatcher $dispatcher
     */
    public function handle(Dispatcher $dispatcher)
    {
        $dispatcher->dispatch(new ApmJobDemoJob());
    }
}

<?php

namespace App\Jobs;

use AG\ElasticApmLaravel\Jobs\Middleware\RecordTransaction;
use App\Models\Eloquent\User;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\SerializesModels;

class ApmJobDemoJob implements ShouldQueue
{
    use SerializesModels;

    public function handle()
    {
        $user = User::first();
    }

    public function middleware()
    {
        return [
            app(RecordTransaction::class),
        ];
    }
}

[arkaitzgarro]

Closing in favour of #18