Skip to content

Commit dbf5d99

Browse files
committed
updated required Event attributes
specified SDK doesn't have to fill name and email with user context, as it's done by backend updated scope data to apply to feedbacks
1 parent c10743e commit dbf5d99

File tree

1 file changed

+10
-21
lines changed

1 file changed

+10
-21
lines changed

develop-docs/sdk/telemetry/feedbacks.mdx

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,40 +16,29 @@ Item type `"feedback"`. This Item contains an [event payload](/sdk/data-model/ev
1616
| Key | Type | Description |
1717
| ---------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1818
| message | string | Required. Comments of the user, describing what happened and/or sharing feedback. The max length is **4096 characters**. |
19-
| contact_email | string | The email of the user who submitted the feedback. If excluded, Sentry attempts to fill this in with user context. Anonymous feedbacks (no name or email) are still accepted. |
20-
| name | string | The name of the user who submitted the feedback. If excluded, Sentry attempts to fill this in with user context. Anonymous feedbacks (no name or email) are still accepted. |
19+
| contact_email | string | The email of the user who submitted the feedback. If excluded, Sentry (not the SDK) attempts to fill this in with user context. Anonymous feedbacks (no name or email) are still accepted. |
20+
| name | string | The name of the user who submitted the feedback. If excluded, Sentry (not the SDK) attempts to fill this in with user context. Anonymous feedbacks (no name or email) are still accepted. |
2121
| url | string | The URL of the webpage the user was on when submitting feedback. This may be used to search for or set alerts on feedback. |
2222
| associated_event_id | string | The identifier of an error event in the same project. Use this to explicitly link a related error in the feedback UI. |
2323
| replay_id | string | The identifier of a related Session Replay in the same project. Sentry uses this ID to render a Replay clip in the feedback UI. |
2424

2525
### Event Attributes
2626

27+
Below is a recap of the [required attributes](/sdk/data-model/event-payloads/#required-attributes) for the event payload.
2728
For the full list of attributes, see [Event Payloads](/sdk/data-model/event-payloads/).
2829

29-
| Key | Type | Description |
30-
| -------------------------- | ------ | ------------------------------------------------ |
31-
| timestamp | number | UNIX timestamp of the current time (in seconds). |
32-
| event_id | string | This should be the same as `replay_id` |
33-
| dist | string | - |
34-
| platform | string | - |
35-
| environment | string | - |
36-
| release | string | - |
37-
| user.id | string | - |
38-
| user.username | string | - |
39-
| user.email | string | - |
40-
| user.ip_address | string | - |
41-
| sdk.name | string | - |
42-
| sdk.version | string | - |
43-
| request.url | string | - |
44-
| request.headers.User-Agent | string | - |
30+
| Key | Type | Description |
31+
| -------------------------- | ------ | ----------------------------------------------- |
32+
| timestamp | number | UNIX timestamp of the current time (in seconds) |
33+
| event_id | string | Hexadecimal string representing a uuid4 value |
34+
| platform | string | |
4535

4636
### Example
4737
```json
4838
{
4939
"event_id": "9ec79c33ec9942ab8353589fcb2e04dc",
5040
"timestamp": "2011-05-02T17:41:36Z",
5141
"platform": "javascript",
52-
"level": "error",
5342
"contexts": {
5443
"feedback": {
5544
"contact_email": "[email protected]",
@@ -79,7 +68,6 @@ Envelope.
7968
"event_id": "9ec79c33ec9942ab8353589fcb2e04dc",
8069
"timestamp": "2011-05-02T17:41:36Z",
8170
"platform": "javascript",
82-
"level": "error",
8371
"contexts": {
8472
"organization": { "id": "0", "slug": "sentry" },
8573
"feedback": {
@@ -91,6 +79,7 @@ Envelope.
9179
"replay_id":"82840977e85b4ed3bc27f7b5b25cec15"
9280
}
9381
},
82+
"level": "error",
9483
"environment": "prod",
9584
"release": "frontend@f00",
9685
"sdk": {
@@ -125,7 +114,7 @@ SDKs should implement a `beforeSendFeedback` callback to allow users to modify t
125114

126115
### Scope Data and Event Processors
127116

128-
The scope is applied to the feedbacks, including tags, attachments, and trace context. The scope’s _event processors_ are invoked, too.
117+
The scope is applied to the feedbacks, including tags, user, trace and contexts. The scope’s _event processors_ are invoked, too.
129118

130119
### Rate Limiting
131120

0 commit comments

Comments
 (0)