Skip to content

Commit b653bab

Browse files
committed
Merge branch 'master' of github.com:getsentry/sentry-docs into smi/quick-start/sveltekit-manual
2 parents 306eaaa + a07a841 commit b653bab

File tree

62 files changed

+1179
-198
lines changed

Some content is hidden

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

62 files changed

+1179
-198
lines changed

.github/CODEOWNERS

Lines changed: 31 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,47 @@
11
# https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
22

3+
# See https://github.com/getsentry/sentry-docs/pull/13662 on how commented codeowners are tagged
4+
35
# Requiring review from security team for Content-Security-Policy changes
46
**/vercel.json @getsentry/security
57

68
# Codeowners listed below are used as a reference for the Sentry team to know who to contact for a given area of the codebase.
79

8-
# /src/platforms/android/ @getsentry/team-mobile-core
9-
# /src/wizard/android/ @getsentry/team-mobile-core
10-
# /src/platforms/apple/ @getsentry/team-mobile-core
11-
# /src/wizard/apple/ @getsentry/team-mobile-core
12-
# /src/platforms/dart/guides/flutter/ @getsentry/team-mobile-cross-platform
13-
# /src/wizard/flutter/ @getsentry/team-mobile-cross-platform
14-
# /src/platforms/dart/ @getsentry/team-mobile-cross-platform
15-
# /src/wizard/dart/ @getsentry/team-mobile-cross-platform
16-
# /src/platforms/react-native/ @getsentry/team-mobile-cross-platform
17-
# /src/wizard/react-native/ @getsentry/team-mobile-cross-platform
18-
# /src/platforms/unity/ @getsentry/team-mobile-cross-platform
19-
# /src/wizard/unity/ @getsentry/team-mobile-cross-platform
20-
# /src/wizard/cordova/ @getsentry/team-mobile-cross-platform
21-
22-
# /src/platforms/dotnet/ @getsentry/team-mobile-cross-platform
23-
# /src/wizard/dotnet/ @getsentry/team-mobile-cross-platform
24-
# /src/platforms/java/ @getsentry/team-mobile-core
25-
# /src/wizard/java/ @getsentry/team-mobile-core
26-
27-
# /src/platforms/native/ @getsentry/owners-native
28-
# /src/wizard/native/ @getsentry/owners-native
29-
# /src/wizard/minidump/ @getsentry/owners-native
30-
# /src/platforms/rust/ @getsentry/owners-native
31-
# /src/wizard/rust/ @getsentry/owners-native
32-
33-
# /src/docs/product/discover-queries/ @getsentry/visibility
34-
# /src/docs/product/insights/ @getsentry/insights
35-
36-
# /src/docs/cli/dif.mdx @getsentry/owners-native
10+
# /docs/platforms/android/ @getsentry/team-mobile-core
11+
# /docs/platforms/apple/ @getsentry/team-mobile-core
12+
# /docs/platforms/dart/ @getsentry/team-mobile-cross-platform
13+
# /docs/platforms/react-native/ @getsentry/team-mobile-cross-platform
14+
# /docs/platforms/javascript/guides/cordova/ @getsentry/team-mobile-cross-platform
15+
16+
# /docs/platforms/dotnet/ @getsentry/gdx
17+
# /docs/platforms/godot/ @getsentry/gdx
18+
# /docs/platforms/nintendo-switch/ @getsentry/gdx
19+
# /docs/platforms/playstation/ @getsentry/gdx
20+
# /docs/platforms/powershell/ @getsentry/gdx
21+
# /docs/platforms/unity/ @getsentry/gdx
22+
# /docs/platforms/unreal/ @getsentry/gdx
23+
# /docs/platforms/xbox/ @getsentry/gdx
24+
25+
# /docs/platforms/java/ @getsentry/team-web-sdk-backend
26+
# /docs/platforms/native/ @getsentry/product-owners-sdks-native
27+
# /docs/platforms/rust/ @getsentry/team-web-sdk-backend
28+
29+
# /docs/product/explore/discover-queries/ @getsentry/visibility
30+
# /docs/product/insights/ @getsentry/insights
31+
32+
# /docs/cli/ @getsentry/team-web-sdk-backend
3733

3834
# /.github/labels.yml @getsentry/dev-infra
3935
# /.github/workflows/react-to-product-owners-yml-changes.yml @getsentry/dev-infra
40-
# /bin/react-to-product-owners-yml-changes.py @getsentry/dev-infra
41-
# /bin/react-to-product-owners-yml-changes.sh @getsentry/dev-infra
4236

4337
# ###### Replays #######
4438

45-
# /src/docs/product/session-replay/web @jas-kas @getsentry/replay-sdk-web @getsentry/replay-frontend @getsentry/replay-backend
46-
# /src/docs/product/session-replay/mobile @jas-kas @getsentry/replay-sdk-mobile @getsentry/replay-frontend @getsentry/replay-backend
47-
# /src/includes/session-replay-web-report-bug.mdx @getsentry/replay-sdk-web
48-
# /src/platform-includes/session-replay/ @getsentry/replay-sdk-web @getsentry/replay-sdk-mobile
49-
# /src/platforms/javascript/common/session-replay/ @getsentry/replay-sdk-web
39+
# /docs/product/explore/session-replay/web @jas-kas @getsentry/replay-sdk-web @getsentry/replay-frontend @getsentry/replay-backend
40+
# /docs/product/explore/session-replay/mobile @jas-kas @getsentry/replay-sdk-mobile @getsentry/replay-frontend @getsentry/replay-sdk-mobile
41+
# /includes/session-replay-web-report-bug.mdx @getsentry/replay-sdk-web
42+
# /platform-includes/session-replay/ @getsentry/replay-sdk-web @getsentry/replay-sdk-mobile
43+
# /docs/platforms/javascript/common/session-replay/ @getsentry/replay-sdk-web
5044

51-
# /src/docs/product/dev-toolbar/ @ryan953 @jas-kas
45+
# /docs/product/sentry-toolbar/ @ryan953 @jas-kas
5246

5347
# ###### End Replays #######

.github/workflows/codeowner_assignment.yaml

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,13 @@ jobs:
4848
echo "Changed files:"
4949
echo "$CHANGED_FILES" | tr ' ' '\n' | sed 's/^/- /'
5050
echo "----------------------------------------"
51+
52+
# Get existing reviewers
53+
# merge reqeusted teams and users into a single array
54+
REQUESTED_REVIEWERS=$(gh pr view $PR_NUMBER --json reviewRequests --jq '[.reviewRequests[] | if .__typename == "Team" then .slug else .login end]')
55+
echo "Requested reviewers:"
56+
echo "$REQUESTED_REVIEWERS" | tr ' ' '\n' | sed 's/^/- /'
57+
echo "----------------------------------------"
5158
5259
# Parse CODEOWNERS and find commented lines
5360
# Add newline to the end of the file if it doesn't have one, otherwise sed will not read the last line
@@ -85,8 +92,12 @@ jobs:
8592
for REVIEWER in $REVIEWERS; do
8693
# Remove @ symbol from reviewer name
8794
REVIEWER_NAME=${REVIEWER#@}
88-
echo " - Assigning $REVIEWER_NAME to review changes in $FILE"
89-
gh pr edit $PR_NUMBER --add-reviewer "$REVIEWER_NAME"
95+
if [[ "$REQUESTED_REVIEWERS" == *"$REVIEWER_NAME"* ]]; then
96+
echo " - $REVIEWER_NAME is already a requested reviewer, skipping"
97+
else
98+
echo " - Assigning $REVIEWER_NAME to review changes in $FILE"
99+
gh pr edit $PR_NUMBER --add-reviewer "$REVIEWER_NAME"
100+
fi
90101
done
91102
fi
92103
else
@@ -98,8 +109,12 @@ jobs:
98109
for REVIEWER in $REVIEWERS; do
99110
# Remove @ symbol from reviewer name
100111
REVIEWER_NAME=${REVIEWER#@}
101-
echo " - Assigning $REVIEWER_NAME to review changes in $FILE"
102-
gh pr edit $PR_NUMBER --add-reviewer "$REVIEWER_NAME"
112+
if [[ "$REQUESTED_REVIEWERS" == *"$REVIEWER_NAME"* ]]; then
113+
echo " - $REVIEWER_NAME is already a requested reviewer, skipping"
114+
else
115+
echo " - Assigning $REVIEWER_NAME to review changes in $FILE"
116+
gh pr edit $PR_NUMBER --add-reviewer "$REVIEWER_NAME"
117+
fi
103118
done
104119
fi
105120
fi
@@ -111,8 +126,12 @@ jobs:
111126
for REVIEWER in $REVIEWERS; do
112127
# Remove @ symbol from reviewer name
113128
REVIEWER_NAME=${REVIEWER#@}
114-
echo " - Assigning $REVIEWER_NAME to review changes in $FILE"
115-
gh pr edit $PR_NUMBER --add-reviewer "$REVIEWER_NAME"
129+
if [[ "$REQUESTED_REVIEWERS" == *"$REVIEWER_NAME"* ]]; then
130+
echo " - $REVIEWER_NAME is already a requested reviewer, skipping"
131+
else
132+
echo " - Assigning $REVIEWER_NAME to review changes in $FILE"
133+
gh pr edit $PR_NUMBER --add-reviewer "$REVIEWER_NAME"
134+
fi
116135
done
117136
fi
118137
fi

develop-docs/sdk/data-model/event-payloads/contexts.mdx

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -436,6 +436,10 @@ GPU context describes the GPU of the device.
436436

437437
Examples: `"Apple Metal"` or `"Direct3D11"`
438438

439+
`driver_version`
440+
441+
: _Optional_. The driver version of the graphics device.
442+
439443
`multi_threaded_rendering`
440444

441445
: _Optional_. Whether the GPU has multi-threaded rendering or not.
@@ -744,6 +748,49 @@ envelope endpoint.
744748
}
745749
```
746750

751+
## Page Context
752+
753+
Page context contains information about the page that the event occurred on.
754+
755+
`url`
756+
757+
: **Required.** The URL of the page that the event occurred on, excluding query parameters & fragment.
758+
759+
- Example: `https://sentry.io/issues`
760+
761+
`http.query`
762+
763+
: **Optional.** The query parameters of the page that the event occurred on.
764+
765+
- Example: `?page=1`
766+
767+
`http.fragment`
768+
769+
: **Optional.** The fragment of the page that the event occurred on.
770+
771+
- Example: `#123`
772+
773+
`referer`
774+
775+
: _Optional_. The referer of the page that the event occurred on.
776+
777+
- Example: `https://sentry.io/`
778+
779+
**Example Page Context**
780+
781+
```json
782+
{
783+
"contexts": {
784+
"page": {
785+
"url": "https://sentry.io/issues",
786+
"http.query": "?page=1",
787+
"http.fragment": "#123",
788+
"referer": "https://sentry.io/"
789+
}
790+
}
791+
}
792+
```
793+
747794
## Response Context
748795

749796
Response context contains information about the HTTP response associated with the event.
@@ -795,7 +842,7 @@ The required field is `package` which should contain the package or framework wh
795842
"contexts": {
796843
"missing_instrumentation": {
797844
"package": "express",
798-
"javascript.is_cjs": true,
845+
"javascript.is_cjs": true
799846
}
800847
}
801848
}

develop-docs/sdk/data-model/event-payloads/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ of an Xcode build or the version code of an Android build.
199199

200200
`tags`
201201

202-
_Optional_. A map or list of tags for this event. Each tag must be less than 200 characters.
202+
_Optional_. A map or list of tags for this event. Tags must have string values, and each tag must be less than 200 characters.
203203

204204
```json
205205
{

develop-docs/sdk/data-model/event-payloads/properties/tags.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
`tags`
22

3-
: _Optional_. A map or list of tags for this event. Each tag must be less than 200 characters.
3+
: _Optional_. A map or list of tags for this event. Tags must have string values, and each tag must be less than 200 characters.
44

55
```json
66
{

develop-docs/sdk/data-model/event-payloads/request.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ sidebar_order: 8
44
---
55

66
The Request interface contains information on a HTTP request related to the
7-
event. In client SDKs, this can be an outgoing request, or the request that
8-
rendered the current web page. On server SDKs, this could be the incoming web
9-
request that is being handled.
7+
event. In client SDKs, this can be an outgoing request (use the [page context](../contexts/#page-context) to track the page that the request was made from).
8+
On server SDKs, this could be the incoming web request that is being handled.
109

1110
The data variable should only contain the request body (not the query string).
1211
It can either be a dictionary (for standard HTTP requests) or a raw request

develop-docs/sdk/data-model/event-payloads/span.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ _Optional_. Describes the `status` of the Span/Transaction.
139139

140140
`tags`
141141

142-
_Optional_. A map or list of tags for this event. Each tag must be less than 200 characters.
142+
_Optional_. A map or list of tags for this event. Tags must have string values, and each tag must be less than 200 characters.
143143

144144
```json
145145
{

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,6 @@ If Performance Monitoring is both supported by the SDK and enabled in the client
326326
- operation: `http.client`
327327
- description: `$METHOD $url` (uppercase HTTP method), e.g. `GET https://sentry.io`
328328
- HTTP requests must be enhanced with a [`sentry-trace` HTTP header](/sdk/telemetry/traces/#header-sentry-trace) to support [distributed tracing](https://docs.sentry.io/product/sentry-basics/tracing/distributed-tracing)
329-
- HTTP requests must be enhanced with a [`traceparent` HTTP header](/sdk/telemetry/traces/#header-traceparent) to support [distributed tracing](https://docs.sentry.io/product/sentry-basics/tracing/distributed-tracing)
330329
- HTTP requests must be enhanced with a [`baggage` HTTP header](/sdk/telemetry/traces/dynamic-sampling-context/#baggage-header) to support [dynamic sampling](/sdk/telemetry/traces/dynamic-sampling-context/)
331330
- span status must match HTTP response status code ([see Span status to HTTP status code mapping](/sdk/data-model/event-payloads/span/))
332331
- when network error occurs, span status must be set to `internal_error`

develop-docs/sdk/telemetry/logs.mdx

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The `log` envelope item payload is a JSON object that represents a Sentry Log.
4747
"value": "User %s has logged in!",
4848
"type": "string"
4949
},
50-
"sentry.message.parameters.0": {
50+
"sentry.message.parameter.0": {
5151
"value": "John",
5252
"type": "string"
5353
},
@@ -226,17 +226,10 @@ logger()->info('Adding item %s for user %s', [$item_id, $user_id], ['extra' => 1
226226
```java
227227
import io.sentry.Sentry;
228228

229-
// example with MessageFormat based string template
230-
Sentry.logger().info("Adding item {0,string} for user {1,string}", item_id, user_id, log -> {
231-
log.setAttribute("extra", 123);
232-
});
229+
Sentry.logger().info("Adding item %s for user %s", itemId, userId);
233230

234231
// Kotlin
235-
Sentry.Logger.info("Adding item for user") { // fun info(block: LogItem.() -> Unit)
236-
setAttribute("item_id", item_id)
237-
setAttribute("user_id", user_id)
238-
setAttribute("extra", 123)
239-
}
232+
Sentry.logger().info("Adding item %s for user %s", itemId, userId)
240233
```
241234

242235
#### Apple

develop-docs/sdk/telemetry/traces/distributed-tracing/index.mdx

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,16 @@ This document describes how an SDK should propagate information between differen
66

77
For an overview see [Distributed Tracing](https://docs.sentry.io/product/performance/distributed-tracing/) in the product docs.
88

9-
Sentry uses three containers to hold trace information [`sentry-trace`](/sdk/performance/#header-sentry-trace), [`traceparent`](/sdk/performance/#header-traceparent) and [`baggage`](/sdk/performance/dynamic-sampling-context/#baggage-header).
9+
Sentry uses two containers to hold trace information [`sentry-trace`](/sdk/performance/#header-sentry-trace) and [`baggage`](/sdk/performance/dynamic-sampling-context/#baggage-header).
1010

1111
With these containers you can propagate a trace to a down-stream service by either:
12-
- adding `sentry-trace`, `traceparent` and `baggage` HTTP headers (when making outgoing HTTP requests),
13-
- adding `sentry-trace`, `traceparent` and `baggage` as meta data (when putting tasks into a queue, details are specific to the queue you want to support), or
14-
- setting environment variables (when calling another process). In this case the env variables should be called `SENTRY_TRACE`, `SENTRY_TRACEPARENT` and `SENTRY_BAGGAGE`.
12+
- adding `sentry-trace` and `baggage` HTTP headers (when making outgoing HTTP requests),
13+
- adding `sentry-trace` and `baggage` as meta data (when putting tasks into a queue, details are specific to the queue you want to support), or
14+
- setting environment variables (when calling another process). In this case the env variables should be called `SENTRY_TRACE` and `SENTRY_BAGGAGE`.
1515

1616
The SDK running in the receiving service needs to make sure to pick up incoming trace information by
17-
- reading `sentry-trace`, `traceparent` and `baggage` headers for each incoming HTTP request,
18-
- reading `sentry-trace`, `traceparent` and `baggage` meta data when retrieving an item from a queue, or
19-
- reading the environment variables `SENTRY_TRACE`, `SENTRY_TRACEPARENT` and `SENTRY_BAGGAGE` on startup.
20-
21-
In case both `sentry-trace` and `traceparent` are present, `sentry-trace` takes precedence.
17+
- reading `sentry-trace` and `baggage` headers for each incoming HTTP request,
18+
- reading `sentry-trace` and `baggage` meta data when retrieving an item from a queue, or
19+
- reading the environment variables `SENTRY_TRACE` and `SENTRY_BAGGAGE` on startup.
2220

2321
This trace information should be stored in the "propagation context" of the current scope. This makes sure that all telemetry that is emitted from the receiving service to Sentry will include the correct trace information.

0 commit comments

Comments
 (0)