Skip to content
This repository was archived by the owner on Aug 14, 2024. It is now read-only.

Commit 596abdd

Browse files
committed
feat(event): Add source to SDK payload
1 parent 825c6c9 commit 596abdd

File tree

1 file changed

+29
-26
lines changed

1 file changed

+29
-26
lines changed

src/docs/sdk/event-payloads/sdk.mdx

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,39 +11,43 @@ and transmit an event.
1111
`name`
1212

1313
: **Required**. The name of the SDK. The format is `entity.ecosystem[.flavor]`
14-
where _entity_ identifies the developer of the SDK, _ecosystem_ refers to the
15-
programming language or platform where the SDK is to be used and the optional
16-
_flavor_ is used to identify standalone SDKs that are part of a major
17-
ecosystem.
18-
Official Sentry SDKs use the _entity_ `sentry`. Examples:
19-
- `sentry.python`
20-
- `sentry.javascript.react-native`
14+
where _entity_ identifies the developer of the SDK, _ecosystem_ refers to the
15+
programming language or platform where the SDK is to be used and the optional
16+
_flavor_ is used to identify standalone SDKs that are part of a major
17+
ecosystem. Official Sentry SDKs use the _entity_ `sentry`. Examples:
18+
19+
- `sentry.python`
20+
- `sentry.javascript.react-native`
2121

2222
`version`
2323

2424
: **Required**. The version of the SDK. It should have the [Semantic
25-
Versioning](https://semver.org) format `MAJOR.MINOR.PATCH`, without any prefix
26-
(no `v` or anything else in front of the major version number).
27-
Examples:
28-
- `0.1.0`
29-
- `1.0.0`
30-
- `4.3.12`
25+
Versioning](https://semver.org) format `MAJOR.MINOR.PATCH`, without any prefix
26+
(no `v` or anything else in front of the major version number). Examples:
27+
28+
- `0.1.0`
29+
- `1.0.0`
30+
- `4.3.12`
3131

3232
`integrations`
3333

3434
: _Optional_. A list of names identifying enabled integrations. The list should
35-
have all enabled integrations, including default integrations. Default
36-
integrations are included because different SDK releases may contain different
37-
default integrations.
35+
have all enabled integrations, including default integrations. Default
36+
integrations are included because different SDK releases may contain different
37+
default integrations.
3838

3939
`packages`
4040

4141
: _Optional_. A list of packages that were installed as part of this SDK or the
42-
activated integrations. Each package consists of a `name` in the format
43-
`source:identifier` and `version`.
44-
If the source is a Git repository, the source should be `git`, the
45-
`identifier` should be a checkout link and the `version` should be a Git
46-
reference (branch, tag or SHA).
42+
activated integrations. Each package consists of a `name` in the format
43+
`source:identifier` and `version`. If the source is a Git repository, the source should be `git`, the
44+
`identifier` should be a checkout link and the `version` should be a Git
45+
reference (branch, tag or SHA).
46+
47+
`source`
48+
49+
: _Optional_. The installation mechanism for the SDK. This can be a package
50+
manager like `npm` or `cocoapods` or a custom installation mechanism like or `CDN`.
4751

4852
## Example
4953

@@ -55,9 +59,7 @@ attributes for simplicity.
5559
"sdk": {
5660
"name": "sentry.javascript.react-native",
5761
"version": "1.0.0",
58-
"integrations": [
59-
"redux"
60-
],
62+
"integrations": ["redux"],
6163
"packages": [
6264
{
6365
"name": "npm:@sentry/react-native",
@@ -67,7 +69,8 @@ attributes for simplicity.
6769
"name": "git:https://github.com/getsentry/sentry-cocoa.git",
6870
"version": "4.1.0"
6971
}
70-
]
72+
],
73+
"source": "npm"
7174
}
7275
}
73-
```
76+
```

0 commit comments

Comments
 (0)