Added opt in for sql commenter attribute and update READMD.md

Author: jerrytfleung

src/Instrumentation/PDO/README.md

@@ -33,4 +33,22 @@ otel.instrumentation.pdo.distribute_statement_to_linked_spans = true
 or environment variable:
 ```shell
 OTEL_PHP_INSTRUMENTATION_PDO_DISTRIBUTE_STATEMENT_TO_LINKED_SPANS=true
-```
+```
+
+The [sqlcommenter](https://google.github.io/sqlcommenter/) feature can be enabled using configuration directive:
+```
+otel.instrumentation.pdo.sql_commenter = true
+```
+or environment variable:
+```shell
+OTEL_PHP_INSTRUMENTATION_PDO_SQL_COMMENTER=true
+```
+
+and its attribute can be configured using the following configuration directive:
+```
+otel.instrumentation.pdo.sql_commenter_attribute = true
+```
+or environment variable:
+```shell
+OTEL_PHP_INSTRUMENTATION_PDO_SQL_COMMENTER_ATTRIBUTE=true
+```

src/Instrumentation/PDO/src/PDOInstrumentation.php

@@ -128,9 +128,11 @@ public static function register(): void
                 Context::storage()->attach($span->storeInContext($parent));
                 if (self::isSqlCommenterEnabled() && $sqlStatement !== self::UNDEFINED) {
                     $sqlStatement = self::appendSqlComments($sqlStatement, true);
-                    $span->setAttributes([
-                        TraceAttributes::DB_QUERY_TEXT => $sqlStatement,
-                    ]);
+                    if (self::isSqlCommenterAttributeEnabled()) {
+                        $span->setAttributes([
+                            TraceAttributes::DB_QUERY_TEXT => $sqlStatement,
+                        ]);
+                    }
 
                     return [
                         0 => $sqlStatement,
@@ -167,9 +169,11 @@ public static function register(): void
                 Context::storage()->attach($span->storeInContext($parent));
                 if (self::isSqlCommenterEnabled() && $sqlStatement !== self::UNDEFINED) {
                     $sqlStatement = self::appendSqlComments($sqlStatement, true);
-                    $span->setAttributes([
-                        TraceAttributes::DB_QUERY_TEXT => $sqlStatement,
-                    ]);
+                    if (self::isSqlCommenterAttributeEnabled()) {
+                        $span->setAttributes([
+                            TraceAttributes::DB_QUERY_TEXT => $sqlStatement,
+                        ]);
+                    }
 
                     return [
                         0 => $sqlStatement,
@@ -206,9 +210,11 @@ public static function register(): void
                 Context::storage()->attach($span->storeInContext($parent));
                 if (self::isSqlCommenterEnabled() && $sqlStatement !== self::UNDEFINED) {
                     $sqlStatement = self::appendSqlComments($sqlStatement, false);
-                    $span->setAttributes([
-                        TraceAttributes::DB_QUERY_TEXT => $sqlStatement,
-                    ]);
+                    if (self::isSqlCommenterAttributeEnabled()) {
+                        $span->setAttributes([
+                            TraceAttributes::DB_QUERY_TEXT => $sqlStatement,
+                        ]);
+                    }
 
                     return [
                         0 => $sqlStatement,
@@ -388,6 +394,15 @@ private static function isSqlCommenterEnabled(): bool
         return filter_var(get_cfg_var('otel.instrumentation.pdo.sql_commenter'), FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE) ?? false;
     }
 
+    private static function isSqlCommenterAttributeEnabled(): bool
+    {
+        if (class_exists('OpenTelemetry\SDK\Common\Configuration\Configuration')) {
+            return Configuration::getBoolean('OTEL_PHP_INSTRUMENTATION_PDO_SQL_COMMENTER_ATTRIBUTE', false);
+        }
+
+        return filter_var(get_cfg_var('otel.instrumentation.pdo.sql_commenter_attribute'), FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE) ?? false;
+    }
+
     private static function appendSqlComments(string $query, bool $withTraceContext): string
     {
         $comments = [];