Merge branch 'main' of https://github.com/open-telemetry/opentelemetry-php-contrib

# Conflicts:
#	src/Instrumentation/Doctrine/composer.json

Author: DominicDetta

.github/workflows/ossf-scorecard.yml

@@ -0,0 +1,47 @@
+name: OSSF Scorecard
+
+on:
+  push:
+    branches:
+      - main
+  schedule:
+    - cron: "19 6 * * 1" # once a week
+  workflow_dispatch:
+
+permissions: read-all
+
+jobs:
+  analysis:
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed for Code scanning upload
+      security-events: write
+      # Needed for GitHub OIDC token if publish_results is true
+      id-token: write
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable
+      # uploads of run results in SARIF format to the repository Actions tab.
+      # https://docs.github.com/en/actions/advanced-guides/storing-workflow-data-as-artifacts
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard (optional).
+      # Commenting out will disable upload of results to your repo's Code Scanning dashboard
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@5f8171a638ada777af81d42b55959a643bb29017 # v3.28.12
+        with:
+          sarif_file: results.sarif

.github/workflows/php.yml

@@ -54,6 +54,7 @@ jobs:
           'Sampler/RuleBased',
           'Shims/OpenTracing',
           'Symfony',
+          'Utils/Test'
         ]
         exclude:
 

.gitsplit.yml

@@ -78,6 +78,8 @@ splits:
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-sampler-rulebased.git"
   - prefix: "src/Shims/OpenTracing"
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-shim-opentracing.git"
+  - prefix: "src/Utils/Test"
+    target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-utils-test.git"
 # List of references to split (defined as regexp)
 origins:
   - ^main$

composer.json

@@ -59,6 +59,12 @@
       "src/ResourceDetectors/Container/_register.php"
     ]
   },
+  "autoload-dev": {
+    "psr-4": {
+      "OpenTelemetry\\TestUtils\\": "src/",
+      "OpenTelemetry\\TestUtils\\Tests\\": "tests/"
+    }
+  },
   "replace": {
     "open-telemetry/contrib-aws": "self.version",
     "open-telemetry/contrib-sdk-bundle": "self.version",
@@ -81,7 +87,8 @@
     "open-telemetry/opentelemetry-logger-monolog": "self.version",
     "open-telemetry/detector-container": "self.version",
     "open-telemetry/symfony-sdk-bundle": "self.version",
-    "open-telemetry/opentracing-shim": "self.version"
+    "open-telemetry/opentracing-shim": "self.version",
+    "open-telemetry/test-utils": "self.version"
   },
   "config": {
     "sort-packages": true,

docker-compose.yaml

@@ -1,10 +1,11 @@
 services:
   php:
+    image: opentelemetry-php:local-${PHP_VERSION}-cli
     build:
       context: ./docker
       dockerfile: Dockerfile
       args:
-        - PHP_VERSION
+        - PHP_VERSION:${PHP_VERSION}
     volumes:
     - ./:/usr/src/myapp
     user: "${PHP_USER}:root"

src/Aws/phpunit.xml.dist

@@ -39,6 +39,9 @@
         <testsuite name="unit">
             <directory>tests/Unit</directory>
         </testsuite>
+        <testsuite name="integration">
+            <directory>tests/Integration</directory>
+        </testsuite>
     </testsuites>
 
 </phpunit>

src/Aws/src/AwsSdkInstrumentation.php

@@ -8,12 +8,10 @@
 use Aws\ResultInterface;
 use OpenTelemetry\API\Instrumentation\InstrumentationInterface;
 use OpenTelemetry\API\Instrumentation\InstrumentationTrait;
-use OpenTelemetry\API\Trace\SpanInterface;
 use OpenTelemetry\API\Trace\SpanKind;
 use OpenTelemetry\API\Trace\TracerInterface;
 use OpenTelemetry\API\Trace\TracerProviderInterface;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
-use OpenTelemetry\Context\ScopeInterface;
 
 /**
  * @experimental
@@ -25,13 +23,12 @@ class AwsSdkInstrumentation implements InstrumentationInterface
     public const NAME = 'AWS SDK Instrumentation';
     public const VERSION = '0.0.1';
     public const SPAN_KIND = SpanKind::KIND_CLIENT;
-    private TextMapPropagatorInterface $propagator;
-    private TracerProviderInterface $tracerProvider;
-    private $clients = [] ;
-    private string $clientName;
-    private string $region;
-    private SpanInterface $span;
-    private ScopeInterface $scope;
+
+    private array $clients = [];
+
+    private array $instrumentedClients = [];
+
+    private array $spanStorage = [];
 
     public function getName(): string
     {
@@ -79,61 +76,70 @@ public function getTracer(): TracerInterface
     }
 
     /** @psalm-api */
-    public function instrumentClients($clientsArray) : void
+    public function instrumentClients($clientsArray): void
     {
         $this->clients = $clientsArray;
     }
 
-    /** @psalm-suppress ArgumentTypeCoercion */
     public function activate(): bool
     {
         try {
-            $middleware = Middleware::tap(function ($cmd, $_req) {
-                $tracer = $this->getTracer();
-                $propagator = $this->getPropagator();
-
-                $carrier = [];
-                /** @phan-suppress-next-line PhanTypeMismatchArgument */
-                $this->span = $tracer->spanBuilder($this->clientName)->setSpanKind(AwsSdkInstrumentation::SPAN_KIND)->startSpan();
-                $this->scope = $this->span->activate();
-
-                $propagator->inject($carrier);
-
-                /** @psalm-suppress PossiblyInvalidArgument */
-                $this->span->setAttributes([
-                    'rpc.method' => $cmd->getName(),
-                    'rpc.service' => $this->clientName,
-                    'rpc.system' => 'aws-api',
-                    'aws.region' => $this->region,
-                    ]);
-            });
-
-            /** @psalm-suppress PossiblyInvalidArgument */
-            $end_middleware = Middleware::mapResult(function (ResultInterface $result) {
-                /**
-                 * Some AWS SDK Funtions, such as S3Client->getObjectUrl() do not actually perform on the wire comms
-                 * with AWS Servers, and therefore do not return with a populated AWS\Result object with valid @metadata
-                 * Check for the presence of @metadata before extracting status code as these calls are still
-                 * instrumented.
-                 */
-                if (isset($result['@metadata'])) {
-                    $this->span->setAttributes([
-                        'http.status_code' => $result['@metadata']['statusCode'], //@phan-suppress-current-line PhanTypeMismatchDimFetch
-                    ]);
+            foreach ($this->clients as $client) {
+                $hash = spl_object_hash($client);
+                if (isset($this->instrumentedClients[$hash])) {
+                    continue;
                 }
 
-                $this->span->end();
-                $this->scope->detach();
+                $clientName = $client->getApi()->getServiceName();
+                $region = $client->getRegion();
 
-                return $result;
-            });
+                $client->getHandlerList()->prependInit(Middleware::tap(function ($cmd, $_req) use ($clientName, $region, $hash) {
+                    $tracer = $this->getTracer();
+                    $propagator = $this->getPropagator();
 
-            foreach ($this->clients as $client) {
-                $this->clientName = $client->getApi()->getServiceName();
-                $this->region = $client->getRegion();
+                    $carrier = [];
+                    /** @phan-suppress-next-line PhanTypeMismatchArgument */
+                    $span = $tracer->spanBuilder($clientName)->setSpanKind(AwsSdkInstrumentation::SPAN_KIND)->startSpan();
+                    $scope = $span->activate();
+                    $this->spanStorage[$hash] = [$span, $scope];
 
-                $client->getHandlerList()->prependInit($middleware, 'instrumentation');
-                $client->getHandlerList()->appendSign($end_middleware, 'end_instrumentation');
+                    $propagator->inject($carrier);
+
+                    /** @psalm-suppress PossiblyInvalidArgument */
+                    $span->setAttributes([
+                        'rpc.method' => $cmd->getName(),
+                        'rpc.service' => $clientName,
+                        'rpc.system' => 'aws-api',
+                        'aws.region' => $region,
+                    ]);
+                }), 'instrumentation');
+
+                $client->getHandlerList()->appendSign(Middleware::mapResult(function (ResultInterface $result) use ($hash) {
+                    if (empty($this->spanStorage[$hash])) {
+                        return $result;
+                    }
+                    [$span, $scope] = $this->spanStorage[$hash];
+                    unset($this->spanStorage[$hash]);
+
+                    /*
+                     * Some AWS SDK Functions, such as S3Client->getObjectUrl() do not actually perform on the wire comms
+                     * with AWS Servers, and therefore do not return with a populated AWS\Result object with valid @metadata
+                     * Check for the presence of @metadata before extracting status code as these calls are still
+                     * instrumented.
+                     */
+                    if (isset($result['@metadata'])) {
+                        $span->setAttributes([
+                            'http.status_code' => $result['@metadata']['statusCode'], // @phan-suppress-current-line PhanTypeMismatchDimFetch
+                        ]);
+                    }
+
+                    $span->end();
+                    $scope->detach();
+
+                    return $result;
+                }), 'end_instrumentation');
+
+                $this->instrumentedClients[$hash] = 1;
             }
         } catch (\Throwable $e) {
             return false;