From 6a522567e613b2dbb5a0a3a179b8b93cb291ce87 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Thu, 14 Apr 2022 13:36:01 +0200 Subject: [PATCH 1/3] docs(javascript): Replace deprecated severity enums with string literals --- .../breadcrumbs/breadcrumbs-example/javascript.mdx | 2 +- src/includes/set-level/javascript.mdx | 4 ++-- src/platforms/javascript/common/troubleshooting/index.mdx | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/includes/enriching-events/breadcrumbs/breadcrumbs-example/javascript.mdx b/src/includes/enriching-events/breadcrumbs/breadcrumbs-example/javascript.mdx index 5ce3dd4419bea..2b8e35da637fc 100644 --- a/src/includes/enriching-events/breadcrumbs/breadcrumbs-example/javascript.mdx +++ b/src/includes/enriching-events/breadcrumbs/breadcrumbs-example/javascript.mdx @@ -2,6 +2,6 @@ Sentry.addBreadcrumb({ category: "auth", message: "Authenticated user " + user.email, - level: Sentry.Severity.Info, + level: "info", }); ``` diff --git a/src/includes/set-level/javascript.mdx b/src/includes/set-level/javascript.mdx index b2054bba043fe..598566bba7398 100644 --- a/src/includes/set-level/javascript.mdx +++ b/src/includes/set-level/javascript.mdx @@ -8,7 +8,7 @@ To set the level within scope, you can call `setLevel()`: ```javascript Sentry.configureScope(function(scope) { - scope.setLevel(Sentry.Severity.Warning); + scope.setLevel("warning"); }); ``` @@ -20,8 +20,8 @@ Sentry.withScope(function(scope) { // The exception has the event level set by the scope (info). Sentry.captureException(new Error("custom error")); - }); + // Outside of withScope, the Event level will have their previous value restored. // The exception has the event level set (error). Sentry.captureException(new Error("custom error 2")); diff --git a/src/platforms/javascript/common/troubleshooting/index.mdx b/src/platforms/javascript/common/troubleshooting/index.mdx index 9c392ef24e8b9..16ce578cd4f86 100644 --- a/src/platforms/javascript/common/troubleshooting/index.mdx +++ b/src/platforms/javascript/common/troubleshooting/index.mdx @@ -395,12 +395,12 @@ document.body.addEventListener( if (event.target.tagName === "IMG") { Sentry.captureMessage( `Failed to load image: ${event.target.src}`, - Sentry.Severity.Warning + "warning" // message severiity level ); } else if (event.target.tagName === "LINK") { Sentry.captureMessage( `Failed to load css: ${event.target.href}`, - Sentry.Severity.Warning + "warning" // message severiity level ); } }, From 62a6b3a2833a58399b235731ed65d4b7be1865f6 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Thu, 14 Apr 2022 14:16:01 +0200 Subject: [PATCH 2/3] Fix typo Co-authored-by: Lukas Stracke --- src/platforms/javascript/common/troubleshooting/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/platforms/javascript/common/troubleshooting/index.mdx b/src/platforms/javascript/common/troubleshooting/index.mdx index 16ce578cd4f86..ce2b2bc076230 100644 --- a/src/platforms/javascript/common/troubleshooting/index.mdx +++ b/src/platforms/javascript/common/troubleshooting/index.mdx @@ -395,12 +395,12 @@ document.body.addEventListener( if (event.target.tagName === "IMG") { Sentry.captureMessage( `Failed to load image: ${event.target.src}`, - "warning" // message severiity level + "warning" // message severity level ); } else if (event.target.tagName === "LINK") { Sentry.captureMessage( `Failed to load css: ${event.target.href}`, - "warning" // message severiity level + "warning" // message severity level ); } }, From 52ec5bc2cc05d8b797633c79c10c1dfc17d843bd Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Thu, 14 Apr 2022 14:42:12 +0200 Subject: [PATCH 3/3] Add section explaining possible breadcrumb levels --- src/includes/set-level/javascript.mdx | 2 ++ src/platforms/common/enriching-events/breadcrumbs.mdx | 6 ++++++ src/platforms/javascript/common/troubleshooting/index.mdx | 4 ++-- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/includes/set-level/javascript.mdx b/src/includes/set-level/javascript.mdx index 598566bba7398..f7adc31d9c503 100644 --- a/src/includes/set-level/javascript.mdx +++ b/src/includes/set-level/javascript.mdx @@ -4,6 +4,8 @@ To set the level out of scope, you can call `captureMessage()` per event: Sentry.captureMessage("this is a debug message", "debug"); ``` +Available levels are `"fatal"`, `"critical"`, `"error"`, `"warning"`, `"log"`, `"info"`, and `"debug"`. + To set the level within scope, you can call `setLevel()`: ```javascript diff --git a/src/platforms/common/enriching-events/breadcrumbs.mdx b/src/platforms/common/enriching-events/breadcrumbs.mdx index 0066bbc0c07b9..da17a653e9e2b 100644 --- a/src/platforms/common/enriching-events/breadcrumbs.mdx +++ b/src/platforms/common/enriching-events/breadcrumbs.mdx @@ -41,6 +41,12 @@ The available breadcrumb keys are `type`, `category`, `message`, `level`, `times + + +You can choose from the following breadcrumb log levels: `"fatal"`, `"critical"`, `"error"`, `"warning"`, `"log"`, `"info"`, and `"debug"`. + + + ## Automatic Breadcrumbs diff --git a/src/platforms/javascript/common/troubleshooting/index.mdx b/src/platforms/javascript/common/troubleshooting/index.mdx index ce2b2bc076230..c5772d7e29fbe 100644 --- a/src/platforms/javascript/common/troubleshooting/index.mdx +++ b/src/platforms/javascript/common/troubleshooting/index.mdx @@ -395,12 +395,12 @@ document.body.addEventListener( if (event.target.tagName === "IMG") { Sentry.captureMessage( `Failed to load image: ${event.target.src}`, - "warning" // message severity level + "warning" ); } else if (event.target.tagName === "LINK") { Sentry.captureMessage( `Failed to load css: ${event.target.href}`, - "warning" // message severity level + "warning" ); } },