Merge pull request #50 from scripting4u/main

exclude jobs via config or interface

Author: houdaslassi

README.md

@@ -288,6 +288,27 @@ public function boot(): void
 
 Want to keep the dashboard public but still record jobs? Either return `true` from the gate even for guests, or set `VANTAGE_AUTH_ENABLED=false`.
 
+### Exclude Jobs from Monitoring
+
+if you want to exclude some jobs from being tracked by Vantage, you can add them to the `exclude_jobs` config array:
+
+```php
+    'exclude_jobs' => [
+        App\Jobs\SomeNoisyJob::class,
+    ],
+```
+
+Or implement the 'ShouldNotBeTracked' class.
+
+```php
+use HoudaSlassi\Vantage\Contracts\ShouldNotBeTracked;
+
+class MyNoisyJob implements ShouldQueue, ShouldNotBeTracked
+{
+    public function handle(): void { ... }
+}
+```
+
 ## Testing
 
 ### Using the Model Factory

config/vantage.php

@@ -170,4 +170,15 @@
     'logging' => [
         'enabled' => env('VANTAGE_LOGGING_ENABLED', true),
     ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Excluded Jobs
+    |--------------------------------------------------------------------------
+    | Job classes listed here will not be recorded by Vantage.
+    | You can also implement ShouldNotBeTracked on any job class.
+    */
+    'exclude_jobs' => [
+        // App\Jobs\SomeNoisyJob::class,
+    ],
 ];

src/Contracts/ShouldNotBeTracked.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HoudaSlassi\Vantage\Contracts;
+
+interface ShouldNotBeTracked {}

src/Listeners/ChecksJobExclusion.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HoudaSlassi\Vantage\Listeners;
+
+use HoudaSlassi\Vantage\Contracts\ShouldNotBeTracked;
+
+trait ChecksJobExclusion
+{
+    protected function isExcluded(string $jobClass): bool
+    {
+        // Check interface
+        if (is_a($jobClass, ShouldNotBeTracked::class, true)) {
+            return true;
+        }
+
+        // Check config exclude list
+        $excluded = config('vantage.exclude_jobs', []);
+
+        return in_array($jobClass, $excluded, true);
+    }
+}

src/Listeners/RecordJobFailure.php

@@ -15,6 +15,7 @@
 
 class RecordJobFailure
 {
+    use ChecksJobExclusion;
     use ExtractsRetryOf;
 
     public function handle(JobFailed $event): void
@@ -24,6 +25,10 @@ public function handle(JobFailed $event): void
             return;
         }
 
+        if ($this->isExcluded($event->job->resolveName())) {
+            return;
+        }
+
         $uuid = $this->bestUuid($event);
         $jobClass = $this->jobClass($event);
         $queue = $event->job->getQueue();

src/Listeners/RecordJobStart.php

@@ -13,6 +13,7 @@
 
 class RecordJobStart
 {
+    use ChecksJobExclusion;
     use ExtractsRetryOf;
 
     public function handle(JobProcessing $event): void
@@ -22,6 +23,10 @@ public function handle(JobProcessing $event): void
             return;
         }
 
+        if ($this->isExcluded($event->job->resolveName())) {
+            return;
+        }
+
         $uuid = $this->bestUuid($event);
 
         // Telemetry config & sampling

src/Listeners/RecordJobSuccess.php

@@ -12,6 +12,7 @@
 
 class RecordJobSuccess
 {
+    use ChecksJobExclusion;
     use ExtractsRetryOf;
 
     public function handle(JobProcessed $event): void
@@ -21,6 +22,10 @@ public function handle(JobProcessed $event): void
             return;
         }
 
+        if ($this->isExcluded($event->job->resolveName())) {
+            return;
+        }
+
         // Some jobs (like rate-limited ones) are "processed" only to be released immediately.
         // Laravel exposes helpers to detect this so we don't count them as successful runs.
         if (method_exists($event->job, 'isReleased') && $event->job->isReleased()) {