Skip to content

Commit d3173f2

Browse files
Merge remote-tracking branch 'origin' into mz/mobile-session-health-docs
2 parents d1d82df + d8915c6 commit d3173f2

File tree

82 files changed

+977
-376
lines changed

Some content is hidden

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

82 files changed

+977
-376
lines changed

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

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,19 @@ Note that if you have added a new model, you also need to import the model in `_
5454

5555
When merging to master you might notice a conflict with `migrations_lockfile.txt`. This file is in place to help us avoid merging two migrations with the same migration number to master, and if you're conflicting with it then it's likely someone has committed a migration ahead of you.
5656

57-
To resolve this, rebase against latest master, delete your current migration and then regenerate it. If your migration was custom, just save the operations in a text file somewhere so that you can reapply them on the regenerated migration.
57+
### Automatically Resolving Conflicts
58+
59+
There is a [useful script](https://github.com/getsentry/sentry/blob/master/bin/update-migration) for automatically moving your migration to the top of the migration history.
60+
61+
```bash
62+
bin/update-migration <migration_name>
63+
```
64+
65+
It will rename the migration, modify it to depend on the latest migration, and update the lockfile and the name of any tests if they exist.
66+
67+
### Manually Resolving Conflicts
68+
69+
To perform the steps manually, rebase against latest master, delete your current migration and then regenerate it. If your migration was custom, just save the operations in a text file somewhere so that you can reapply them on the regenerated migration.
5870

5971
Always commit the changes to `migrations_lockfile.txt` with your migration.
6072

develop-docs/sdk/telemetry/traces/span-data-conventions.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,13 @@ Below describes the conventions for the Span interface for the `data` field on t
102102
| `thread.id` | string | Identifier of a thread from where the span originated. | `123456` |
103103
| `thread.name` | string | Label identifying a thread from where the span originated. | `main` |
104104

105+
## Flags
106+
107+
| Attribute | Type | Description | Examples |
108+
| ------------------------------------| ------- | ------------------------------------------------| ------------ |
109+
| `flag.evaluation.<flag-name>` | string | Identifier of a flag evaluated within the span. | `can_access` |
110+
111+
105112
### Deprecated
106113

107114
Names that SDKs are still sending so we cannot remove them yet, but should not be used in new code.

develop-docs/self-hosted/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ Thirty (30) day retention. No marketing. Privacy policy at sentry.io/privacy.
7373

7474
Starting with the 22.10.0 release, we will require those running the Sentry installer to choose to opt in or out. If you are running the installer under automation, you may want to set `REPORT_SELF_HOSTED_ISSUES` or pass `--(no-)report-self-hosted-issues` to the installer accordingly.
7575

76+
### Air-gapped installation
77+
78+
Sentry can run in air-gapped environments, where there are no internet access. Depending on how air-tight your environment is, the best way to do so is to do installation and upgrades behind a proxy, see [Installing Behind a Proxy](#installing-behind-a-proxy) below. If it's not possible, you may build the entire Docker Compose stack on another machine, use `docker commit` to "freeze" the images, then use combination of `docker save` and `docker load` which convert the image as a `.tar` file and transfer it into the air-gapped machine. Then, you can use `docker-compose up` to start the services. Although this may seem possible, we don't provide any further help for this use case, as it's not a common scenario.
79+
7680
### Self-hosted Beacon
7781

7882
If you opt-in to it, self-hosted Sentry will periodically communicate with a remote beacon server. This is utilized for a couple of things, primarily:

develop-docs/self-hosted/troubleshooting/docker.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ sidebar_title: Docker
44
sidebar_order: 3
55
---
66

7+
## `FAIL: Docker Compose is required to run self-hosted` error but Docker Compose is installed
8+
9+
Around version 25.1.0 to 25.4.0, users which did not have `docker compose` plugin installed, and relied only on `docker-compose` will face some issues. Notably for Amazon Linux 2023 distro that does not have `docker-compose-plugin` packaged, you may need to install the standalone `docker-compose` separately. See [docker/compose installation guide](https://github.com/docker/compose?tab=readme-ov-file#linux) for more details.
10+
711
## Container Healthcheck
812

913
There may be some circumstances which you may want to increase or decrease healthcheck interval, timeout or retries for your custom needs. This can be achieved by editing `HEALTHCHECK_INTERVAL`, `HEALTHCHECK_TIMEOUT`, `HEALTHCHECK_RETRIES` variables' values in `.env`.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Set Up Profiling
33
sidebar_order: 5000
4-
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations. Get started with browser and Node.js profiling to understand your application's performance."
4+
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations. Get started with profiling to understand your application's performance."
55
notSupported:
66
- javascript.bun
77
- javascript.cordova
@@ -10,4 +10,4 @@ notSupported:
1010
- javascript.cloudflare
1111
---
1212

13-
<PageGrid />
13+
<PlatformContent includePath="profiling/landing-page" />
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Browser Profiling
3+
description: "Get started with Browser profiling to understand your application's performance."
4+
---
5+
6+
<PlatformContent includePath="profiling/browser-profiling" />
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Set Up Profiling
3+
sidebar_order: 5000
4+
description: "Collect & view performance insights for JavaScript programs with Sentry's Profiling integrations."
5+
---
6+
7+
<PageGrid />
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Node Profiling
3+
description: "Get started with Node.js profiling to understand your application's performance."
4+
---
5+
6+
<PlatformContent includePath="profiling/node-profiling" />

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,25 @@ export default Sentry.withSentry(
105105
);
106106
```
107107

108+
If you do not have access to the `onRequest` middleware API, you can use the `wrapRequestHandler` API instead. For example:
109+
110+
```javascript
111+
// hooks.server.js
112+
import * as Sentry from '@sentry/cloudflare';
113+
114+
export const handle = ({ event, resolve }) => {
115+
const requestHandlerOptions = {
116+
options: {
117+
dsn: event.platform.env.SENTRY_DSN,
118+
tracesSampleRate: 1.0,
119+
},
120+
request: event.request,
121+
context: event.platform.ctx,
122+
};
123+
return Sentry.wrapRequestHandler(requestHandlerOptions, () => resolve(event));
124+
};
125+
```
126+
108127
## Add Readable Stack Traces to Errors
109128

110129
Depending on how you've set up your project, the stack traces in your Sentry errors probably don't look like your actual code.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Browser Profiling
3+
description: "Get started with Browser profiling to understand your application's performance."
4+
---
5+
6+
<PlatformContent includePath="profiling/browser-profiling" />

0 commit comments

Comments
 (0)