feat(aws-sdk): add s3 and kinesis service extensions for aws-sdk instrumentation

[jj22ee]

Which problem is this PR solving?

• [opentelemetry-instrumentation-aws-sdk] Add S3 Bucket Name and Kinesis Stream Name to aws-sdk span attribute if present #2360

Short description of the changes

• Add service extensions for S3 and Kinesis in AWS SDK instrumentation.
  • For S3, add bucket name to span if present
  • For Kinesis, add stream name to span if present
• This is a simple starting point for these new service extensions. The bucket/stream names are most important, but in the future, perhaps more data can be collected as span attributes.

Regarding some added constants to the utils file:

export const _AWS_S3_BUCKET = 'aws.s3.bucket';
export const _AWS_KINESIS_STREAM_NAME = 'aws.kinesis.stream.name';

• _AWS_S3_BUCKET should be added to OTel JS Semantic Attributes in the future.
  • See S3 specification: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/object-stores/s3.md
• There is no related specification for _AWS_KINESIS_STREAM_NAME, but some AWS repos are already using aws.kinesis.stream.name

Testing

1. Unit tests
2. Tested with:

• Kinesis Client: observed 'aws.kinesis.stream.name': myNewKinesisStream

    const client = new KinesisClient({ region: 'us-east-1' });
    const input = { // CreateStreamInput
      StreamName: "myNewKinesisStream", // required
      ShardCount: Number(3),
      StreamModeDetails: { // StreamModeDetails
        StreamMode: "ON_DEMAND", // required
      },
    };
    const command = new CreateStreamCommand(input);
    await client.send(command).then(data => {
      console.log(data);
    })

• S3 Client: observed 'aws.s3.bucket': test-bucket-not-exist-or-accessible

  const s3Client = new S3Client({ region: 'us-east-1' });
  const bucketName = 'test-bucket-not-exist-or-accessible';
  try {
    await s3Client.send(
      new ListObjectsCommand({
        Bucket: bucketName,
      }),
    ).then((data) => {
      console.log(data);
    });
  } catch (e) {
    if (e instanceof Error) {
      console.error('Exception thrown: ', e.message);
    }
  } finally {
    res.send('done aws sdk s3 request');
  }

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.85%. Comparing base (ad8c581) to head (e689114).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2361      +/-   ##
==========================================
+ Coverage   90.83%   90.85%   +0.01%     
==========================================
  Files         159      161       +2     
  Lines        7831     7859      +28     
  Branches     1610     1614       +4     
==========================================
+ Hits         7113     7140      +27     
- Misses        718      719       +1     

Files with missing lines	Coverage Δ
...opentelemetry-instrumentation-aws-sdk/src/enums.ts	100.00% <100.00%> (ø)
...ntation-aws-sdk/src/services/ServicesExtensions.ts	96.29% <100.00%> (-3.71%)	⬇️
...ry-instrumentation-aws-sdk/src/services/kinesis.ts	100.00% <100.00%> (ø)
...lemetry-instrumentation-aws-sdk/src/services/s3.ts	100.00% <100.00%> (ø)
...opentelemetry-instrumentation-aws-sdk/src/utils.ts	97.29% <ø> (ø)

[jj22ee]

Pinging @blumamir for review!

Unrelated heads-up, I'm looking to take over component ownership of AWS JS components from @carolabadeer. I think I just need to make a PR like #1464.

[trentm]

I think I just need to make a PR like #1464.

@jj22ee Yup that's correct. Great to have you helping.

[blumamir]

Thank you for the contribution and the info in the PR.

Left few comments. Some of them I wrote on s3 implementation but they also apply to kinesis, didn't want to duplicate the same comments twice :)

[blumamir]

awesome to have tests for that.

Please note that those tests are for v2 which will soon be end of life.
Consider also adding assertions on these new attributes to v3 tests in test/aws-sdk-v3.test.ts here

[jj22ee]

Hi, looking for another round of review! I removed some of the aws-sdk v2 tests I had previously given their end-of-life and soon-to-be-deprecated statuses, and removed the latency with the Kinesis Client test (enforced HTTP instead of HTTP2 which isn't supported by nock)

[blumamir]

LGTM 💯

Thank you for the contribution, the code and tests looks great and the description on the PR is very helpful.