Merge branch 'open-telemetry:main' into Add-contributing-guide

Author: RichardChukwu

src/Instrumentation/ExtRdKafka/tests/Integration/ExtRdKafkaInstrumentationTest.php

@@ -136,7 +136,7 @@ public function test_produce_creates_new_span()
     private function produceMessage(
         string $message,
         ?string $key = null,
-        array $headers = null,
+        ?array $headers = null,
         bool $produceWithoutHeaders = false
     ): void {
         $conf = new Conf();
@@ -163,7 +163,7 @@ private function consumeMessage(): int|Message
     {
         $conf = new Conf();
 
-        $conf->setRebalanceCb(function (KafkaConsumer $kafka, $err, array $partitions = null) {
+        $conf->setRebalanceCb(function (KafkaConsumer $kafka, $err, ?array $partitions = null) {
             switch ($err) {
                 case RD_KAFKA_RESP_ERR__ASSIGN_PARTITIONS:
                     $kafka->assign($partitions);

src/Instrumentation/HttpAsyncClient/tests/Integration/HttpAsyncClientInstrumentationTest.php

@@ -94,7 +94,7 @@ public function __construct($response)
                 $this->response = $response;
             }
 
-            public function then(callable $onFulfilled = null, callable $onRejected = null): Promise
+            public function then(?callable $onFulfilled = null, ?callable $onRejected = null): Promise
             {
                 $this->onFulfilled = $onFulfilled;
                 $this->onRejected = $onRejected;

src/Instrumentation/MongoDB/src/MongoDBInstrumentation.php

@@ -14,7 +14,7 @@ final class MongoDBInstrumentation
     /**
      * @param callable(object):?string $commandSerializer
      */
-    public static function register(callable $commandSerializer = null): void
+    public static function register(?callable $commandSerializer = null): void
     {
         $instrumentation = new CachedInstrumentation(
             'io.opentelemetry.contrib.php.mongodb',

src/Instrumentation/PDO/README.md

@@ -23,3 +23,14 @@ The extension can be disabled via [runtime configuration](https://opentelemetry.
 ```shell
 OTEL_PHP_DISABLED_INSTRUMENTATIONS=pdo
 ```
+                     
+In case UI used to view telemetry data does not support links between spans (for example newrelic),
+you can optionally enable setting db statements attribute to `fetchAll` and `execute` spans using 
+configuration directive:
+```
+otel.instrumentation.pdo.distribute_statement_to_linked_spans = true
+```
+or environment variable:
+```shell
+OTEL_PHP_INSTRUMENTATION_PDO_DISTRIBUTE_STATEMENT_TO_LINKED_SPANS=true
+```

src/Instrumentation/PDO/src/PDOInstrumentation.php

@@ -10,6 +10,7 @@
 use OpenTelemetry\API\Trace\SpanKind;
 use OpenTelemetry\API\Trace\StatusCode;
 use OpenTelemetry\Context\Context;
+use OpenTelemetry\SDK\Common\Configuration\Configuration;
 use function OpenTelemetry\Instrumentation\hook;
 use OpenTelemetry\SemConv\TraceAttributes;
 use PDO;
@@ -200,6 +201,9 @@ public static function register(): void
             'fetchAll',
             pre: static function (PDOStatement $statement, array $params, string $class, string $function, ?string $filename, ?int $lineno) use ($pdoTracker, $instrumentation) {
                 $attributes = $pdoTracker->trackedAttributesForStatement($statement);
+                if (self::isDistributeStatementToLinkedSpansEnabled()) {
+                    $attributes[TraceAttributes::DB_STATEMENT] = $statement->queryString;
+                }
                 /** @psalm-suppress ArgumentTypeCoercion */
                 $builder = self::makeBuilder($instrumentation, 'PDOStatement::fetchAll', $function, $class, $filename, $lineno)
                     ->setSpanKind(SpanKind::KIND_CLIENT)
@@ -221,6 +225,11 @@ public static function register(): void
             'execute',
             pre: static function (PDOStatement $statement, array $params, string $class, string $function, ?string $filename, ?int $lineno) use ($pdoTracker, $instrumentation) {
                 $attributes = $pdoTracker->trackedAttributesForStatement($statement);
+
+                if (self::isDistributeStatementToLinkedSpansEnabled()) {
+                    $attributes[TraceAttributes::DB_STATEMENT] = $statement->queryString;
+                }
+                
                 /** @psalm-suppress ArgumentTypeCoercion */
                 $builder = self::makeBuilder($instrumentation, 'PDOStatement::execute', $function, $class, $filename, $lineno)
                     ->setSpanKind(SpanKind::KIND_CLIENT)
@@ -268,4 +277,13 @@ private static function end(?Throwable $exception): void
 
         $span->end();
     }
+
+    private static function isDistributeStatementToLinkedSpansEnabled(): bool
+    {
+        if (class_exists('OpenTelemetry\SDK\Common\Configuration\Configuration')) {
+            return Configuration::getBoolean('OTEL_PHP_INSTRUMENTATION_PDO_DISTRIBUTE_STATEMENT_TO_LINKED_SPANS', false);
+        }
+
+        return get_cfg_var('otel.instrumentation.pdo.distribute_statement_to_linked_spans');
+    }
 }

src/Sampler/RuleBased/.gitignore

@@ -1 +1,6 @@
+composer.lock
+
 .phpunit.cache
+
+var
+vendor

src/Sampler/RuleBased/composer.json

@@ -5,9 +5,9 @@
     "license": "Apache-2.0",
     "require": {
         "php": "^8.1",
-        "open-telemetry/api": "dev-main as 1.1.0",
-        "open-telemetry/sdk": "dev-main as 1.1.0",
-        "open-telemetry/sdk-configuration": "dev-main as 0.99"
+        "open-telemetry/api": "^1.1.0",
+        "open-telemetry/sdk": "^1.1.0",
+        "open-telemetry/sdk-configuration": "^0.0.5"
     },
     "require-dev": {
         "symfony/config": "^5.4 || ^6.4 || ^7.0",
@@ -32,7 +32,6 @@
         "spi": {
             "OpenTelemetry\\Config\\SDK\\Configuration\\ComponentProvider": [
                 "OpenTelemetry\\Contrib\\Sampler\\RuleBased\\ComponentProvider\\SamplerRuleBased",
-
                 "OpenTelemetry\\Contrib\\Sampler\\RuleBased\\ComponentProvider\\SamplingRuleAttribute",
                 "OpenTelemetry\\Contrib\\Sampler\\RuleBased\\ComponentProvider\\SamplingRuleLink",
                 "OpenTelemetry\\Contrib\\Sampler\\RuleBased\\ComponentProvider\\SamplingRuleParent",

src/Symfony/tests/Unit/OtelSdkBundle/Factory/GenericFactoryTraitTest.php

@@ -395,7 +395,7 @@ class TestedDefaultNullClass
     private $fooBar;
     private $fooBaz;
 
-    public function __construct(string $fooBar, stdClass $fooBaz = null)
+    public function __construct(string $fooBar, ?stdClass $fooBaz = null)
     {
         $this->fooBar = $fooBar;
         $this->fooBaz = $fooBaz;