Skip to content

Commit 1ac1045

Browse files
docs: remove redundant migration text from READMEs (#2243)
* docs: remove redundant migration text * docs: also include mongoose * docs: remove migration text from socket.io --------- Co-authored-by: Marc Pichler <marc.pichler@dynatrace.com>
1 parent 01c28ae commit 1ac1045

File tree

4 files changed

+2
-47
lines changed

4 files changed

+2
-47
lines changed

plugins/node/instrumentation-amqplib/README.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -69,18 +69,6 @@ If timeout is not big enough, span might be closed with 'InstrumentationTimeout'
6969

7070
Default is 1 minute
7171

72-
## Migration From opentelemetry-instrumentation-amqplib
73-
74-
This instrumentation was originally published under the name `"opentelemetry-instrumentation-amqplib"` in [this repo](https://github.com/aspecto-io/opentelemetry-ext-js). Few breaking changes were made during porting to the contrib repo to align with conventions:
75-
76-
### Hook Info
77-
78-
The instrumentation's config `publishHook`, `publishConfirmHook`, `consumeHook` and `consumeEndHook` functions signature changed, so the second function parameter is info object, containing the relevant hook data.
79-
80-
### `moduleVersionAttributeName` config option
81-
82-
The `moduleVersionAttributeName` config option is removed. To add the amqplib package version to spans, use the `moduleVersion` attribute in hook info for `publishHook` and `consumeHook` functions.
83-
8472
## Semantic Conventions
8573

8674
This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)

plugins/node/instrumentation-mongoose/README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,20 +38,6 @@ registerInstrumentations({
3838
})
3939
```
4040

41-
## Migration From opentelemetry-instrumentation-mongoose
42-
43-
This instrumentation was originally published and maintained under the name `"opentelemetry-instrumentation-mongoose"` in [this repo](https://github.com/aspecto-io/opentelemetry-ext-js).
44-
45-
Few breaking changes were made during porting to the contrib repo to align with conventions:
46-
47-
### Hook Info
48-
49-
The instrumentation's config `responseHook` functions signature changed, so the second function parameter is info object, containing the relevant hook data.
50-
51-
### `moduleVersionAttributeName` config option
52-
53-
The `moduleVersionAttributeName` config option is removed. To add the mongoose package version to spans, use the `moduleVersion` attribute in hook info for `responseHook` function.
54-
5541
## Semantic Conventions
5642

5743
This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)

plugins/node/instrumentation-socket.io/README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,9 @@ registerInstrumentations({
4848
| `onIgnoreEventList` | `string[]` | `[]` | names of listened events to ignore tracing for |
4949
| `traceReserved` | `boolean` | `false` | set to true if you want to trace socket.io reserved events (see [docs](https://socket.io/docs/v4/emit-cheatsheet/#Reserved-events)) |
5050

51-
## Migration From opentelemetry-instrumentation-socket.io
51+
## Filter Http Transport
5252

53-
This instrumentation was originally published and maintained under the name `"opentelemetry-instrumentation-socket.io"` in [this repo](https://github.com/aspecto-io/opentelemetry-ext-js).
54-
55-
Few breaking changes were made during porting to the contrib repo:
56-
57-
### filterHttpTransport
58-
59-
The instrumentation's config `filterHttpTransport` option was removed to decouple this instrumentation from the http instrumentation.
60-
if you do not want to trace the socket.io http requests, add the default socket.io route (`/socket.io/`) to the `HttpInstrumentationConfig.ignoreIncomingPaths` array
53+
If you do not want to trace the socket.io http requests, add the default socket.io route (`/socket.io/`) to the `HttpInstrumentationConfig.ignoreIncomingPaths` array
6154

6255
## Semantic Conventions
6356

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

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -110,18 +110,6 @@ Specific service logic currently implemented for:
110110

111111
The instrumentation is doing best effort to support the trace specification of OpenTelemetry. For SQS, it involves defining new attributes on the `Messages` array, as well as on the manipulated types generated from this array (to set correct trace context for a single SQS message operation). Those properties are defined as [non-enumerable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Enumerability_and_ownership_of_properties) properties, so they have minimum side effect on the app. They will, however, show when using the `Object.getOwnPropertyDescriptors` and `Reflect.ownKeys` functions on SQS `Messages` array and for each `Message` in the array.
112112

113-
## Migration From opentelemetry-instrumentation-aws-sdk
114-
115-
This instrumentation was originally published under the name `"opentelemetry-instrumentation-aws-sdk"` in [this repo](https://github.com/aspecto-io/opentelemetry-ext-js). Few breaking changes were made during porting to the contrib repo to align with conventions:
116-
117-
### Hook Info
118-
119-
The instrumentation's config `preRequestHook`, `responseHook` and `sqsProcessHook` functions signature changed, so the second function parameter is info object, containing the relevant hook data.
120-
121-
### `moduleVersionAttributeName` config option
122-
123-
The `moduleVersionAttributeName` config option is removed. To add the aws-sdk package version to spans, use the `moduleVersion` attribute in hook info for `preRequestHook` and `responseHook` functions.
124-
125113
## Semantic Conventions
126114

127115
This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)

0 commit comments

Comments
 (0)