[aws-sdk]Added Initial auto-instrumentation library for aws-sdk #361

AsakerMohd · 2025-04-24T19:40:08Z

Description:
There currently only exists a manual instrumentation library for the AWS SDK. It would be very helpful to also have an auto instrumentation library where customers only need to add one line in composer.json like "open-telemetry/opentelemetry-auto-aws-sdk": "*", to instrument their AWS SDK calls.

This is an initial version of the auto instrumentation agent where it sets attributes such as rpc.system, rpc.method, rpc.service, aws.region and aws.requestId.. In the future, it should also support aws specific attributes for specific services such as bedrock, sns, sqs, etc. that have attributes such as gen_ai.agent.id, gen_ai.system, etc
Another thing that needs to be supported is propagation which I'm having difficulty figuring out where to add. I see it's being added to libraries such as Slim here:

opentelemetry-php-contrib/src/Instrumentation/Slim/src/SlimInstrumentation.php

Line 108 in 3835977

// Propagate traceresponse header to response, if TraceResponsePropagator is present

We have this X-Ray propagator which is important since it has functions to inject the traceid header for outgoing request and extract parent context from incoming requests. Any tips here would be appreciated.
Enabling http instrumentation like slim produces duplicate spans. Lets say we make a call to S3. In this case, we have an aws-sdk span with rpc.service = S3 and an outgoing http span with "url.full": "https://s3.amazonaws.com/". Is there a way to suppress the http instrumentation for this specific scenario? I know this is doable in other languages such as Java/DotNet.

For testing:
I have this sample app: https://github.com/AsakerMohd/phpSample
I added the instrumentation path to that repo in the composer.json file:

"repositories": [
    {
      "type": "path",
      "url": "./AwsSdk",
      "options": {
        "symlink": true
      }
    }
  ],
  "require": {
     ...,
     "open-telemetry/opentelemetry-auto-aws-sdk": "*",
     ...,
  }

Then running the app through docker and making an API call, this is an example trace where only the aws-sdk instrumentation is enabled (notice the parent_id is empty. This is because this is the only instrumentation enabled. When something like slim is also enabled, the id is populated correctly):

[
my_php_app      |     {
my_php_app      |         "name": "s3.ListBuckets",
my_php_app      |         "context": {
my_php_app      |             "trace_id": "381643ab3693053e6ba9f3ee19d3b2b7",
my_php_app      |             "span_id": "a8806c84389623ff",
my_php_app      |             "trace_state": "",
my_php_app      |             "trace_flags": 1
my_php_app      |         },
my_php_app      |         "resource": {
my_php_app      |             "host.name": "160a5c84428f",
my_php_app      |             "host.arch": "aarch64",
my_php_app      |             "os.type": "linux",
my_php_app      |             "os.description": "6.10.14-linuxkit",
my_php_app      |             "os.name": "Linux",
my_php_app      |             "os.version": "#1 SMP Thu Mar 20 16:32:56 UTC 2025",
my_php_app      |             "process.pid": 7,
my_php_app      |             "process.executable.path": "\/usr\/local\/bin\/php",
my_php_app      |             "process.owner": "root",
my_php_app      |             "process.runtime.name": "cli-server",
my_php_app      |             "process.runtime.version": "8.2.28",
my_php_app      |             "telemetry.sdk.name": "opentelemetry",
my_php_app      |             "telemetry.sdk.language": "php",
my_php_app      |             "telemetry.sdk.version": "dev-main",
my_php_app      |             "telemetry.distro.name": "opentelemetry-php-instrumentation",
my_php_app      |             "telemetry.distro.version": "1.1.2",
my_php_app      |             "service.name": "php-sample-ec2",
my_php_app      |             "service.version": "dev-main"
my_php_app      |         },
my_php_app      |         "parent_span_id": "",
my_php_app      |         "kind": "KIND_CLIENT",
my_php_app      |         "start": 1745386257527632330,
my_php_app      |         "end": 1745386257846341288,
my_php_app      |         "attributes": {
my_php_app      |             "rpc.system": "aws-api",
my_php_app      |             "rpc.method": "ListBuckets",
my_php_app      |             "rpc.service": "s3",
my_php_app      |             "aws.region": "us-east-1",
my_php_app      |             "code.function": "execute",
my_php_app      |             "code.namespace": "Aws\\AwsClient",
my_php_app      |             "code.filepath": "\/app\/vendor\/aws\/aws-sdk-php\/src\/AwsClientTrait.php",
my_php_app      |             "code.line_number": 56,
my_php_app      |             "http.status_code": 200,
my_php_app      |             "aws.requestId": "60PQSDPPNH5CSPMD"
my_php_app      |         },
my_php_app      |         "status": {
my_php_app      |             "code": "Unset",
my_php_app      |             "description": ""
my_php_app      |         },
my_php_app      |         "events": [],
my_php_app      |         "links": [],
my_php_app      |         "schema_url": "https:\/\/opentelemetry.io\/schemas\/1.30.0"
my_php_app      |     }
my_php_app      | ]

For the integration test: Running vendor/bin/phpunit tests/Integration/AwsSdkInstrumentationTest.php runs the test there that asserts for the attributes and span and it passes as expected.

welcome · 2025-04-24T19:40:11Z

Thanks for opening your first pull request! If you haven't yet signed our Contributor License Agreement (CLA), then please do so that we can accept your contribution. A link should appear shortly in this PR if you have not already signed one.

src/Instrumentation/AwsSdk/src/AwsSdkInstrumentation.php

codecov · 2025-04-30T12:19:03Z

Codecov Report

Attention: Patch coverage is 81.13208% with 10 lines in your changes missing coverage. Please review.

Project coverage is 82.13%. Comparing base (39f190a) to head (75e5033).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...strumentation/AwsSdk/src/AwsSdkInstrumentation.php	81.13%	10 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #361      +/-   ##
============================================
- Coverage     82.14%   82.13%   -0.01%     
- Complexity     1801     1808       +7     
============================================
  Files           137      138       +1     
  Lines          7594     7647      +53     
============================================
+ Hits           6238     6281      +43     
- Misses         1356     1366      +10

Flag	Coverage Δ
Aws	`92.59% <ø> (ø)`
Context/Swoole	`0.00% <ø> (ø)`
Instrumentation/AwsSdk	`81.13% <81.13%> (?)`
Instrumentation/CakePHP	`20.40% <ø> (ø)`
Instrumentation/CodeIgniter	`73.55% <ø> (ø)`
Instrumentation/Doctrine	`92.72% <ø> (ø)`
Instrumentation/ExtAmqp	`88.48% <ø> (ø)`
Instrumentation/ExtRdKafka	`86.11% <ø> (ø)`
Instrumentation/Guzzle	`69.13% <ø> (ø)`
Instrumentation/HttpAsyncClient	`78.04% <ø> (ø)`
Instrumentation/IO	`70.68% <ø> (ø)`
Instrumentation/Laravel	`63.91% <ø> (ø)`
Instrumentation/MongoDB	`74.28% <ø> (ø)`
Instrumentation/MySqli	`95.81% <ø> (ø)`
Instrumentation/OpenAIPHP	`87.21% <ø> (ø)`
Instrumentation/PDO	`94.21% <ø> (ø)`
Instrumentation/Psr14	`76.47% <ø> (ø)`
Instrumentation/Psr15	`89.15% <ø> (ø)`
Instrumentation/Psr16	`97.50% <ø> (ø)`
Instrumentation/Psr18	`77.46% <ø> (ø)`
Instrumentation/Psr3	`67.01% <ø> (ø)`
Instrumentation/Psr6	`97.61% <ø> (ø)`
Instrumentation/ReactPHP	`99.28% <ø> (ø)`
Instrumentation/Slim	`86.11% <ø> (ø)`
Instrumentation/Symfony	`84.74% <ø> (ø)`
Instrumentation/Yii	`77.50% <ø> (ø)`
Logs/Monolog	`100.00% <ø> (ø)`
Propagation/Instana	`98.11% <ø> (ø)`
Propagation/ServerTiming	`100.00% <ø> (ø)`
Propagation/TraceResponse	`100.00% <ø> (ø)`
ResourceDetectors/Azure	`91.66% <ø> (ø)`
ResourceDetectors/Container	`93.02% <ø> (ø)`
Sampler/RuleBased	`33.51% <ø> (ø)`
Shims/OpenTracing	`92.45% <ø> (ø)`
Symfony	`87.81% <ø> (ø)`
Utils/Test	`87.53% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...strumentation/AwsSdk/src/AwsSdkInstrumentation.php	`81.13% <81.13%> (ø)`

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 39f190a...75e5033. Read the comment docs.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

ChrisLightfootWild

Please can you also copy one of the .gitattributes across from another contrib package and tweak appropriately, if required?

AsakerMohd · 2025-05-13T18:15:51Z

Please can you also copy one of the .gitattributes across from another contrib package and tweak appropriately, if required?

Done!

brettmc · 2025-05-14T02:00:49Z

.gitsplit.yml

@@ -60,6 +60,8 @@ splits:
    target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-yii.git"
  - prefix: "src/Instrumentation/Doctrine"
    target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-doctrine.git"
+  - prefix: "src/Instrumentation/AwsSdk"
+    target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-auto-aws-sdk.git"


I've created this empty repo in preparation.

src/Instrumentation/AwsSdk/src/AwsSdkInstrumentation.php

brettmc · 2025-05-14T23:54:29Z

The tests aren't running for this one yet, @AsakerMohd can you add it to the top-level .github/workflows/php.yml please

…p-contrib

AsakerMohd · 2025-05-15T23:03:14Z

.github/workflows/php.yml

Added!

brettmc · 2025-05-20T23:28:15Z

@AsakerMohd now that checks+tests are running, you can address those failures. It will be fastest if you get them all passing locally (make all locally, per our docs here: https://github.com/open-telemetry/opentelemetry-php/blob/main/CONTRIBUTING.md )

AsakerMohd · 2025-05-21T18:33:24Z

@AsakerMohd now that checks+tests are running, you can address those failures. It will be fastest if you get them all passing locally (make all locally, per our docs here: https://github.com/open-telemetry/opentelemetry-php/blob/main/CONTRIBUTING.md )

Fixed the style issue and the build issue for php 8.1 workflow. The other failures are for instrumentation packages that aren't related to this change.

src/Instrumentation/AwsSdk/src/AwsSdkInstrumentation.php

brettmc · 2025-06-10T01:23:12Z

https://packagist.org/packages/open-telemetry/opentelemetry-auto-aws-sdk

[aws-sdk]Added Initial auto-instrumentation library for aws-sdk

673f2f9

AsakerMohd requested a review from a team as a code owner April 24, 2025 19:40

cedricziel reviewed Apr 25, 2025

View reviewed changes

src/Instrumentation/AwsSdk/src/AwsSdkInstrumentation.php Show resolved Hide resolved

cedricziel reviewed Apr 25, 2025

View reviewed changes

src/Instrumentation/AwsSdk/src/AwsSdkInstrumentation.php Outdated Show resolved Hide resolved

Updated to use sem covs instead of hardcoding

28a512e

brettmc mentioned this pull request May 5, 2025

implement span suppression open-telemetry/opentelemetry-php#1579

Open

5 tasks

ChrisLightfootWild reviewed May 9, 2025

View reviewed changes

AsakerMohd and others added 3 commits May 13, 2025 11:02

Merge branch 'open-telemetry:main' into main

057e7d1

added to gitsplit

45224ce

added gitattributes file

be7848e

brettmc reviewed May 14, 2025

View reviewed changes

src/Instrumentation/AwsSdk/src/AwsSdkInstrumentation.php Outdated Show resolved Hide resolved

AsakerMohd and others added 2 commits May 14, 2025 11:57

Merge branch 'open-telemetry:main' into main

1cdadb9

Updated to use the latest semcov 1.32

5f3a9ed

AsakerMohd and others added 3 commits May 15, 2025 15:21

Merge branch 'open-telemetry:main' into main

660c52f

Added aws tests to php.yml

500afb6

Merge branch 'main' of https://github.com/AsakerMohd/opentelemetry-ph…

ad6926c

…p-contrib

AsakerMohd and others added 2 commits May 21, 2025 11:12

Merge branch 'open-telemetry:main' into main

ce36434

Updated composer for php 8.1 and fixed style issue

9a94008

AsakerMohd and others added 4 commits May 22, 2025 10:54

Fixed psalm errors

4fbd13e

Merge branch 'open-telemetry:main' into main

1a01849

fixed styling again

c24bd82

supress phan errors

bfc0335

updated unit test to not require credentials

3f94160

brettmc reviewed May 23, 2025

View reviewed changes

src/Instrumentation/AwsSdk/src/AwsSdkInstrumentation.php Outdated Show resolved Hide resolved

brettmc reviewed May 23, 2025

View reviewed changes

src/Instrumentation/AwsSdk/src/AwsSdkInstrumentation.php Outdated Show resolved Hide resolved

updated comment messages

75e5033

brettmc approved these changes Jun 10, 2025

View reviewed changes

brettmc merged commit fe1f358 into open-telemetry:main Jun 10, 2025
140 of 144 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[aws-sdk]Added Initial auto-instrumentation library for aws-sdk #361

[aws-sdk]Added Initial auto-instrumentation library for aws-sdk #361

Uh oh!

AsakerMohd commented Apr 24, 2025

Uh oh!

welcome bot commented Apr 24, 2025

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Apr 30, 2025 •

edited

Loading

Uh oh!

ChrisLightfootWild left a comment

Uh oh!

AsakerMohd commented May 13, 2025

Uh oh!

brettmc May 14, 2025

Uh oh!

Uh oh!

brettmc commented May 14, 2025

Uh oh!

AsakerMohd commented May 15, 2025

Uh oh!

brettmc commented May 20, 2025

Uh oh!

AsakerMohd commented May 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brettmc commented Jun 10, 2025

Uh oh!

Uh oh!

[aws-sdk]Added Initial auto-instrumentation library for aws-sdk #361

[aws-sdk]Added Initial auto-instrumentation library for aws-sdk #361

Uh oh!

Conversation

AsakerMohd commented Apr 24, 2025

Uh oh!

welcome bot commented Apr 24, 2025

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ChrisLightfootWild left a comment

Choose a reason for hiding this comment

Uh oh!

AsakerMohd commented May 13, 2025

Uh oh!

brettmc May 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

brettmc commented May 14, 2025

Uh oh!

AsakerMohd commented May 15, 2025

Uh oh!

brettmc commented May 20, 2025

Uh oh!

AsakerMohd commented May 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brettmc commented Jun 10, 2025

Uh oh!

Uh oh!

codecov bot commented Apr 30, 2025 •

edited

Loading