Skip to content

Commit f30005f

Browse files
committed
Fix links to client-reports and envelopes
1 parent 638732c commit f30005f

File tree

43 files changed

+65
-66
lines changed

Some content is hidden

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

43 files changed

+65
-66
lines changed

develop-docs/application/feedback-architecture.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ When broken down, there are **5** ways to create feedback in our system 😵‍
1515
`FeedbackCreationSource(Enum)` in [create_feedback.py](https://github.com/getsentry/sentry/blob/2b642e149c79b251e1c2f4339fc73d656347d74e/src/sentry/feedback/usecases/create_feedback.py#L33-L33).
1616
The 4 ways _clients_ can create feedback are:
1717

18-
`NEW_FEEDBACK_ENVELOPE`: [The new format](https://develop.sentry.dev/sdk/envelopes/#full-examples) created by the Replay team when adding
18+
`NEW_FEEDBACK_ENVELOPE`: [The new format](https://develop.sentry.dev/sdk/data-model/envelopes/#full-examples) created by the Replay team when adding
1919
the [User Feedback Widget](https://docs.sentry.io/product/user-feedback/#user-feedback-widget)
2020
to the JavaScript SDK. It allows adding more information, for example tags,
2121
release, url, etc.
2222

23-
`USER_REPORT_ENVELOPE`: [The older format](https://develop.sentry.dev/sdk/envelopes/#user-feedback) with name/email/comments, that requires
23+
`USER_REPORT_ENVELOPE`: [The older format](https://develop.sentry.dev/sdk/data-model/envelopes/#user-feedback) with name/email/comments, that requires
2424
`event_id` to link a Sentry error event.
2525

2626
`USER_REPORT_DJANGO_ENDPOINT`: [The deprecated Web API](https://docs.sentry.io/api/projects/submit-user-feedback/)
@@ -41,7 +41,7 @@ which
4141

4242
## Feedback events
4343

44-
The new and preferred way to send feedback from the SDK is in an [event envelope](https://develop.sentry.dev/sdk/envelopes/#full-examples).
44+
The new and preferred way to send feedback from the SDK is in an [event envelope](https://develop.sentry.dev/sdk/data-model/envelopes/#full-examples).
4545
The format is the same as error events, except the `type` header = `"feedback"`. While
4646
user reports have an associated event, **new feedback _is_ an event**. This
4747
offers 2 improvements:
@@ -84,7 +84,7 @@ In Relay v24.5.1, we migrated feedback to its own kafka topic + consumer,
8484
### Attachments
8585

8686
We only use attachments for the widget’s screenshot feature, which allows users
87-
to submit **at most 1 screenshot per feedback**. Attachments are another [item type](https://develop.sentry.dev/sdk/envelopes/#attachment)
87+
to submit **at most 1 screenshot per feedback**. Attachments are another [item type](https://develop.sentry.dev/sdk/data-model/envelopes/#attachment)
8888
in an envelope.
8989

9090
- SDK v8.0.0+, Relay v24.5.1+: Sends the feedback and attachment items in the same envelope.
@@ -139,7 +139,7 @@ Simplified diagram:
139139

140140
### Envelopes
141141

142-
User reports are also sent to Relay in [envelope format](https://develop.sentry.dev/sdk/envelopes/#user-feedback).
142+
User reports are also sent to Relay in [envelope format](https://develop.sentry.dev/sdk/data-model/envelopes/#user-feedback).
143143
**This item type is misleadingly called “user feedback” in some of our docs, but the
144144
item header will read `"user_report"`.**
145145

develop-docs/sdk/data-model/envelope-items.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ The item contains a user feedback / user report JSON payload:
226226

227227
Item type `"client_report"` contains a client report payload encoded in JSON.
228228

229-
See the <Link to="/sdk/client-reports/">client reports</Link> documentation for the payload
229+
See the <Link to="/sdk/telemetry/client-reports/">client reports</Link> documentation for the payload
230230
details.
231231

232232
**Constraints:**

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_order: 3
66
Events are the fundamental data that clients, often through the use of an SDK, send
77
to the Sentry server.
88

9-
Events are packed into [envelopes](/sdk/envelopes/) and are sent to the `/api/{PROJECT_ID}/envelope/` API endpoint.
9+
Events are packed into [envelopes](/sdk/data-model/envelopes/) and are sent to the `/api/{PROJECT_ID}/envelope/` API endpoint.
1010

1111
Sending event payloads to the `/api/{PROJECT_ID}/store/` API endpoint is deprecated.
1212

@@ -309,7 +309,7 @@ These limits are subject to future change and defined currently as:
309309
- *1MB* decompressed (and `200KB` compressed) for events of type `error`
310310
- *1MB* decompressed (and `200KB` compressed) for events of type `transaction`
311311

312-
Sessions, client reports, replays, check-ins, and profiles are not events and have different size limits. See [Envelope Size Limits](/sdk/envelopes/#size-limits).
312+
Sessions, client reports, replays, check-ins, and profiles are not events and have different size limits. See [Envelope Size Limits](/sdk/data-model/envelopes/#size-limits).
313313

314314
## Core Interfaces
315315

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ title: Transaction Payloads
44

55
Transactions are used to send tracing events to Sentry.
66

7-
Transactions must be wrapped in an [Envelope](/sdk/envelopes/) and therefore also be sent to the Envelope endpoint.
7+
Transactions must be wrapped in an [Envelope](/sdk/data-model/envelopes/) and therefore also be sent to the Envelope endpoint.
88

99
<Alert title="Note on backwards compatibility" level="info">
1010
Envelopes are a new format and therefore only work on Sentry >= 10. More
11-
information can be found on the <Link to="/sdk/envelopes/">Envelope</Link> page.
11+
information can be found on the <Link to="/sdk/data-model/envelopes/">Envelope</Link> page.
1212
</Alert>
1313

1414
## Anatomy

develop-docs/sdk/expected-features/data-handling.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,5 +118,5 @@ Fields in the event payload that allow user-specified or dynamic values are rest
118118

119119
Additionally, size limits apply to all store requests for the total size of the request, event payload, and attachments. Sentry rejects all requests exceeding these limits. Please refer the following resources for the exact size limits:
120120

121-
- <Link to="/sdk/envelopes/#size-limits">Envelope Endpoint Size Limits</Link>
121+
- <Link to="/sdk/data-model/envelopes/#size-limits">Envelope Endpoint Size Limits</Link>
122122
- <Link to="/sdk/store/#size-limits">Store Endpoint Size Limits</Link>

develop-docs/sdk/expected-features/rate-limiting.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Each *quota_limit* has the form `retry_after:categories:scope:reason_code:namesp
1515

1616
- `retry_after`: Number of seconds (as an integer or a floating point number) until this rate limit expires.
1717
- `categories`: Semicolon-separated list of [data categories](https://github.com/getsentry/relay/blob/master/relay-base-schema/src/data_category.rs#L91). **If empty, this limit applies to all categories**.
18-
While these categories might look similar to the [envelope item types](/sdk/envelopes/#data-model), they are not identical, and have slight differences.
18+
While these categories might look similar to the [envelope item types](/sdk/data-model/envelopes/#data-model), they are not identical, and have slight differences.
1919
- `scope`: The scope that this limit applies to. Can be ignored by SDKs.
2020
- `reason_code`: A unique identifier for the quota hinting at the rate limiting reason. Can be ignored by SDKs.
2121
- `namespaces`: Semicolon-separated list of metric namespace identifiers. This will only be present if the rate limit applies to the `metric_bucket` data category. If the namespace is not present, the backoff applies to all metrics.
@@ -83,7 +83,7 @@ Guidelines for how SDKs should determine the current rate limits:
8383
As stated earlier, SDKs can ignore the `scope` dimension. These definitions are here as a suplement to explain what the `X-Sentry-Rate-Limits` header is made of.
8484

8585
- **Category:** Classifies the type of data that is being counted. Arbitrary categories can be added as long as they can be inferred from the event or data being ingested.
86-
While these [data categories](https://github.com/getsentry/relay/blob/master/relay-base-schema/src/data_category.rs#L91) might look similar to the [envelope item types](/sdk/envelopes/#data-model), they are not identical, and have slight differences.
86+
While these [data categories](https://github.com/getsentry/relay/blob/master/relay-base-schema/src/data_category.rs#L91) might look similar to the [envelope item types](/sdk/data-model/envelopes/#data-model), they are not identical, and have slight differences.
8787
- `default`: Events with an event_type not listed explicitly below.
8888
- `error`: Error events.
8989
- `transaction`: Transaction type events.

develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -389,8 +389,8 @@ It's suggested to remove unnecessary data like thread data without samples from
389389
## Ingestion
390390

391391
After this payload is generated, serialize it as JSON, pack it into the same
392-
[Envelope](/sdk/envelopes/) as the associated transaction with the item type
393-
[`profile`](/sdk/envelopes/#profile) and send it to Relay.
392+
[Envelope](/sdk/data-model/envelopes/) as the associated transaction with the item type
393+
[`profile`](/sdk/data-model/envelopes/#profile) and send it to Relay.
394394

395395
This envelope should look like this:
396396

develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ It's suggested to remove unnecessary data like thread data without samples from
283283

284284
After this payload is generated, serialize it as JSON, pack it into an
285285

286-
[Envelope](/sdk/envelopes/) with the item type [`profile_chunk`](/sdk/envelopes/#profile-chunk) and send
286+
[Envelope](/sdk/data-model/envelopes/) with the item type [`profile_chunk`](/sdk/data-model/envelopes/#profile-chunk) and send
287287

288288
it to Relay.
289289

develop-docs/sdk/telemetry/sessions/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Looking for Sentry's **Session Replay**? Click <a class href="https://docs.sentr
99

1010
</Note>
1111

12-
For basic health tracking Sentry accepts <Link to="/sdk/envelopes/">envelopes</Link>
12+
For basic health tracking Sentry accepts <Link to="/sdk/data-model/envelopes/">envelopes</Link>
1313
containing session update events. These session update events can be used to
1414
inform Sentry about release and project associated project health.
1515

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ tree as well as the unit of reporting to Sentry.
139139
- `super.finish()` (call finish on Span)
140140
- Send it to Sentry only if `sampled == true`
141141
- Like spans, can be given an optional `endTimestamp` value that should be passed into the `span.finish()` call
142-
- A `Transaction` needs to be wrapped in an `Envelope` and sent to the [Envelope Endpoint](/sdk/envelopes/)
142+
- A `Transaction` needs to be wrapped in an `Envelope` and sent to the [Envelope Endpoint](/sdk/data-model/envelopes/)
143143
- The `Transport` should use the same internal queue for `Transactions` / `Events`
144144
- The `Transport` should implement category-based rate limiting →
145145
- The `Transport` should deal with wrapping a `Transaction` in an `Envelope` internally

0 commit comments

Comments
 (0)