Merge pull request #2 from worksome/feature/enable

feat: add support to disable Laravel Telemetry
worksome · Jan 31, 2023 · 7946a7f · 7946a7f
2 parents b1cfebe + c02fd07
commit 7946a7f
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 11 deletions.
diff --git a/config/telemetry.php b/config/telemetry.php
@@ -4,6 +4,9 @@
 
 // The Configuration is based on OpenTelemetry's naming convention.
 return [
+
+    'enabled' => env('LARAVEL_TELEMETRY_ENABLED', true),
+
     'exporter' => [
         'otlp' => [
             'endpoint' => env('OTEL_EXPORTER_OTLP_ENDPOINT', 'http://localhost:4318'),

diff --git a/src/LaravelTelemetryServiceProvider.php b/src/LaravelTelemetryServiceProvider.php
@@ -4,6 +4,7 @@
 
 namespace Worksome\LaravelTelemetry;
 
+use Illuminate\Contracts\Config\Repository;
 use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Queue\Events\WorkerStopping;
 use Illuminate\Support\ServiceProvider;
@@ -30,9 +31,12 @@ class LaravelTelemetryServiceProvider extends ServiceProvider
 {
     public function register(): void
     {
-        $this->app->singleton(
-            MeterProviderSdkInterface::class,
-            fn() => new MeterProvider(
+        $this->app->singleton(MeterProviderSdkInterface::class, function () {
+            if (! $this->app->make(Repository::class)->get('telemetry.enabled')) {
+                return null;
+            }
+
+            return new MeterProvider(
                 null,
                 ResourceInfoFactory::defaultResource(),
                 ClockFactory::getDefault(),
@@ -47,28 +51,38 @@ public function register(): void
                 new CriteriaViewRegistry(),
                 new WithSampledTraceExemplarFilter(),
                 new NoopStalenessHandlerFactory(),
-            )
-        );
+            );
+        });
+
         $this->app->bind(MeterProviderInterface::class, MeterProviderSdkInterface::class);
 
-        $this->app->singleton(
-            TracerProviderSdkInterface::class,
-            fn() => (new TracerProviderFactory())->create()
-        );
+        $this->app->singleton(TracerProviderSdkInterface::class, function () {
+            if (! $this->app->make(Repository::class)->get('telemetry.enabled')) {
+                return null;
+            }
+
+            return (new TracerProviderFactory())->create();
+        });
+
         $this->app->bind(TracerProviderInterface::class, TracerProviderSdkInterface::class);
     }
 
     public function boot(): void
     {
         $this->publishes([
-            __DIR__ . '/../config/telemetry.php' => $this->app->configPath('telemetry.php'),
+            __DIR__.'/../config/telemetry.php' => $this->app->configPath('telemetry.php'),
         ], 'laravel-telemetry-config');
+
         $this->mergeConfigFrom(
-            __DIR__ . '/../config/telemetry.php',
+            __DIR__.'/../config/telemetry.php',
             'telemetry',
         );
 
         $this->app->beforeResolving(MeterProviderInterface::class, function () {
+            if (! $this->app->make(Repository::class)->get('telemetry.enabled')) {
+                return;
+            }
+
             /** @var LoggerInterface $logger */
             $logger = $this->app->get(LoggerInterface::class);
             /** @var ConfigConfigurationResolver $configResolver */
@@ -78,6 +92,10 @@ public function boot(): void
         });
 
         $this->app->beforeResolving(TracerProviderInterface::class, function () {
+            if (! $this->app->make(Repository::class)->get('telemetry.enabled')) {
+                return;
+            }
+
             /** @var LoggerInterface $logger */
             $logger = $this->app->get(LoggerInterface::class);
             /** @var ConfigConfigurationResolver $configResolver */
@@ -87,10 +105,18 @@ public function boot(): void
         });
 
         $this->callAfterResolving(Dispatcher::class, function (Dispatcher $event) {
+            if (! $this->app->make(Repository::class)->get('telemetry.enabled')) {
+                return;
+            }
+
             $event->listen(WorkerStopping::class, WorkerStoppingFlush::class);
         });
 
         $this->app->terminating(function () {
+            if (! $this->app->make(Repository::class)->get('telemetry.enabled')) {
+                return;
+            }
+
             if ($this->app->resolved(MeterProviderSdkInterface::class)) {
                 /** @var MeterProviderSdkInterface $meter */
                 $meter = $this->app->get(MeterProviderSdkInterface::class);