docs: add upgrade guide

worksome · Jul 22, 2024 · 6311367 · 6311367
1 parent 8d0ca5b
commit 6311367
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -0,0 +1,17 @@
+# Upgrade Guide
+
+## Upgrading To 0.5 From 0.4.x
+
+### Configuration Changes
+
+The `telemetry.enabled` configuration key has been moved and negated to `sdk.disabled` to match the underlying
+OpenTelemetry SDK.
+
+Please update this value in your configuration if it has been published.
+
+```diff
+-    'enabled' => env('LARAVEL_TELEMETRY_ENABLED', true),
++    'sdk' => [
++        'disabled' => ! env('LARAVEL_TELEMETRY_ENABLED', true)
++    ],
+```