Skip to content

Commit c282b60

Browse files
committed
Merge branch 'DominikB2014/revamp-insights-docs' of github.com:getsentry/sentry-docs into DominikB2014/revamp-insights-docs
2 parents 636341f + ec3d715 commit c282b60

File tree

183 files changed

+3416
-383
lines changed

Some content is hidden

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

183 files changed

+3416
-383
lines changed

.github/CODEOWNERS

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,12 @@
4545

4646
# ###### Replays #######
4747

48-
# /src/docs/product/session-replay/ @getsentry/replay
49-
# /src/includes/session-replay-web-report-bug.mdx @getsentry/replay
50-
# /src/platform-includes/session-replay/ @getsentry/replay @getsentry/replay-sdk-web
51-
# /src/platforms/javascript/common/session-replay/ @getsentry/replay @getsentry/replay-sdk-web
52-
# /src/wizard/javascript/replay-onboarding/ @getsentry/replay @getsentry/replay-sdk-web
48+
# /src/docs/product/session-replay/web @jas-kas @getsentry/replay-sdk-web @getsentry/replay-frontend @getsentry/replay-backend
49+
# /src/docs/product/session-replay/mobile @jas-kas @getsentry/replay-sdk-mobile @getsentry/replay-frontend @getsentry/replay-backend
50+
# /src/includes/session-replay-web-report-bug.mdx @getsentry/replay-sdk-web
51+
# /src/platform-includes/session-replay/ @getsentry/replay-sdk-web @getsentry/replay-sdk-mobile
52+
# /src/platforms/javascript/common/session-replay/ @getsentry/replay-sdk-web
5353

54-
# /src/docs/product/dev-toolbar/ @getsentry/replay
54+
# /src/docs/product/dev-toolbar/ @ryan953 @jas-kas
5555

5656
# ###### End Replays #######

.github/workflows/bump-api-schema-sha.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
- uses: actions/[email protected]
1515
- name: Get auth token
1616
id: token
17-
uses: actions/create-github-app-token@67e27a7eb7db372a1c61a7f9bdab8699e9ee57f7 # v1.11.3
17+
uses: actions/create-github-app-token@0d564482f06ca65fa9e77e2510873638c82206f2 # v1.11.5
1818
with:
1919
app-id: ${{ vars.SENTRY_INTERNAL_APP_ID }}
2020
private-key: ${{ secrets.SENTRY_INTERNAL_APP_PRIVATE_KEY }}

.github/workflows/prepare-release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
steps:
1616
- name: Get auth token
1717
id: token
18-
uses: actions/create-github-app-token@67e27a7eb7db372a1c61a7f9bdab8699e9ee57f7 # v1.11.3
18+
uses: actions/create-github-app-token@0d564482f06ca65fa9e77e2510873638c82206f2 # v1.11.5
1919
with:
2020
app-id: ${{ vars.SENTRY_RELEASE_BOT_CLIENT_ID }}
2121
private-key: ${{ secrets.SENTRY_RELEASE_BOT_PRIVATE_KEY }}

develop-docs/development-infrastructure/devservices.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ commands:
2525
purge Purge the local devservices cache
2626
```
2727
28+
## Installation
29+
30+
Installation instructions can be found [here](https://github.com/getsentry/devservices?tab=readme-ov-file#installation).
31+
2832
## Viewing logs for a service
2933
3034
```shell

develop-docs/sdk/expected-features/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ The SDK automatically captures HTTP Client errors and sends them to [sentry.io](
337337

338338
The HTTP Client integration should have 3 configuration options:
339339

340-
- `captureFailedRequests` defaults to `false` due to PII reasons.
340+
- `captureFailedRequests` defaults to `false` when introducing this feature due to PII reasons and can be changed to `true` in a follow up major.
341341
- The SDK will only capture HTTP Client errors if it is enabled.
342342
- `failedRequestStatusCodes` defaults to `500 - 599`, this configuration option accepts a `List` of `HttpStatusCodeRange` which is a range of HTTP status code -> `min` to `max` or a single `status_code`.
343343
- The SDK will only capture HTTP Client errors if the HTTP Response status code is within the defined ranges in `failedRequestStatusCodes`.
@@ -538,9 +538,9 @@ Ability for the SDK to attach request body to events and triggered during the ex
538538
User should be able to set a configuration option `maxRequestBodySize` to instruct SDK how big requests bodies should be attached.
539539
SDK controls what is an actual size in bytes for each option:
540540

541-
- `none` (default)
541+
- `none`
542542
- `small` - `1000` bytes
543-
- `medium` - `10000` bytes
543+
- `medium` - `10000` bytes (default)
544544
- `always`
545545

546546
## Log context

develop-docs/sdk/processes/basics.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,17 @@ When sending events just substitute `orgXXX.ingest.sentry.io` with `localhost:30
3232
whichever port you ended up chosing. Also note that a local relay will out of the box
3333
be available via HTTP only so don't try to send HTTPS requests there.
3434

35-
## Join us on Discord
36-
37-
You can reach out to Sentry open source contributors and talk with other SDK maintainers on the [Sentry Discord server](https://discord.gg/sentry).
38-
3935
## Consult Existing SDKs
4036

4137
While we're trying to keep the docs up to date about all important things, it's usually
4238
a good idea to refer to already existing Sentry SDKs for input. In particular the
4339
transport design is not part of the documentation but generally quite similar between
4440
SDKs.
41+
42+
## Type out context in Relay
43+
44+
To have a better understanding of various [context](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/) our SDKs emit, any newly added context should also be typed out in [Relay](https://github.com/getsentry/relay/tree/master/relay-event-schema/src/protocol/contexts).
45+
46+
## Join us on Discord
47+
48+
You can reach out to Sentry open source contributors and talk with other SDK maintainers on the [Sentry Discord server](https://discord.gg/sentry).

develop-docs/self-hosted/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ sudo ./install.sh
4141

4242
## Required Minimum System Resources
4343

44-
We require at least Docker 19.03.6 and Compose 2.23.2.
44+
We require at least Docker 19.03.6 and Compose 2.32.2.
4545

4646
These are the minimum requirements:
4747
- 4 CPU Cores

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,13 @@ worker1:
5151
```
5252
5353
To see a more complete example, please see [a sample solution on our community forum](https://forum.sentry.io/t/how-to-clear-backlog-and-monitor-it/10715/14?u=byk).
54+
55+
## Cannot Load JavaScript or CSS Files From Web Interface
56+
57+
If you are running your Sentry instance behind a CDN like Cloudflare, Fastify, or the like, you may see some errors of invalid JavaScript or CSS files being loaded from the web interface. This is caused by some static asset files that are already optimized by the bundlers, but aren't being served with minified extensions (for example, `.min.js`). Therefore, the CDN that you are using will try to optimize the files a second time, which will result in corrupted files.
58+
59+
Some known paths where you may see this error:
60+
* _static/dist/sentry/entrypoints/sentry.css
61+
* _static/dist/sentry/entrypoints/app.js
62+
63+
To fix this, you can disable the auto optimization performed by your CDN.

docs/account/auth-tokens/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,12 @@ User auth token permissions are customizable but cannot be edited later.
4747

4848
![](./img/org-auth-tokens-overview.png)
4949

50+
<Alert>
51+
5052
They can also be generated on certain pages of Sentry's docs if you're signed in, and by using the Sentry Wizard to configure uploading source maps.
5153

54+
</Alert>
55+
5256
Organization auth token names are generated for you unless you create the token through the Sentry UI. This name is only used for display purposes - it helps to identify an auth token in case you want to revoke it later. You can change the name for an organization auth token at [sentry.io](https://sentry.io) on the **Edit Auth Token** page under **Settings > Developer Settings > Auth Tokens**.
5357

5458
For security reasons, organization auth tokens are only visible _once_, right after you create them. If you lose the auth token, you will have to create a new one. This means you can't see the full token on the overview page or on the token detail page, you can only see the last characters of the token to help identify it.

docs/concepts/search/searchable-properties/issues.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Learn more about searchable issue properties."
44
sidebar_order: 10
55
---
66

7-
[Issues](/product/issues/) are an aggregate of one or more error events. Searchable issues properties include status, assignment, aggregate counts, and age. You can search by issue properties in the **Issues** page and in **Dashboards** in the widget builder, depending on your dataset selection.
7+
[Issues](/product/issues/) are an aggregate of one or more error events. Searchable issues properties include status, assignment, aggregate counts, and age. If you have set up [evaluation tracking for feature flags](/product/issues/issue-details/feature-flags/#evaluation-tracking), you can search for issues that have error events where the feature flag evaluated value is `true` or `false`. You can search by issue properties in the **Issues** page and in **Dashboards** in the widget builder, depending on your dataset selection.
88

99
## Searchable Properties
1010

@@ -178,6 +178,12 @@ Returns issues with a matching first time seen. Syntax is the same as `age`.
178178

179179
- **Type:** datetime
180180

181+
### `flags`
182+
183+
For [feature flag evaluations](/product/issues/issue-details/feature-flags/#evaluation-tracking) set to `true` or `false`, the name of the feature flag.
184+
185+
- **Type:** boolean
186+
181187
### `geo.city`
182188

183189
Full name of the city

0 commit comments

Comments
 (0)