feat: use NoopTracerProvider if Sdk is disabled

composer.json

@@ -28,7 +28,6 @@
   "require-dev": {
     "doctrine/dbal": "^3.0",
     "friends-of-phpspec/phpspec-expect": "^4.0",
-    "open-telemetry/transport-grpc": "^1.0",
     "open-telemetry/gen-otlp-protobuf": "^1.0",
     "php-http/httplug": "^2.3",
     "phpspec/phpspec": "^7.5",

readme.md

@@ -3,25 +3,31 @@
 ### Features
 
 #### Tracing
+
 - Using the official [OpenTelemetry SDK](https://github.com/open-telemetry/opentelemetry-php)
 - Minimal auto-instrumentation for **requests**, console **commands**, **consumers** and **doctrine**
 - Trace context propagation from incoming **requests** to **consumers**, **outgoing http calls** and **databases** (using [`sqlcommenter`](https://google.github.io/sqlcommenter/))
 - Configurable blacklisting of requests by path to avoid useless traces, eg. `/metrics` or `/_healthz`
 - Automatic log inclusion with configurable log level and channels
+- Disabling tracing with the `NoopTracerProvider` thanks to OTEL_SDK_DISABLED=true
 
 #### Metrics
+
 - Using the [Prometheus Client](https://github.com/PromPHP/prometheus_client_php)
 - Minimal auto-instrumentation for common **request**, **consumer** and **message** metrics (see list of provided [default metrics](./docs/metrics/default-metrics.md)).
 - Autoconfigurable metric providers, see below.
 
 #### Logging
+
 - Adds trace context to logs for correlation, with customizable keys.
 
 #### Baggage
+
 - Using the official [OpenTelemetry SDK](https://github.com/open-telemetry/opentelemetry-php)
 - Baggage propagation from incoming **requests** to **consumers** and **outgoing http calls**
 
 #### Health
+
 - A simple endpoint to expose application health (default: `/_healthz`)
 - Autoconfigurable healthcheck interface to add healthchecks to be made for global application health
 
@@ -30,19 +36,21 @@
 ```sh
 composer require worldia/instrumentation-bundle <your-exporter>
 ```
+
 You will aso need to install an [exporter implementation](https://packagist.org/packages/open-telemetry/exporter-otlp?query=open-telemetry%2Fexporter-) and `APCu` is required by the prometheus exporter.
-```
+
+````
 
 Add to ```bundles.php```:
 ```php
 return [
     // Other bundles
     Instrumentation\InstrumentationBundle::class => ['all' => true],
 ];
-```
+````
 
-**Minimal configuration**  
-See the complete [configuration reference here](./docs/config-reference.md) or run ```bin/console config:dump-reference instrumentation```.
+**Minimal configuration**
+See the complete [configuration reference here](./docs/config-reference.md) or run `bin/console config:dump-reference instrumentation`.
 
 ```yaml
 // docker-compose.yaml
@@ -71,18 +79,18 @@ instrumentation: ~
 ### Usage
 
 - **Tracing**
-    - [Simple tracing example](./docs/tracing/simple-trace.md)
-    - [Simple tracing example using the static API](./docs/tracing/static-usage.md)
-    - [Add Urls to your traces in error messages](./docs/tracing/add-urls-to-your-traces.md)
-    - [Use upstream request id as trace id](./docs/tracing/upstream-request-id.md)
-    - [Customize operation (span) name for a message](./docs/tracing/custom-operation-name-for-message.md)
-    - [Link strategy for a message](./docs/tracing/link-strategy-for-message.md)    
-    - [Propagating trace/baggage context in HTTP requests](./docs/tracing/propagating-context.md)
-    - [Add request / response bodies as span attributes for HTTP requests](./docs/tracing/message-bodies.md)
+  - [Simple tracing example](./docs/tracing/simple-trace.md)
+  - [Simple tracing example using the static API](./docs/tracing/static-usage.md)
+  - [Add Urls to your traces in error messages](./docs/tracing/add-urls-to-your-traces.md)
+  - [Use upstream request id as trace id](./docs/tracing/upstream-request-id.md)
+  - [Customize operation (span) name for a message](./docs/tracing/custom-operation-name-for-message.md)
+  - [Link strategy for a message](./docs/tracing/link-strategy-for-message.md)
+  - [Propagating trace/baggage context in HTTP requests](./docs/tracing/propagating-context.md)
+  - [Add request / response bodies as span attributes for HTTP requests](./docs/tracing/message-bodies.md)
 - **Metrics**
-    - [Adding a metric](./docs/metrics/adding-a-metric.md)
-    - [Using Redis as storage adapter](./docs/metrics/using-redis-as-storage.md) (Recommended)
+  - [Adding a metric](./docs/metrics/adding-a-metric.md)
+  - [Using Redis as storage adapter](./docs/metrics/using-redis-as-storage.md) (Recommended)
 - **Logging**
-    - [Customizing trace context log keys](./docs/logging/custom-keys.md)
+  - [Customizing trace context log keys](./docs/logging/custom-keys.md)
 - **Health**
-    - [Adding a healthcheck](./docs/health/adding-a-healthcheck.md)   
+  - [Adding a healthcheck](./docs/health/adding-a-healthcheck.md)

src/Bridge/GoogleCloud/Logging/Formatter/StdOutFormatter.php

@@ -45,30 +45,32 @@ protected function normalize(mixed $data, int $depth = 0): mixed
             $data['severity'] = $data['level_name'];
             unset($data['level_name']);
 
-            // Map tracing
-            if (isset($data['context']['trace'])) {
-                $data['logging.googleapis.com/trace'] = 'projects/'.$this->project.'/traces/'.$data['context']['trace'];
-            }
-            if (isset($data['context']['span'])) {
-                $data['logging.googleapis.com/spanId'] = $data['context']['span'];
-            }
-            if (isset($data['context']['sampled'])) {
-                $data['logging.googleapis.com/trace_sampled'] = $data['context']['sampled'];
-            }
-            if (isset($data['context']['operation'])) {
-                $data['logging.googleapis.com/operation'] = $data['context']['operation'];
+            if (\is_array($data['context'])) {
+                // Map tracing
+                if (isset($data['context']['trace'])) {
+                    $data['logging.googleapis.com/trace'] = 'projects/'.$this->project.'/traces/'.$data['context']['trace'];
+                }
+                if (isset($data['context']['span'])) {
+                    $data['logging.googleapis.com/spanId'] = $data['context']['span'];
+                }
+                if (isset($data['context']['sampled'])) {
+                    $data['logging.googleapis.com/trace_sampled'] = $data['context']['sampled'];
+                }
+                if (isset($data['context']['operation'])) {
+                    $data['logging.googleapis.com/operation'] = $data['context']['operation'];
+                }
+                unset($data['context']['trace'], $data['context']['span'], $data['context']['sampled'], $data['context']['operation']);
+
+                if ($exception = $data['context']['exception'] ?? false) {
+                    $data['message'] = $exception['message'];
+                    $data['context'] = array_merge($data['context'], $exception['context']);
+                    unset($data['context']['exception']);
+                }
             }
-            unset($data['context']['trace'], $data['context']['span'], $data['context']['sampled'], $data['context']['operation']);
 
             // Map channel
             $data['logging.googleapis.com/labels'] = ['channel' => $data['channel']];
             unset($data['channel']);
-
-            if ($exception = $data['context']['exception'] ?? false) {
-                $data['message'] = $exception['message'];
-                $data['context'] = array_merge($data['context'], $exception['context']);
-                unset($data['context']['exception']);
-            }
         }
 
         return $data;

src/Metrics/CounterAdapter.php

@@ -12,6 +12,8 @@
 
 class CounterAdapter implements CounterInterface
 {
+    use IterableAttributesTrait;
+
     public function __construct(
         private string $name,
         private string $description,
@@ -20,11 +22,12 @@ public function __construct(
     }
 
     /**
-     * @param int                                $amount
-     * @param array{labels: array<string,mixed>} $attributes
+     * @param int                                  $amount
+     * @param iterable<string,array<string,mixed>> $attributes
      */
     public function add($amount, iterable $attributes = [], $context = null): void
     {
+        $attributes = $this->normalizeAttributes($attributes);
         /** @var array<string> $labelNames */
         $labelNames = array_keys($attributes['labels'] ?? []);
         $labelValues = array_values($attributes['labels'] ?? []);

src/Metrics/HistogramAdapter.php

@@ -13,6 +13,8 @@
 
 class HistogramAdapter implements HistogramInterface
 {
+    use IterableAttributesTrait;
+
     public function __construct(
         private string $name,
         private string $description,
@@ -25,6 +27,7 @@ public function __construct(
      */
     public function record($amount, iterable $attributes = [], $context = null): void
     {
+        $attributes = $this->normalizeAttributes($attributes);
         /** @var array<string> $labelNames */
         $labelNames = array_keys($attributes['labels'] ?? []);
         $labelValues = array_values($attributes['labels'] ?? []);

src/Metrics/IterableAttributesTrait.php

@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the worldia/instrumentation-bundle package.
+ * (c) Worldia <[email protected]>
+ */
+
+namespace Instrumentation\Metrics;
+
+trait IterableAttributesTrait
+{
+    /**
+     * @param iterable<string,array<string,mixed>> $attributes
+     *
+     * @return array<string,array<string,mixed>>
+     */
+    public function normalizeAttributes(iterable $attributes): array
+    {
+        $newAttr = [];
+        foreach ($attributes as $key => $value) {
+            $newAttr[$key] = $value;
+        }
+
+        return $newAttr;
+    }
+}

src/Metrics/UpDownCounterAdapter.php

@@ -12,6 +12,8 @@
 
 class UpDownCounterAdapter implements UpDownCounterInterface
 {
+    use IterableAttributesTrait;
+
     public function __construct(
         private string $name,
         private string $description,
@@ -25,6 +27,7 @@ public function __construct(
      */
     public function add($amount, iterable $attributes = [], $context = null): void
     {
+        $attributes = $this->normalizeAttributes($attributes);
         /** @var array<string> $labelNames */
         $labelNames = array_keys($attributes['labels'] ?? []);
         $labelValues = array_values($attributes['labels'] ?? []);

src/Tracing/Tracing.php

@@ -13,6 +13,8 @@
 use OpenTelemetry\API\Trace\SpanKind;
 use OpenTelemetry\API\Trace\TracerProviderInterface;
 use OpenTelemetry\Context\Context;
+use OpenTelemetry\SDK\Sdk;
+use OpenTelemetry\SDK\Trace\NoopTracerProvider;
 
 final class Tracing
 {
@@ -46,6 +48,9 @@ public static function setProvider(TracerProviderInterface $tracerProvider): voi
 
     private static function getProvider(): TracerProviderInterface
     {
+        if (Sdk::isDisabled()) {
+            return new NoopTracerProvider();
+        }
         if (!self::$tracerProvider) {
             throw new \RuntimeException('No trace provider was set.');
         }