From 1a5f12be5e8b8e3a5b244cbe00c051c30022d9c7 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 22 Jan 2025 11:09:14 +0100 Subject: [PATCH 01/12] better example --- docs/contributing/pages/components.mdx | 40 ++++++++++++++++++++++---- 1 file changed, 34 insertions(+), 6 deletions(-) diff --git a/docs/contributing/pages/components.mdx b/docs/contributing/pages/components.mdx index f34d65764b36b..74c41063b6fbc 100644 --- a/docs/contributing/pages/components.mdx +++ b/docs/contributing/pages/components.mdx @@ -8,13 +8,41 @@ sidebar_order: 40 Render an alert callout. - -This is an alert + +This is an info alert. Use these for information that's critical to know; it's important for users to read, but won't cause a catastrophic problem if they don't read it. These include versions that introduce breaking changes or feature limitations. Use infrequently. -```markdown {tabTitle:Example} - -This is an alert + +This is a warning alert. Use these for items that MUST be well understood before proceeding. These highlight information that could cause users to make catastrophic errors that break their applications in ways that are very difficult to fix or create liabilities for them, such as information needed to avoid leaking PII. These should be used very rarely. + + + +This is an alert without title. + + + +
    +
  • Item 1
    • +
  • Item 2
    • +
+ + + +```markdown {tabTitle:Info} + +This is an info alert. + +``` + +```markdown {tabTitle:Warning} + +This is a warning alert. + +``` + +```markdown {tabTitle:No Title} + +This is an alert without title. ``` @@ -30,7 +58,7 @@ Use this for these types of content: - **Warning:** Use these for items that MUST be well understood before proceeding. These highlight information that could cause users to make catastrophic errors that break their applications in ways that are very difficult to fix or create liabilities for them, such as information needed to avoid leaking PII. These should be used very rarely. - Use with the title "Important"; do not use the title "Warning" -An Alert component with no level setting will render as a Note component. +You can also omit the title of the alert. See also the [Note component](#note). From 184431819f21418d8016e10f467a61c5b8bb90af Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 22 Jan 2025 11:11:22 +0100 Subject: [PATCH 02/12] update style --- app/globals.css | 3 ++ src/components/alert/index.tsx | 10 ++++-- src/components/alert/styles.scss | 55 ++++++++++++++++---------------- 3 files changed, 39 insertions(+), 29 deletions(-) diff --git a/app/globals.css b/app/globals.css index 11591d2a063dd..c8b3825ee1f8b 100644 --- a/app/globals.css +++ b/app/globals.css @@ -63,6 +63,9 @@ --flame7: #edcf9e; --flame8: #ffefae; + /* Desaturated oranges */ + --desatFlame8: #fefbe9; + /* A range of desaturated purples */ --desatPurple0: #0f0a1f; --desatPurple1: #231c3d; diff --git a/src/components/alert/index.tsx b/src/components/alert/index.tsx index 99de24e07ce2f..10ed74a7b00b3 100644 --- a/src/components/alert/index.tsx +++ b/src/components/alert/index.tsx @@ -1,4 +1,5 @@ import {ReactNode} from 'react'; +import {ExclamationTriangleIcon, InfoCircledIcon} from '@radix-ui/react-icons'; // explicitly not usig CSS modules here // because there's some prerendered content that depends on these exact class names @@ -11,10 +12,15 @@ type AlertProps = { }; export function Alert({title, children, level = 'info'}: AlertProps) { + const Icon = level === 'warning' ? ExclamationTriangleIcon : InfoCircledIcon; + return (
- {title &&
{title}
} -
{children}
+ +
+ {title &&
{title}
} +
{children}
+
); } diff --git a/src/components/alert/styles.scss b/src/components/alert/styles.scss index a596c47c4cded..16d6e009b4751 100644 --- a/src/components/alert/styles.scss +++ b/src/components/alert/styles.scss @@ -1,53 +1,54 @@ .alert { background: var(--accent-2); - border-color: var(--accent-12); - border-left: 3px solid var(--accent-12); margin-bottom: 1rem; padding: 0.5rem 1rem; - - > .alert-header { - font-weight: 500; - position: relative; - font-size: 1em; - margin-bottom: 0.5rem; - margin-top: 0.25rem; - } + border-radius: 6px; + color: var(--gray-500); + display: flex; + flex-direction: row; + gap: 0.7em; + line-height: 1.75em; p { margin-bottom: 0.5rem; + margin-top: 0; } strong { font-weight: 500; } - ul { + ul, ol { padding-inline-start: 2rem; + margin-top: 0; } - p:last-of-type, - ul:last-of-type { - margin-bottom: 0; + li { + padding-inline-start: 0; + margin: 0; } +} - p:first-of-type, - ul:first-of-type { - margin-top: 0; - } +.alert-icon { + flex: 1em 0 0; + height: 1.75em; +} - .alert-body { - font-size: 0.9rem; - } +.alert-content { +} + +.alert-header { + font-weight: 500; } .alert-info { - background: var(--blue-2); - border-color: var(--blue-11); - color: var(--blue-12); + background: var(--desatPurple15); } .alert-warning { - background: var(--amber-2); - border-color: var(--amber-10); - color: var(--amber-12); + background: var(--desatFlame8); + + > .alert-icon { + color: var(--flame5); + } } From e7c7bc2452f2d645705f0b5f90b7d941d673b42c Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 22 Jan 2025 11:16:26 +0100 Subject: [PATCH 03/12] small tweaks --- docs/contributing/pages/components.mdx | 4 ++++ src/components/alert/index.tsx | 8 ++------ 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/contributing/pages/components.mdx b/docs/contributing/pages/components.mdx index 74c41063b6fbc..37b135de49ee2 100644 --- a/docs/contributing/pages/components.mdx +++ b/docs/contributing/pages/components.mdx @@ -20,6 +20,10 @@ This is a warning alert. Use these for items that MUST be well understood before This is an alert without title. + +This is a multi-line alert without title. Use these for information that's critical to know; it's important for users to read, but won't cause a catastrophic problem if they don't read it. These include versions that introduce breaking changes or feature limitations. Use infrequently. + +
  • Item 1
    • diff --git a/src/components/alert/index.tsx b/src/components/alert/index.tsx index 10ed74a7b00b3..f4144a619e48e 100644 --- a/src/components/alert/index.tsx +++ b/src/components/alert/index.tsx @@ -16,7 +16,7 @@ export function Alert({title, children, level = 'info'}: AlertProps) { return (
    - +
    {title &&
    {title}
    }
    {children}
    @@ -30,9 +30,5 @@ type NoteProps = { }; export function Note({children}: NoteProps) { - return ( -
    -
    {children}
    -
    - ); + return {children}; } From f048c217f0d147722c9adfe6a42334ca5a379dac Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 22 Jan 2025 11:21:40 +0100 Subject: [PATCH 04/12] small style tweak --- src/components/alert/styles.scss | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/components/alert/styles.scss b/src/components/alert/styles.scss index 16d6e009b4751..7a4580ce52559 100644 --- a/src/components/alert/styles.scss +++ b/src/components/alert/styles.scss @@ -18,7 +18,8 @@ font-weight: 500; } - ul, ol { + ul, + ol { padding-inline-start: 2rem; margin-top: 0; } @@ -34,9 +35,6 @@ height: 1.75em; } -.alert-content { -} - .alert-header { font-weight: 500; } From a6a31a1e855cb80d67bec4d46f8d51ff0e04bb8d Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 22 Jan 2025 12:51:34 +0100 Subject: [PATCH 05/12] use transparency for alert background colors --- src/components/alert/styles.scss | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/components/alert/styles.scss b/src/components/alert/styles.scss index 7a4580ce52559..82e0c2da77e2e 100644 --- a/src/components/alert/styles.scss +++ b/src/components/alert/styles.scss @@ -41,10 +41,12 @@ .alert-info { background: var(--desatPurple15); + background: color-mix(in srgb, var(--desatPurple15), transparent 10%); } .alert-warning { background: var(--desatFlame8); + background: color-mix(in srgb, var(--desatFlame8), transparent 10%); > .alert-icon { color: var(--flame5); From 165d29c81e2773f917fd574c84203fdf37295c2c Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 22 Jan 2025 14:58:27 +0100 Subject: [PATCH 06/12] Add success --- docs/contributing/pages/components.mdx | 12 +++++++++++- src/components/alert/index.tsx | 16 +++++++++++++--- src/components/alert/styles.scss | 5 +++++ 3 files changed, 29 insertions(+), 4 deletions(-) diff --git a/docs/contributing/pages/components.mdx b/docs/contributing/pages/components.mdx index 37b135de49ee2..3b20613f1b150 100644 --- a/docs/contributing/pages/components.mdx +++ b/docs/contributing/pages/components.mdx @@ -16,6 +16,10 @@ This is an info alert. Use these for information that's critical to know; it's i This is a warning alert. Use these for items that MUST be well understood before proceeding. These highlight information that could cause users to make catastrophic errors that break their applications in ways that are very difficult to fix or create liabilities for them, such as information needed to avoid leaking PII. These should be used very rarely. + +This is a success alert. Use these when.... TODO? + + This is an alert without title. @@ -44,6 +48,12 @@ This is a warning alert. ``` +```markdown {tabTitle:Success} + +This is a success alert. + +``` + ```markdown {tabTitle:No Title} This is an alert without title. @@ -53,7 +63,7 @@ This is an alert without title. Attributes: - `title` (string) - optional -- `level` (string: `'info' | 'warning') - optional, defaults to `'info'` +- `level` (string: `'info' | 'warning' | 'success') - optional, defaults to `'info'` Use this for these types of content: diff --git a/src/components/alert/index.tsx b/src/components/alert/index.tsx index f4144a619e48e..cd019a2038b94 100644 --- a/src/components/alert/index.tsx +++ b/src/components/alert/index.tsx @@ -1,5 +1,9 @@ import {ReactNode} from 'react'; -import {ExclamationTriangleIcon, InfoCircledIcon} from '@radix-ui/react-icons'; +import { + CheckCircledIcon, + ExclamationTriangleIcon, + InfoCircledIcon, +} from '@radix-ui/react-icons'; // explicitly not usig CSS modules here // because there's some prerendered content that depends on these exact class names @@ -7,12 +11,18 @@ import './styles.scss'; type AlertProps = { children?: ReactNode; - level?: 'info' | 'warning'; + level?: 'info' | 'warning' | 'success'; title?: string; }; +const ICON_MAP = { + info: InfoCircledIcon, + warning: ExclamationTriangleIcon, + success: CheckCircledIcon, +} as const; + export function Alert({title, children, level = 'info'}: AlertProps) { - const Icon = level === 'warning' ? ExclamationTriangleIcon : InfoCircledIcon; + const Icon = ICON_MAP[level]; return (
    diff --git a/src/components/alert/styles.scss b/src/components/alert/styles.scss index 82e0c2da77e2e..f46aec7bc262b 100644 --- a/src/components/alert/styles.scss +++ b/src/components/alert/styles.scss @@ -44,6 +44,11 @@ background: color-mix(in srgb, var(--desatPurple15), transparent 10%); } +.alert-success { + background: var(--successGreen); + background: color-mix(in srgb, var(--successGreen), transparent 85%); +} + .alert-warning { background: var(--desatFlame8); background: color-mix(in srgb, var(--desatFlame8), transparent 10%); From 212a1f84b1bc80602f4043d98965689c8fd7c9f1 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 22 Jan 2025 16:58:00 +0100 Subject: [PATCH 07/12] style fixes --- src/components/alert/styles.scss | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/src/components/alert/styles.scss b/src/components/alert/styles.scss index f46aec7bc262b..ca540b149f07b 100644 --- a/src/components/alert/styles.scss +++ b/src/components/alert/styles.scss @@ -1,5 +1,4 @@ .alert { - background: var(--accent-2); margin-bottom: 1rem; padding: 0.5rem 1rem; border-radius: 6px; @@ -8,6 +7,7 @@ flex-direction: row; gap: 0.7em; line-height: 1.75em; + border: 1px solid var(--alert-highlight-color); p { margin-bottom: 0.5rem; @@ -28,32 +28,31 @@ padding-inline-start: 0; margin: 0; } + + .alert-header { + font-weight: 500; + color: inherit; + } } .alert-icon { flex: 1em 0 0; height: 1.75em; -} - -.alert-header { - font-weight: 500; + color: var(--alert-highlight-color); } .alert-info { + --alert-highlight-color: var(--desatPurple5); background: var(--desatPurple15); - background: color-mix(in srgb, var(--desatPurple15), transparent 10%); } .alert-success { + --alert-highlight-color: var(--successGreen); background: var(--successGreen); background: color-mix(in srgb, var(--successGreen), transparent 85%); } .alert-warning { + --alert-highlight-color: var(--flame0); background: var(--desatFlame8); - background: color-mix(in srgb, var(--desatFlame8), transparent 10%); - - > .alert-icon { - color: var(--flame5); - } } From c7a6c127fc39dc7b3240a7887d410e1d33ce2965 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 22 Jan 2025 17:21:35 +0100 Subject: [PATCH 08/12] fix empty level usage --- .../android/enriching-events/breadcrumbs/index.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../dart/enriching-events/breadcrumbs/index.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../configuration/advanced-configuration-example.mdx | 2 +- docs/platforms/dotnet/guides/nlog/index.mdx | 2 +- .../elixir/enriching-events/breadcrumbs/index.mdx | 2 +- .../flutter/enriching-events/breadcrumbs/index.mdx | 2 +- .../go/common/enriching-events/breadcrumbs/index.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../javascript/common/user-feedback/index.mdx | 2 +- .../enriching-events/breadcrumbs/index.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- docs/platforms/native/guides/minidumps/index.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../enriching-events/breadcrumbs/index.mdx | 2 +- .../python/enriching-events/breadcrumbs/index.mdx | 2 +- docs/platforms/python/legacy-sdk/integrations.mdx | 4 ++-- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../unity/enriching-events/breadcrumbs/index.mdx | 2 +- .../configuration/config-intro/dotnet.nlog.mdx | 2 +- platform-includes/debug-symbols-apple/_default.mdx | 12 ++++++------ .../enriching-events/set-tag/dotnet.nlog.mdx | 2 +- .../enriching-events/set-user/dotnet.nlog.mdx | 2 +- platform-includes/set-environment/dotnet.nlog.mdx | 2 +- platform-includes/set-release/dotnet.nlog.mdx | 2 +- 28 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/platforms/android/enriching-events/breadcrumbs/index.mdx b/docs/platforms/android/enriching-events/breadcrumbs/index.mdx index 65ee11d1ef2c9..8c0e4e7c0e248 100644 --- a/docs/platforms/android/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/android/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/apple/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/apple/common/enriching-events/breadcrumbs/index.mdx index 6dc26dd026ee5..8e7e926c06d48 100644 --- a/docs/platforms/apple/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/apple/common/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/dart/enriching-events/breadcrumbs/index.mdx b/docs/platforms/dart/enriching-events/breadcrumbs/index.mdx index 65ee11d1ef2c9..8c0e4e7c0e248 100644 --- a/docs/platforms/dart/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/dart/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx index e65703cd2ddbc..909b014f6d0e8 100644 --- a/docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/dotnet/guides/nlog/configuration/advanced-configuration-example.mdx b/docs/platforms/dotnet/guides/nlog/configuration/advanced-configuration-example.mdx index ff09d773c7064..4d0fe3d543278 100644 --- a/docs/platforms/dotnet/guides/nlog/configuration/advanced-configuration-example.mdx +++ b/docs/platforms/dotnet/guides/nlog/configuration/advanced-configuration-example.mdx @@ -4,7 +4,7 @@ sidebar_order: 20 description: "Review an advanced example of configuration for NLog." --- - + For more information on how to dynamically set event data via `NLog.config`, see NLog's [layout renderer documentation](https://nlog-project.org/config/?tab=layout-renderers). diff --git a/docs/platforms/dotnet/guides/nlog/index.mdx b/docs/platforms/dotnet/guides/nlog/index.mdx index 93edc6653f525..b17176d4ced46 100644 --- a/docs/platforms/dotnet/guides/nlog/index.mdx +++ b/docs/platforms/dotnet/guides/nlog/index.mdx @@ -41,7 +41,7 @@ Messages logged from assemblies with the name starting with `Sentry` will not ge ## Configure - + For more information on how to dynamically set event data via `NLog.config`, see NLog's [layout renderer documentation](https://nlog-project.org/config/?tab=layout-renderers). diff --git a/docs/platforms/elixir/enriching-events/breadcrumbs/index.mdx b/docs/platforms/elixir/enriching-events/breadcrumbs/index.mdx index d09de40983e63..8af656caaa6a4 100644 --- a/docs/platforms/elixir/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/elixir/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/flutter/enriching-events/breadcrumbs/index.mdx b/docs/platforms/flutter/enriching-events/breadcrumbs/index.mdx index 65ee11d1ef2c9..8c0e4e7c0e248 100644 --- a/docs/platforms/flutter/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/flutter/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/go/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/go/common/enriching-events/breadcrumbs/index.mdx index 65ee11d1ef2c9..8c0e4e7c0e248 100644 --- a/docs/platforms/go/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/go/common/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/java/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/java/common/enriching-events/breadcrumbs/index.mdx index 65ee11d1ef2c9..8c0e4e7c0e248 100644 --- a/docs/platforms/java/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/java/common/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/javascript/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/javascript/common/enriching-events/breadcrumbs/index.mdx index 2c84f0ffac7db..b3a0d840fa168 100644 --- a/docs/platforms/javascript/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/javascript/common/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/javascript/common/user-feedback/index.mdx b/docs/platforms/javascript/common/user-feedback/index.mdx index 8e993fe5f929c..1feb8875db05c 100644 --- a/docs/platforms/javascript/common/user-feedback/index.mdx +++ b/docs/platforms/javascript/common/user-feedback/index.mdx @@ -35,7 +35,7 @@ By default, this will insert the widget into the bottom right corner of your web On SDK version 8.0.0 and above, users can send screenshots with their feedback. If you're self-hosting, you also need release 24.4.2 and above. You can configure this using the `enableScreenshot` option, by default it is set to `true`. Screenshots aren't supported on mobile devices, so the screenshot button will be hidden automatically in this case. - + Screenshots use your [attachments quota](/pricing/quotas/manage-attachments-quota). All plans come with 1GB of attachments, which is approxiamately 2500 screenshots. diff --git a/docs/platforms/kotlin/guides/kotlin-multiplatform/enriching-events/breadcrumbs/index.mdx b/docs/platforms/kotlin/guides/kotlin-multiplatform/enriching-events/breadcrumbs/index.mdx index e65703cd2ddbc..909b014f6d0e8 100644 --- a/docs/platforms/kotlin/guides/kotlin-multiplatform/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/kotlin/guides/kotlin-multiplatform/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/native/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/native/common/enriching-events/breadcrumbs/index.mdx index e5e5824ec1ccc..0d358e424c91d 100644 --- a/docs/platforms/native/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/native/common/enriching-events/breadcrumbs/index.mdx @@ -12,7 +12,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/native/guides/minidumps/index.mdx b/docs/platforms/native/guides/minidumps/index.mdx index 4e4871be2313b..473e5f184fd7e 100644 --- a/docs/platforms/native/guides/minidumps/index.mdx +++ b/docs/platforms/native/guides/minidumps/index.mdx @@ -34,7 +34,7 @@ and can later be uploaded to Sentry. A minidump typically includes: assertion message is also included in the dump. - Meta data about the CPU architecture and the user’s operating system. - + Minidumps are memory dumps of the process at the moment it crashes. As such, they might contain sensitive information on the target system, such as diff --git a/docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx index 77705a3b49b90..0770caef65c39 100644 --- a/docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/powershell/enriching-events/breadcrumbs/index.mdx b/docs/platforms/powershell/enriching-events/breadcrumbs/index.mdx index 032b4b2fafdb0..c780b4de862d2 100644 --- a/docs/platforms/powershell/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/powershell/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/python/enriching-events/breadcrumbs/index.mdx b/docs/platforms/python/enriching-events/breadcrumbs/index.mdx index 77705a3b49b90..0770caef65c39 100644 --- a/docs/platforms/python/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/python/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/python/legacy-sdk/integrations.mdx b/docs/platforms/python/legacy-sdk/integrations.mdx index 89925ef576647..c0d3c5c1a13a7 100644 --- a/docs/platforms/python/legacy-sdk/integrations.mdx +++ b/docs/platforms/python/legacy-sdk/integrations.mdx @@ -875,7 +875,7 @@ logger.error('There was an error, with a stack trace!', extra={ }) ``` - + Depending on the version of Python you’re using, `extra` might not be an acceptable keyword argument for a logger’s `.exception()` method (`.debug()`, `.info()`, `.warning()`, `.error()` and `.critical()` should work fine regardless of Python version). This should be fixed as of Python 2.7.4 and 3.2. Official issue here: [bugs.python.org/issue15541](https://bugs.python.org/issue15541). @@ -1200,7 +1200,7 @@ class AsyncExceptionHandler(SentryMixin, tornado.web.RequestHandler): self.finish() ``` - + The value returned by the yield is a `HTTPResponse` object. diff --git a/docs/platforms/ruby/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/ruby/common/enriching-events/breadcrumbs/index.mdx index 77705a3b49b90..0770caef65c39 100644 --- a/docs/platforms/ruby/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/ruby/common/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/rust/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/rust/common/enriching-events/breadcrumbs/index.mdx index 04082cdb3efd9..d61b0079f3b2d 100644 --- a/docs/platforms/rust/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/rust/common/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/unity/enriching-events/breadcrumbs/index.mdx b/docs/platforms/unity/enriching-events/breadcrumbs/index.mdx index e65703cd2ddbc..909b014f6d0e8 100644 --- a/docs/platforms/unity/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/unity/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/platform-includes/configuration/config-intro/dotnet.nlog.mdx b/platform-includes/configuration/config-intro/dotnet.nlog.mdx index 7f406b6e56b6b..fcde9145aad18 100644 --- a/platform-includes/configuration/config-intro/dotnet.nlog.mdx +++ b/platform-includes/configuration/config-intro/dotnet.nlog.mdx @@ -1,4 +1,4 @@ - + For more information on how to dynamically set event data via `NLog.config`, see NLog's [layout renderer documentation](https://nlog-project.org/config/?tab=layout-renderers). diff --git a/platform-includes/debug-symbols-apple/_default.mdx b/platform-includes/debug-symbols-apple/_default.mdx index 96e691d59dac4..2392f5dacb143 100644 --- a/platform-includes/debug-symbols-apple/_default.mdx +++ b/platform-includes/debug-symbols-apple/_default.mdx @@ -29,7 +29,7 @@ You can also upload your code for source context. This feature allows Sentry to +/> ```bash {"onboardingOptions": {"source-context": "2"}} sentry-cli debug-files upload --auth-token ___ORG_AUTH_TOKEN___ \ @@ -74,7 +74,7 @@ sentry_upload_dif( ) ``` - + By default fastlane will connect to sentry.io. For on-prem you need to provide the _url_ parameter to instruct the tool to connect to your server: @@ -96,7 +96,7 @@ Sentry can display snippets of your code next to the event stack traces. This fe For this to work, your project settings for `DEBUG_INFORMATION_FORMAT` must be set to `DWARF with dSYM File`, which is the default for release builds but not for debug builds. If you don't want Sentry to upload your source code, remove the `--include-sources` argument from the copied script. - + Depending on your needs, you may want to emit warnings to the Xcode build log to let the build pass, or emit errors to fail it. For example, in a CI deployment where debug symbols may be harder to recover, and you might not realize symbols couldn't be symbolicated until after release, it might be better to fail the build. @@ -115,7 +115,7 @@ if which sentry-cli >/dev/null; then export SENTRY_ORG=___ORG_SLUG___ export SENTRY_PROJECT=___PROJECT_SLUG___ export SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ -ERROR=$(sentry-cli debug-files upload \ +ERROR=$(sentry-cli debug-files upload \ --include-sources \ "$DWARF_DSYM_FOLDER_PATH" 2>&1 >/dev/null) if [ ! $? -eq 0 ]; then @@ -136,7 +136,7 @@ export SENTRY_ORG=___ORG_SLUG___ export SENTRY_PROJECT=___PROJECT_SLUG___ export SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ ERROR=$(sentry-cli debug-files upload \ ---include-sources \ +--include-sources \ "$DWARF_DSYM_FOLDER_PATH" --force-foreground 2>&1 >/dev/null) if [ ! $? -eq 0 ]; then echo "error: sentry-cli - $ERROR" @@ -162,7 +162,7 @@ ${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${TAR ![enable-user-script-sandboxing](./img/enable_user_script_sandboxing.png) - + By default sentry-cli will connect to sentry.io. For on-prem you need to export the _SENTRY_URL_ environment variable to instruct the tool to connect to your server: diff --git a/platform-includes/enriching-events/set-tag/dotnet.nlog.mdx b/platform-includes/enriching-events/set-tag/dotnet.nlog.mdx index afcbda6bbf216..d5917315c7a4b 100644 --- a/platform-includes/enriching-events/set-tag/dotnet.nlog.mdx +++ b/platform-includes/enriching-events/set-tag/dotnet.nlog.mdx @@ -1,4 +1,4 @@ - + For more information on how to dynamically set event tags via `NLog.config`, see NLog's [layout renderer documentation](https://nlog-project.org/config/?tab=layout-renderers). diff --git a/platform-includes/enriching-events/set-user/dotnet.nlog.mdx b/platform-includes/enriching-events/set-user/dotnet.nlog.mdx index 76e2198ef9f9c..28ec6343db210 100644 --- a/platform-includes/enriching-events/set-user/dotnet.nlog.mdx +++ b/platform-includes/enriching-events/set-user/dotnet.nlog.mdx @@ -1,4 +1,4 @@ - + - If setting it via `NLog.config`, the camelCase key `ipAddress` should be used instead of `ip_address`. - For more information on how to dynamically set event data via `NLog.config`, see NLog's [layout renderer documentation](https://nlog-project.org/config/?tab=layout-renderers). diff --git a/platform-includes/set-environment/dotnet.nlog.mdx b/platform-includes/set-environment/dotnet.nlog.mdx index a6feb04ad4aa4..9b31a70582387 100644 --- a/platform-includes/set-environment/dotnet.nlog.mdx +++ b/platform-includes/set-environment/dotnet.nlog.mdx @@ -1,4 +1,4 @@ - + For more information on how to dynamically set event data via `NLog.config`, see NLog's [layout renderer documentation](https://nlog-project.org/config/?tab=layout-renderers). diff --git a/platform-includes/set-release/dotnet.nlog.mdx b/platform-includes/set-release/dotnet.nlog.mdx index 49bc1af722a2e..7972d4f355bd3 100644 --- a/platform-includes/set-release/dotnet.nlog.mdx +++ b/platform-includes/set-release/dotnet.nlog.mdx @@ -1,4 +1,4 @@ - + For more information on how to dynamically set event data via `NLog.config`, see NLog's [layout renderer documentation](https://nlog-project.org/config/?tab=layout-renderers). From ef38899fc7dbd02ccc151bba867ba83f55f8cf46 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 22 Jan 2025 17:29:05 +0100 Subject: [PATCH 09/12] fix fix --- .../react-native/enriching-events/breadcrumbs/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/react-native/enriching-events/breadcrumbs/index.mdx b/docs/platforms/react-native/enriching-events/breadcrumbs/index.mdx index 2c84f0ffac7db..b3a0d840fa168 100644 --- a/docs/platforms/react-native/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/react-native/enriching-events/breadcrumbs/index.mdx @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs). - + Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). From e19709ab59169443665d605839aed6602c97e8be Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Thu, 23 Jan 2025 09:07:00 +0100 Subject: [PATCH 10/12] adjust styles for dark mode ?? --- app/globals.css | 3 --- src/components/alert/styles.scss | 9 ++++----- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/app/globals.css b/app/globals.css index c8b3825ee1f8b..11591d2a063dd 100644 --- a/app/globals.css +++ b/app/globals.css @@ -63,9 +63,6 @@ --flame7: #edcf9e; --flame8: #ffefae; - /* Desaturated oranges */ - --desatFlame8: #fefbe9; - /* A range of desaturated purples */ --desatPurple0: #0f0a1f; --desatPurple1: #231c3d; diff --git a/src/components/alert/styles.scss b/src/components/alert/styles.scss index ca540b149f07b..57cc3b8a10469 100644 --- a/src/components/alert/styles.scss +++ b/src/components/alert/styles.scss @@ -2,7 +2,6 @@ margin-bottom: 1rem; padding: 0.5rem 1rem; border-radius: 6px; - color: var(--gray-500); display: flex; flex-direction: row; gap: 0.7em; @@ -42,8 +41,8 @@ } .alert-info { - --alert-highlight-color: var(--desatPurple5); - background: var(--desatPurple15); + --alert-highlight-color: var(--accent-12); + background: var(--accent-2); } .alert-success { @@ -53,6 +52,6 @@ } .alert-warning { - --alert-highlight-color: var(--flame0); - background: var(--desatFlame8); + --alert-highlight-color: var(--amber-10); + background: var(--amber-2); } From bc6f8781a6e716e1ac7885fa8f183e06d9eab4c0 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Thu, 23 Jan 2025 09:25:28 +0100 Subject: [PATCH 11/12] error on invalid alert level --- develop-docs/frontend/design-tenets.mdx | 2 +- src/components/alert/index.tsx | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/develop-docs/frontend/design-tenets.mdx b/develop-docs/frontend/design-tenets.mdx index b35234dd3f41e..e1300def30b8d 100644 --- a/develop-docs/frontend/design-tenets.mdx +++ b/develop-docs/frontend/design-tenets.mdx @@ -49,7 +49,7 @@ Why minimize content refreshes? - Less rendering / data fetching for the browser - Assists user navigation by preserving sense of state ("where am I?") - + Note: while there are a few good examples of this in action in the app, we are actually pretty inconsistent applying this design principle. diff --git a/src/components/alert/index.tsx b/src/components/alert/index.tsx index cd019a2038b94..3a49aba2340f7 100644 --- a/src/components/alert/index.tsx +++ b/src/components/alert/index.tsx @@ -24,6 +24,10 @@ const ICON_MAP = { export function Alert({title, children, level = 'info'}: AlertProps) { const Icon = ICON_MAP[level]; + if (!Icon) { + throw new Error(`Invalid alert level: "${level}" passed to Alert component`); + } + return (
    From 5a74a6cbf4fed987d1b23a05d7fd316d210232b1 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Thu, 23 Jan 2025 14:18:17 +0100 Subject: [PATCH 12/12] adjust color --- src/components/alert/styles.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/alert/styles.scss b/src/components/alert/styles.scss index 57cc3b8a10469..71ef90ca2b699 100644 --- a/src/components/alert/styles.scss +++ b/src/components/alert/styles.scss @@ -41,7 +41,7 @@ } .alert-info { - --alert-highlight-color: var(--accent-12); + --alert-highlight-color: var(--accent-11); background: var(--accent-2); }