Skip to content

Commit 7c4c0de

Browse files
committed
chore(aws-sdk): drop support for AWS SDK for JavaScript v2
1 parent d4d3c4f commit 7c4c0de

File tree

11 files changed

+4
-2961
lines changed

11 files changed

+4
-2961
lines changed

package-lock.json

Lines changed: 0 additions & 209 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

plugins/node/opentelemetry-instrumentation-aws-sdk/README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
[component owners](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/.github/component_owners.yml): @blumamir @jj22ee @trivikr
77

8-
This module provides automatic instrumentation for the [`aws-sdk` v2](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/) and [`@aws-sdk` v3](https://github.com/aws/aws-sdk-js-v3) modules, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle.
8+
This module provides automatic instrumentation for the [AWS SDK for JavaScript v3](https://github.com/aws/aws-sdk-js-v3) modules, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle.
99

1010
If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
1111

@@ -19,7 +19,6 @@ npm install --save @opentelemetry/instrumentation-aws-sdk
1919

2020
## Supported Versions
2121

22-
- [`aws-sdk`](https://www.npmjs.com/package/aws-sdk) versions `>=2.308.0 <3`
2322
- `@aws-sdk/client-*` versions `>=3.0.0 <4`
2423

2524
## Usage
@@ -60,29 +59,17 @@ aws-sdk instrumentation has few options available to choose from. You can set th
6059

6160
## Span Attributes
6261

63-
Both V2 and V3 instrumentations are collecting the following attributes:
62+
The instrumentations are collecting the following attributes:
6463
| Attribute Name | Type | Description | Example |
6564
| -------------- | ---- | ----------- | ------- |
6665
| `rpc.system` | string | Always equals "aws-api" | |
6766
| `rpc.method` | string | he name of the operation corresponding to the request, as returned by the AWS SDK. If the SDK does not provide a way to retrieve a name, the name of the command SHOULD be used, removing the suffix `Command` if present, resulting in a PascalCase name with no spaces. | `PutObject` |
6867
| `rpc.service` | string | The name of the service to which a request is made, as returned by the AWS SDK. If the SDK does not provide a away to retrieve a name, the name of the SDK's client interface for a service SHOULD be used, removing the suffix `Client` if present, resulting in a PascalCase name with no spaces. | `S3`, `DynamoDB`, `Route53` |
6968
| `aws.region` | string | Region name for the request | "eu-west-1" |
7069

71-
### V2 attributes
72-
73-
In addition to the above attributes, the instrumentation also collect the following for V2 ONLY:
74-
| Attribute Name | Type | Description | Example |
75-
| -------------- | ---- | ----------- | ------- |
76-
| `aws.operation` | string | The method name for the request. | for `SQS.sendMessage(...)` the operation is "sendMessage" |
77-
| `aws.signature.version` | string | AWS version of authentication signature on the request. | "v4" |
78-
| `aws.service.api` | string | The SDK class name for the service | "SQS" |
79-
| `aws.service.identifier` | string | Identifier for the service in the SDK | "sqs" |
80-
| `aws.service.name` | string | Abbreviation name for the service | "Amazon SQS" |
81-
| `aws.request.id` | uuid | Request unique id, as returned from aws on response | "01234567-89ab-cdef-0123-456789abcdef" |
82-
8370
### Custom User Attributes
8471

85-
The instrumentation user can configure a `preRequestHook` function which will be called before each request, with a normalized request object (across v2 and v3) and the corresponding span.
72+
The instrumentation user can configure a `preRequestHook` function which will be called before each request, with a normalized request object and the corresponding span.
8673
This hook can be used to add custom attributes to the span with any logic.
8774
For example, user can add interesting attributes from the `request.params`, and write custom logic based on the service and operation.
8875
Usage example:

plugins/node/opentelemetry-instrumentation-aws-sdk/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@
6464
"@types/mocha": "8.2.3",
6565
"@types/node": "18.18.14",
6666
"@types/sinon": "10.0.20",
67-
"aws-sdk": "2.1008.0",
6867
"eslint": "8.7.0",
6968
"expect": "29.2.0",
7069
"nock": "13.3.3",

0 commit comments

Comments
 (0)