Update auto-instrumentation packages to SemConv 1.30 (#327)

brettmc · web-flow · commit f31f91c86436 · 2025-02-12T08:16:06.000+11:00
* update auto-instrumentation packages to SemConv 1.30.0
* Curl semconv 1.30
* amqp
noting semconv recommendations, try to stick to semconv 1.24. Where attributes have been removed, replace
with a string
* rdkafka
* guzzle
* HttpAsyncClient
* io
* laravel
* mongodb
* mysqli
* openaiphp
* pdo
* psr3
* psr6
* psr14
* psr15
* psr16
* psr18
* slim
* symfony
* wordpress
* yii
* symfony
* logs
* hard-code schema url for 8.0-supporting packages
on 8.0 these packages won't be able to use the SemConv::Version enum
* no-plugins for composer make targets
this avoids the annoying 'do you trust...' composer questions
* drop 7.4 testing
* fixing build errors
- bump psr3 + monolog deps to php8.1
- fix azure detector semconv, add composer dependency
* skip failing cake test on 8.0
* fix message span names
in semconv 1.27 the order of operation+queue switched
diff --git a/composer.json b/composer.json
@@ -14,7 +14,7 @@
     "ext-opentelemetry": "*",
     "laravel/framework": "^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0",
     "open-telemetry/api": "^1.0",
-    "open-telemetry/sem-conv": "^1.24"
+    "open-telemetry/sem-conv": "^1.30"
   },
   "require-dev": {
     "friendsofphp/php-cs-fixer": "^3.50",
diff --git a/src/Hooks/Illuminate/Console/Command.php b/src/Hooks/Illuminate/Console/Command.php
@@ -34,10 +34,10 @@ protected function hookExecute(): bool
                 $builder = $this->instrumentation
                     ->tracer()
                     ->spanBuilder(sprintf('Command %s', $command->getName() ?: 'unknown'))
-                    ->setAttribute(TraceAttributes::CODE_FUNCTION, $function)
+                    ->setAttribute(TraceAttributes::CODE_FUNCTION_NAME, $function)
                     ->setAttribute(TraceAttributes::CODE_NAMESPACE, $class)
                     ->setAttribute(TraceAttributes::CODE_FILEPATH, $filename)
-                    ->setAttribute(TraceAttributes::CODE_LINENO, $lineno);
+                    ->setAttribute(TraceAttributes::CODE_LINE_NUMBER, $lineno);
 
                 $parent = Context::getCurrent();
                 $span = $builder->startSpan();
diff --git a/src/Hooks/Illuminate/Contracts/Console/Kernel.php b/src/Hooks/Illuminate/Contracts/Console/Kernel.php
@@ -43,10 +43,10 @@ private function hookHandle(): bool
                     ->tracer()
                     ->spanBuilder('Artisan handler')
                     ->setSpanKind(SpanKind::KIND_PRODUCER)
-                    ->setAttribute(TraceAttributes::CODE_FUNCTION, $function)
+                    ->setAttribute(TraceAttributes::CODE_FUNCTION_NAME, $function)
                     ->setAttribute(TraceAttributes::CODE_NAMESPACE, $class)
                     ->setAttribute(TraceAttributes::CODE_FILEPATH, $filename)
-                    ->setAttribute(TraceAttributes::CODE_LINENO, $lineno);
+                    ->setAttribute(TraceAttributes::CODE_LINE_NUMBER, $lineno);
 
                 $parent = Context::getCurrent();
                 $span = $builder->startSpan();
diff --git a/src/Hooks/Illuminate/Contracts/Http/Kernel.php b/src/Hooks/Illuminate/Contracts/Http/Kernel.php
@@ -45,10 +45,10 @@ protected function hookHandle(): bool
                     ->tracer()
                     ->spanBuilder(sprintf('%s', $request?->method() ?? 'unknown'))
                     ->setSpanKind(SpanKind::KIND_SERVER)
-                    ->setAttribute(TraceAttributes::CODE_FUNCTION, $function)
+                    ->setAttribute(TraceAttributes::CODE_FUNCTION_NAME, $function)
                     ->setAttribute(TraceAttributes::CODE_NAMESPACE, $class)
                     ->setAttribute(TraceAttributes::CODE_FILEPATH, $filename)
-                    ->setAttribute(TraceAttributes::CODE_LINENO, $lineno);
+                    ->setAttribute(TraceAttributes::CODE_LINE_NUMBER, $lineno);
                 $parent = Context::getCurrent();
                 if ($request) {
                     /** @phan-suppress-next-line PhanAccessMethodInternal */
diff --git a/src/Hooks/Illuminate/Contracts/Queue/Queue.php b/src/Hooks/Illuminate/Contracts/Queue/Queue.php
@@ -38,20 +38,20 @@ protected function hookBulk(): bool
             'bulk',
             pre: function (QueueContract $queue, array $params, string $class, string $function, ?string $filename, ?int $lineno) {
                 $attributes = array_merge([
-                    TraceAttributes::CODE_FUNCTION => $function,
+                    TraceAttributes::CODE_FUNCTION_NAME => $function,
                     TraceAttributes::CODE_NAMESPACE => $class,
                     TraceAttributes::CODE_FILEPATH => $filename,
-                    TraceAttributes::CODE_LINENO => $lineno,
+                    TraceAttributes::CODE_LINE_NUMBER => $lineno,
                     TraceAttributes::MESSAGING_BATCH_MESSAGE_COUNT => count($params[0] ?? []),
                 ], $this->contextualMessageSystemAttributes($queue, []));
 
                 /** @psalm-suppress ArgumentTypeCoercion */
                 $span = $this->instrumentation
                     ->tracer()
                     ->spanBuilder(vsprintf('%s %s', [
+                        TraceAttributeValues::MESSAGING_OPERATION_TYPE_SEND,
                         /** @phan-suppress-next-line PhanUndeclaredMethod */
                         method_exists($queue, 'getQueue') ? $queue->getQueue($params[2] ?? null) : $queue->getConnectionName(),
-                        TraceAttributeValues::MESSAGING_OPERATION_PUBLISH,
                     ]))
                     ->setSpanKind(SpanKind::KIND_PRODUCER)
                     ->setAttributes($attributes)
@@ -81,20 +81,20 @@ protected function hookLater(): bool
                 };
 
                 $attributes = [
-                    TraceAttributes::CODE_FUNCTION => $function,
+                    TraceAttributes::CODE_FUNCTION_NAME => $function,
                     TraceAttributes::CODE_NAMESPACE => $class,
                     TraceAttributes::CODE_FILEPATH => $filename,
-                    TraceAttributes::CODE_LINENO => $lineno,
+                    TraceAttributes::CODE_LINE_NUMBER => $lineno,
                     'messaging.message.delivery_timestamp' => $estimateDeliveryTimestamp,
                 ];
 
                 /** @psalm-suppress ArgumentTypeCoercion */
                 $span = $this->instrumentation
                     ->tracer()
                     ->spanBuilder(vsprintf('%s %s', [
+                        TraceAttributeValues::MESSAGING_OPERATION_TYPE_CREATE,
                         /** @phan-suppress-next-line PhanUndeclaredMethod */
                         method_exists($queue, 'getQueue') ? $queue->getQueue($params[2] ?? null) : $queue->getConnectionName(),
-                        'create',
                     ]))
                     ->setSpanKind(SpanKind::KIND_PRODUCER)
                     ->setAttributes($attributes)
@@ -124,8 +124,8 @@ protected function hookPushRaw(): bool
                 $span = $this->instrumentation
                     ->tracer()
                     ->spanBuilder(vsprintf('%s %s', [
+                        TraceAttributeValues::MESSAGING_OPERATION_TYPE_CREATE,
                         $attributes[TraceAttributes::MESSAGING_DESTINATION_NAME],
-                        TraceAttributeValues::MESSAGING_OPERATION_CREATE,
                     ]))
                     ->setSpanKind(SpanKind::KIND_PRODUCER)
                     ->setAttributes($attributes)
diff --git a/src/Hooks/Illuminate/Queue/SyncQueue.php b/src/Hooks/Illuminate/Queue/SyncQueue.php
@@ -40,10 +40,10 @@ protected function hookPush(): bool
                     ]))
                     ->setSpanKind(SpanKind::KIND_INTERNAL)
                     ->setAttributes([
-                        TraceAttributes::CODE_FUNCTION => $function,
+                        TraceAttributes::CODE_FUNCTION_NAME => $function,
                         TraceAttributes::CODE_NAMESPACE => $class,
                         TraceAttributes::CODE_FILEPATH => $filename,
-                        TraceAttributes::CODE_LINENO => $lineno,
+                        TraceAttributes::CODE_LINE_NUMBER => $lineno,
                     ])
                     ->startSpan();
 
diff --git a/src/Hooks/Illuminate/Queue/Worker.php b/src/Hooks/Illuminate/Queue/Worker.php
@@ -51,8 +51,8 @@ private function hookWorkerProcess(): bool
                 $span = $this->instrumentation
                     ->tracer()
                     ->spanBuilder(vsprintf('%s %s', [
+                        TraceAttributeValues::MESSAGING_OPERATION_TYPE_PROCESS,
                         $attributes[TraceAttributes::MESSAGING_DESTINATION_NAME],
-                        'process',
                     ]))
                     ->setSpanKind(SpanKind::KIND_CONSUMER)
                     ->setParent($parent)
@@ -98,8 +98,8 @@ private function hookWorkerGetNextJob(): bool
                 $span = $this->instrumentation
                     ->tracer()
                     ->spanBuilder(vsprintf('%s %s', [
+                        TraceAttributeValues::MESSAGING_OPERATION_TYPE_RECEIVE,
                         $attributes[TraceAttributes::MESSAGING_DESTINATION_NAME],
-                        TraceAttributeValues::MESSAGING_OPERATION_RECEIVE,
                     ]))
                     ->setSpanKind(SpanKind::KIND_CONSUMER)
                     ->setAttributes($attributes)
diff --git a/src/Hooks/PostHookTrait.php b/src/Hooks/PostHookTrait.php
@@ -7,7 +7,6 @@
 use OpenTelemetry\API\Trace\Span;
 use OpenTelemetry\API\Trace\StatusCode;
 use OpenTelemetry\Context\Context;
-use OpenTelemetry\SemConv\TraceAttributes;
 use Throwable;
 
 trait PostHookTrait
@@ -23,9 +22,7 @@ private function endSpan(?Throwable $exception = null): void
         $span = Span::fromContext($scope->context());
 
         if ($exception) {
-            $span->recordException($exception, [
-                TraceAttributes::EXCEPTION_ESCAPED => true,
-            ]);
+            $span->recordException($exception);
             $span->setStatus(StatusCode::STATUS_ERROR, $exception->getMessage());
         }
 
diff --git a/src/LaravelInstrumentation.php b/src/LaravelInstrumentation.php
@@ -16,7 +16,7 @@ public static function register(): void
         $instrumentation = new CachedInstrumentation(
             'io.opentelemetry.contrib.php.laravel',
             null,
-            'https://opentelemetry.io/schemas/1.24.0'
+            'https://opentelemetry.io/schemas/1.30.0',
         );
 
         Hooks\Illuminate\Console\Command::hook($instrumentation);
diff --git a/src/Watchers/ExceptionWatcher.php b/src/Watchers/ExceptionWatcher.php
@@ -9,7 +9,6 @@
 use OpenTelemetry\API\Trace\Span;
 use OpenTelemetry\API\Trace\StatusCode;
 use OpenTelemetry\Context\Context;
-use OpenTelemetry\SemConv\TraceAttributes;
 use Throwable;
 
 class ExceptionWatcher extends Watcher
@@ -37,7 +36,7 @@ public function recordException(MessageLogged $log): void
             return;
         }
         $span = Span::fromContext($scope->context());
-        $span->recordException($exception, [TraceAttributes::EXCEPTION_ESCAPED => true]);
+        $span->recordException($exception);
         $span->setStatus(StatusCode::STATUS_ERROR, $exception->getMessage());
     }
 }
diff --git a/src/Watchers/LogWatcher.php b/src/Watchers/LogWatcher.php
@@ -32,6 +32,7 @@ public function register(Application $app): void
 
     /**
      * Record a log.
+     * @phan-suppress PhanDeprecatedFunction
      */
     public function recordLog(MessageLogged $log): void
     {
diff --git a/src/Watchers/QueryWatcher.php b/src/Watchers/QueryWatcher.php
@@ -44,13 +44,13 @@ public function recordQuery(QueryExecuted $query): void
             ->startSpan();
 
         $attributes = [
-            TraceAttributes::DB_SYSTEM => $query->connection->getDriverName(),
-            TraceAttributes::DB_NAME => $query->connection->getDatabaseName(),
-            TraceAttributes::DB_OPERATION => $operationName,
-            TraceAttributes::DB_USER => $query->connection->getConfig('username'),
+            TraceAttributes::DB_SYSTEM_NAME => $query->connection->getDriverName(),
+            TraceAttributes::DB_NAMESPACE => $query->connection->getDatabaseName(),
+            TraceAttributes::DB_OPERATION_NAME => $operationName,
+            //TraceAttributes::DB_USER => $query->connection->getConfig('username'),
         ];
 
-        $attributes[TraceAttributes::DB_STATEMENT] = $query->sql;
+        $attributes[TraceAttributes::DB_QUERY_TEXT] = $query->sql;
         /** @psalm-suppress PossiblyInvalidArgument */
         $span->setAttributes($attributes);
         $span->end($nowInNs);
diff --git a/src/Watchers/RedisCommand/RedisCommandWatcher.php b/src/Watchers/RedisCommand/RedisCommandWatcher.php
@@ -54,10 +54,10 @@ public function recordRedisCommand(CommandExecuted $event): void
 
         // See https://opentelemetry.io/docs/specs/semconv/database/redis/
         $attributes = [
-            TraceAttributes::DB_SYSTEM => TraceAttributeValues::DB_SYSTEM_REDIS,
-            TraceAttributes::DB_NAME => $this->fetchDbIndex($event->connection),
-            TraceAttributes::DB_OPERATION => $operationName,
-            TraceAttributes::DB_STATEMENT => Serializer::serializeCommand($event->command, $event->parameters),
+            TraceAttributes::DB_SYSTEM_NAME => TraceAttributeValues::DB_SYSTEM_REDIS,
+            TraceAttributes::DB_NAMESPACE => $this->fetchDbIndex($event->connection),
+            TraceAttributes::DB_OPERATION_NAME => $operationName,
+            TraceAttributes::DB_QUERY_TEXT => Serializer::serializeCommand($event->command, $event->parameters),
             TraceAttributes::SERVER_ADDRESS => $this->fetchDbHost($event->connection),
         ];
 
diff --git a/src/Watchers/RedisCommand/Serializer.php b/src/Watchers/RedisCommand/Serializer.php
@@ -70,7 +70,7 @@ public static function serializeCommand(string $command, array $params): string
         }
 
         // In some cases (for example when using LUA scripts) arrays are valid parameters
-        $paramsToSerialize = array_map(function($param) { return is_array($param) ? json_encode($param) : $param; }, $paramsToSerialize);
+        $paramsToSerialize = array_map(function ($param) { return is_array($param) ? json_encode($param) : $param; }, $paramsToSerialize);
         
         return $command . ' ' . implode(' ', $paramsToSerialize);
     }
diff --git a/tests/Integration/LaravelInstrumentationTest.php b/tests/Integration/LaravelInstrumentationTest.php
@@ -58,10 +58,10 @@ public function test_cache_log_db(): void
 
         $span = $this->storage[1];
         $this->assertSame('sql SELECT', $span->getName());
-        $this->assertSame('SELECT', $span->getAttributes()->get('db.operation'));
-        $this->assertSame(':memory:', $span->getAttributes()->get('db.name'));
-        $this->assertSame('select 1', $span->getAttributes()->get('db.statement'));
-        $this->assertSame('sqlite', $span->getAttributes()->get('db.system'));
+        $this->assertSame('SELECT', $span->getAttributes()->get('db.operation.name'));
+        $this->assertSame(':memory:', $span->getAttributes()->get('db.namespace'));
+        $this->assertSame('select 1', $span->getAttributes()->get('db.query.text'));
+        $this->assertSame('sqlite', $span->getAttributes()->get('db.system.name'));
 
         /** @var \OpenTelemetry\SDK\Logs\ReadWriteLogRecord $logRecord */
         $logRecord = $this->storage[0];
diff --git a/tests/Integration/Queue/QueueTest.php b/tests/Integration/Queue/QueueTest.php
@@ -55,17 +55,17 @@ public function test_it_can_push_a_message_with_a_delay(): void
         $this->queue->later(new DateInterval('PT10M'), new DummyJob('DateInterval'));
         $this->queue->later(new DateTimeImmutable('2024-04-15 22:29:00.123Z'), new DummyJob('DateTime'));
 
-        $this->assertEquals('sync create', $this->storage[2]->getName());
+        $this->assertEquals('create sync', $this->storage[2]->getName());
         $this->assertIsInt(
             $this->storage[2]->getAttributes()->get('messaging.message.delivery_timestamp'),
         );
 
-        $this->assertEquals('sync create', $this->storage[5]->getName());
+        $this->assertEquals('create sync', $this->storage[5]->getName());
         $this->assertIsInt(
             $this->storage[5]->getAttributes()->get('messaging.message.delivery_timestamp'),
         );
 
-        $this->assertEquals('sync create', $this->storage[8]->getName());
+        $this->assertEquals('create sync', $this->storage[8]->getName());
         $this->assertIsInt(
             $this->storage[8]->getAttributes()->get('messaging.message.delivery_timestamp'),
         );
@@ -86,7 +86,7 @@ public function test_it_can_publish_in_bulk(): void
         /** @psalm-suppress PossiblyUndefinedMethod */
         $mockQueue->bulk($jobs);
 
-        $this->assertEquals('dummy-queue publish', $this->storage[0]->getName());
+        $this->assertEquals('send dummy-queue', $this->storage[0]->getName());
         $this->assertEquals(10, $this->storage[0]->getAttributes()->get(TraceAttributes::MESSAGING_BATCH_MESSAGE_COUNT));
     }
 
@@ -107,7 +107,7 @@ public function test_it_can_create_with_redis(): void
             new DummyJob('B'),
         ]);
 
-        $this->assertEquals('queues:default publish', $this->storage[0]->getName());
+        $this->assertEquals('send queues:default', $this->storage[0]->getName());
         $this->assertEquals(2, $this->storage[0]->getAttributes()->get(TraceAttributes::MESSAGING_BATCH_MESSAGE_COUNT));
         $this->assertEquals('redis', $this->storage[0]->getAttributes()->get(TraceAttributes::MESSAGING_SYSTEM));
     }

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@`
`9`	`9`	`use OpenTelemetry\API\Trace\Span;`
`10`	`10`	`use OpenTelemetry\API\Trace\StatusCode;`
`11`	`11`	`use OpenTelemetry\Context\Context;`
`12`		`-use OpenTelemetry\SemConv\TraceAttributes;`
`13`	`12`	`use Throwable;`
`14`	`13`
`15`	`14`	`class ExceptionWatcher extends Watcher`
`@@ -37,7 +36,7 @@ public function recordException(MessageLogged $log): void`
`37`	`36`	`return;`
`38`	`37`	`}`
`39`	`38`	`$span = Span::fromContext($scope->context());`
`40`		`- $span->recordException($exception, [TraceAttributes::EXCEPTION_ESCAPED => true]);`
	`39`	`+ $span->recordException($exception);`
`41`	`40`	`$span->setStatus(StatusCode::STATUS_ERROR, $exception->getMessage());`
`42`	`41`	`}`
`43`	`42`	`}`