Skip to content

Commit 8d509ae

Browse files
committed
Merge branch 'master' of github.com:getsentry/sentry-docs into smi/react/router-clean-up
2 parents a5ff0ca + 51894fe commit 8d509ae

File tree

65 files changed

+348
-95
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+348
-95
lines changed

develop-docs/backend/application-domains/database-migrations/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,9 @@ This is complicated due to our deploy process. When we deploy, we run migrations
134134

135135
To avoid this, follow these steps:
136136

137-
- Make a PR to remove all uses of the column in the codebase in a separate PR. This mostly helps with code cleanliness. This should be merged ahead of the migration prs, but we don't need to worry about whether it is deployed first.
137+
- First, if the column is either not nullable, or doesn't have a `db_default` set, then make a PR to make it nullable via `null=True`.
138+
- Then, remove all uses of the column in the codebase in a separate PR; this mostly helps with code cleanliness. This should be merged ahead of the next migration PRs, but we don't need to worry about whether it is deployed first.
138139
- Make another PR that:
139-
- Checks if the column is either not nullable, or doesn't have a `db_default` set. If either of these is true, then make it nullable via `null=True`.
140140
- If the column is a foreign key, remove the database level foreign key constraint it by setting `db_constraint=False`.
141141
- Remove the column and in the generated migration use `SafeRemoveField(..., deletion_action=DeletionAction.MOVE_TO_PENDING)` to replace `RemoveField(...)`. This only marks the state for the column as removed.
142142
- Combine these migrations together to save making multiple deploys

docs/contributing/pages/components.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,12 @@ Render an expandable section to provide additional information to users on deman
130130
provide optional information that can help users be more successful.
131131
</Expandable>
132132

133+
<Expandable title="Expandable with a code block">
134+
```js
135+
const foo = 'bar';
136+
```
137+
</Expandable>
138+
133139
```markdown {tabTitle:Example}
134140
<Expandable title="Here's something worth noting">
135141
This is an expandable section in an `'info'` alert style.

docs/platforms/android/troubleshooting/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,3 +318,5 @@ This problem is only relevant to these specific versions: `sentry-android-core`
318318
</Alert>
319319

320320
Check [this issue](https://github.com/getsentry/sentry-android-gradle-plugin/issues/329) for more details.
321+
322+
<PageGrid />
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Mixed Versions
3+
description: "Troubleshoot and resolve mixed Android SDK dependency versions."
4+
sidebar_order: 1000
5+
---
6+
7+
Using multiple Android SDK dependencies with mixed versions is not supported as it is very likely to lead to a crash later on. For this reason we chose to crash the application on SDK init instead.
8+
9+
## Multiple Dependencies With Mixed Versions
10+
11+
The following snippet shows a mixed version conflict caused by using `sentry` with version `8.6.0` and `sentry-android` with version `8.7.0`. To fix the issue, set the same version for all dependencies or <PlatformLink to="/configuration/bill-of-materials/">use `sentry-bom`</PlatformLink>. This may also happen if you are using an internal library which has a different version defined.
12+
13+
```groovy {tabTitle:Gradle}{filename:build.gradle}
14+
implementation('io.sentry:sentry:8.6.0')
15+
implementation('io.sentry:sentry-android:8.7.0')
16+
```
17+
```xml {tabTitle:Maven}{filename:pom.xml}
18+
<dependencyManagement>
19+
<dependencies>
20+
<dependency>
21+
<groupId>io.sentry</groupId>
22+
<artifactId>sentry</artifactId>
23+
<version>8.6.0</version>
24+
</dependency>
25+
<dependency>
26+
<groupId>io.sentry</groupId>
27+
<artifactId>sentry-android</artifactId>
28+
<version>8.7.0</version>
29+
</dependency>
30+
</dependencies>
31+
</dependencyManagement>
32+
```
33+
34+
## Build Plugin And Explicit Dependency
35+
36+
When using our Gradle or Maven plugin and manually defining additional Sentry Android SDK dependencies, it is also possible to end up with mixed versions. The following snippet shows the plugin being configured to use version `8.0.0` but there is an additional dependency that has been set to version `8.1.0`. To fix the issue, set the same version or <PlatformLink to="/configuration/bill-of-materials/">use `sentry-bom`</PlatformLink>.
37+
38+
```groovy {tabTitle:Gradle}{filename:build.gradle}
39+
plugins { id "io.sentry.android.gradle" version "5.3.0" }
40+
41+
dependencies {
42+
implementation 'io.sentry:sentry-okhttp:8.1.0'
43+
}
44+
45+
sentry {
46+
autoInstallation {
47+
sentryVersion = "8.0.0"
48+
}
49+
}
50+
```
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Troubleshooting
3+
description: "Troubleshoot and resolve common issues with the Java SDK."
4+
sidebar_order: 9000
5+
---
6+
7+
<PageGrid />
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: Mixed Versions
3+
description: "Troubleshoot and resolve mixed Java SDK dependency versions."
4+
sidebar_order: 1000
5+
---
6+
7+
Using multiple Java SDK dependencies with mixed versions is not supported as it is very likely to lead to a crash later on. For this reason we chose to crash the application on SDK init instead.
8+
9+
## Multiple Dependencies With Mixed Versions
10+
11+
The following snippet shows a mixed version conflict caused by using `sentry` with version `8.6.0` and `sentry-logback` with version `8.7.0`. To fix the issue please set the same version for all dependencies or <PlatformLink to="/configuration/bill-of-materials/">use `sentry-bom`</PlatformLink>. This may also happen if you are using an internal library which has a different version defined.
12+
13+
```groovy {tabTitle:Gradle}{filename:build.gradle}
14+
implementation('io.sentry:sentry:8.6.0')
15+
implementation('io.sentry:sentry-logback:8.7.0')
16+
```
17+
```xml {tabTitle:Maven}{filename:pom.xml}
18+
<dependencyManagement>
19+
<dependencies>
20+
<dependency>
21+
<groupId>io.sentry</groupId>
22+
<artifactId>sentry</artifactId>
23+
<version>8.6.0</version>
24+
</dependency>
25+
<dependency>
26+
<groupId>io.sentry</groupId>
27+
<artifactId>sentry-logback</artifactId>
28+
<version>8.7.0</version>
29+
</dependency>
30+
</dependencies>
31+
</dependencyManagement>
32+
```
33+
34+
## Build Plugin And Explicit Dependency
35+
36+
When using our Gradle or Maven plugin and manually defining additional Sentry Java SDK dependencies, it is also possible to end up with mixed versions. The following snippet shows the plugin being configured to use version `8.0.0`, but there is an additional dependency that has been set to version `8.1.0`. To fix the issue, set the same version or <PlatformLink to="/configuration/bill-of-materials/">use `sentry-bom`</PlatformLink>.
37+
38+
```groovy {tabTitle:Gradle}{filename:build.gradle}
39+
plugins { id "io.sentry.android.gradle" version "5.3.0" }
40+
41+
dependencies {
42+
implementation 'io.sentry:sentry-opentelemetry-agentless-spring:8.1.0'
43+
}
44+
45+
sentry {
46+
autoInstallation {
47+
sentryVersion = "8.0.0"
48+
}
49+
}
50+
```
51+
52+
## Agent Version And Build Time Version
53+
54+
When using `sentry-opentelemetry-agent` you may end up using a version of the Agent that differs from other Sentry Java SDK dependencies you are using. This is also not supported. Use the same version for `sentry-opentelemetry-agent` and all other Java SDK dependencies.

docs/platforms/javascript/common/tracing/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Learn how to enable tracing in your app."
44
sidebar_order: 4000
55
---
66

7-
With [tracing](/product/insights/overview/), Sentry automatically tracks your software performance across your application services, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems.
7+
With [tracing](/product/insights/overview/), Sentry automatically tracks your software performance across your application services, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems.
88

99
<PlatformCategorySection supported={["server", "serverless"]}>
1010
<Alert>
@@ -45,7 +45,7 @@ With [tracing](/product/insights/overview/), Sentry automatically tracks your so
4545

4646
The two options are mutually exclusive. If both are set, <PlatformIdentifier name="traces-sampler" /> will take precedence.
4747

48-
Learn more about tracing <PlatformLink to="/configuration/options/#tracing-options">options</PlatformLink>, how to use the <PlatformLink to="/configuration/sampling/#setting-a-sampling-function">tracesSampler</PlatformLink> function, or how to <PlatformLink to="/configuration/sampling/#sampling-transaction-events">sample transactions</PlatformLink>.
48+
You can find more in-depth explanations and examples about sampling configuration in [Configure Sampling](./configure-sampling).
4949

5050
## Distributed Tracing
5151

docs/platforms/javascript/common/troubleshooting/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ To fix this, change the `tracePropagationTargets` option during SDK initializati
105105
</PlatformCategorySection>
106106

107107
<PlatformCategorySection notSupported={['browser']}>
108-
<PlatformSection notSupported={['javascript.aws-lambda', 'javascript.azure-functions', 'javascript.bun', 'javascript.cloudflare', 'javascript.deno', 'javascript.electron', 'javascript.gcp-functions']}>
108+
<PlatformSection notSupported={['javascript.aws-lambda', 'javascript.azure-functions', 'javascript.bun', 'javascript.cloudflare', 'javascript.deno', 'javascript.electron', 'javascript.gcp-functions', 'javascript.tanstackstart-react']}>
109109
<Expandable permalink title="Error: 'import-in-the-middle' failed to wrap">
110110
When using ESM, by default all packages are wrapped under the hood by
111111
[import-in-the-middle](https://www.npmjs.com/package/import-in-the-middle).

docs/platforms/javascript/guides/remix/manual-setup.mdx

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -124,22 +124,6 @@ function App() {
124124
export default withSentry(App);
125125
```
126126

127-
You can disable or configure `ErrorBoundary` using a second parameter to `withSentry`.
128-
129-
```tsx
130-
withSentry(App, {
131-
wrapWithErrorBoundary: false,
132-
});
133-
134-
// or
135-
136-
withSentry(App, {
137-
errorBoundaryOptions: {
138-
fallback: <p>An error has occurred</p>,
139-
},
140-
});
141-
```
142-
143127
### Server-side Configuration
144128

145129
Create an instrumentation file (named here as `instrument.server.mjs`) in your project. Add your initialization code in this file for the server-side SDK.

docs/platforms/javascript/guides/svelte/index.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,18 @@ Once you've done this, the SDK will automatically capture unhandled errors and p
131131

132132
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
133133

134-
```jsx {tabTitle:Svelte} {filename:SomeCmponent.svelte}
134+
```jsx {tabTitle:Svelte v5+} {filename:SomeCmponent.svelte}
135+
<button
136+
type="button"
137+
onclick={() => {
138+
throw new Error("Sentry Frontend Error");
139+
}}
140+
>
141+
Throw error
142+
</button>
143+
```
144+
145+
```jsx {tabTitle:Svelte v3/v4} {filename:SomeCmponent.svelte}
135146
<button
136147
type="button"
137148
on:click={() => {

0 commit comments

Comments
 (0)