You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Use this rule if you are looking to grade OpenTelemetry instrumentations for the Sentry JavaScript SDKs
3
+
globs: *
4
+
alwaysApply: false
5
+
---
6
+
7
+
# Upgrading OpenTelemetry instrumentations
8
+
9
+
1. For every package in packages/\*\*:
10
+
- When upgrading dependencies for OpenTelemetry instrumentations we need to first upgrade `@opentelemetry/instrumentation` to the latest version.
11
+
**CRITICAL**: `@opentelemetry/instrumentation` MUST NOT include any breaking changes.
12
+
Read through the changelog of `@opentelemetry/instrumentation` to figure out if breaking changes are included and fail with the reason if it does include breaking changes.
13
+
You can find the changelog at `https://github.com/open-telemetry/opentelemetry-js/blob/main/experimental/CHANGELOG.md`
14
+
15
+
- After successfully upgrading `@opentelemetry/instrumentation` upgrade all `@opentelemetry/instrumentation-{instrumentation}` packages, e.g. `@opentelemetry/instrumentation-pg`
16
+
**CRITICAL**: `@opentelemetry/instrumentation-{instrumentation}` MUST NOT include any breaking changes.
17
+
Read through the changelog of `@opentelemetry/instrumentation-{instrumentation}` to figure out if breaking changes are included and fail with the reason if it does including breaking changes.
18
+
You can find the changelogs at `https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/packages/instrumentation-{instrumentation}/CHANGELOG.md`.
19
+
20
+
- Finally, upgrade third party instrumentations to their latest versions, these are currently:
21
+
- @prisma/instrumentation
22
+
23
+
**CRITICAL**: Upgrades to third party instrumentations MUST NOT include breaking changes.
24
+
Read through the changelog of each third party instrumentation to figure out if breaking changes are included and fail with the reason if it does include breaking changes.
25
+
26
+
2. For packages and apps in dev-packages/\*\*:
27
+
- If an app depends on `@opentelemetry/instrumentation` >= 0.200.x upgrade it to the latest version.
28
+
**CRITICAL**: `@opentelemetry/instrumentation` MUST NOT include any breaking changes.
29
+
30
+
- If an app depends on `@opentelemetry/instrumentation-http` >= 0.200.x upgrade it to the latest version.
31
+
**CRITICAL**: `@opentelemetry/instrumentation-http` MUST NOT include any breaking changes.
0 commit comments