From 8a62e9bca3de61276b5faa345475798e10c40a18 Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Thu, 10 Oct 2024 15:39:38 +0200 Subject: [PATCH 01/17] Moving pages around --- .../sdk/{ => data-model}/envelopes.mdx | 2 +- .../event-payloads/breadcrumbs.mdx | 2 +- .../event-payloads/contexts.mdx | 0 .../event-payloads/debugmeta.mdx | 0 .../event-payloads/exception.mdx | 0 .../{ => data-model}/event-payloads/index.mdx | 1 + .../event-payloads/lockreason.mdx | 2 +- .../event-payloads/message.mdx | 2 +- .../properties/contexts_trace.mdx | 0 .../event-payloads/properties/description.mdx | 0 .../event-payloads/properties/event_id.mdx | 2 +- .../properties/measurements.mdx | 0 .../event-payloads/properties/op.mdx | 2 +- .../properties/parent_span_id.mdx | 4 +-- .../event-payloads/properties/span_id.mdx | 4 +-- .../properties/span_start_timestamp.mdx | 2 +- .../properties/span_timestamp.mdx | 2 +- .../event-payloads/properties/spans.mdx | 0 .../event-payloads/properties/status.mdx | 0 .../event-payloads/properties/tags.mdx | 2 +- .../event-payloads/properties/trace_id.mdx | 2 +- .../properties/transaction_info.mdx | 0 .../event-payloads/properties/type.mdx | 2 +- .../event-payloads/replay-recording.mdx | 0 .../event-payloads/request.mdx | 6 ++--- .../{ => data-model}/event-payloads/sdk.mdx | 0 .../{ => data-model}/event-payloads/span.mdx | 0 .../event-payloads/stacktrace.mdx | 0 .../event-payloads/template.mdx | 2 +- .../event-payloads/threads.mdx | 2 +- .../event-payloads/transaction.mdx | 0 .../{ => data-model}/event-payloads/user.mdx | 0 develop-docs/sdk/data-model/index.mdx | 7 ++++++ .../sdk/{ => development-process}/basics.mdx | 14 +++++------ .../index.mdx | 4 +-- .../releases.mdx} | 2 +- .../triaging.mdx} | 2 +- .../{ => expected-features}/data-handling.mdx | 2 +- .../index.mdx} | 0 .../{ => expected-features}/rate-limiting.mdx | 2 +- .../setup-wizards/index.mdx | 2 +- .../setup-wizards/setup-wizard-copy-paste.png | Bin develop-docs/sdk/index.mdx | 22 +++++++---------- .../browser-tracing.mdx | 0 .../bundle-size.mdx | 0 .../debug-ids.mdx | 0 .../{javascript => javascript-sdks}/index.mdx | 3 ++- .../page-based-traces.png | Bin .../pageload-span.png | Bin .../hub_and_scope_refactoring.mdx | 1 + develop-docs/sdk/miscellaneous/index.mdx | 6 +++++ .../{ => miscellaneous}/new-scopes-api.png | Bin .../sdk/{ => miscellaneous}/store.mdx | 8 +++--- .../{ => miscellaneous}/unified-api/index.mdx | 7 +++++- .../unified-api/unified-api.excalidraw | 2 +- .../unified-api/unified-api.png | Bin develop-docs/sdk/native-sdks/index.mdx | 7 ++++++ .../sdk/{ => native-sdks}/signal-handlers.mdx | 2 +- develop-docs/sdk/philosophy.mdx | 2 +- .../aws-lambda-lifecycle.png | Bin .../aws-lambda.mdx | 0 develop-docs/sdk/serverless-sdks/index.mdx | 7 ++++++ develop-docs/sdk/serverless/index.mdx | 8 ------ .../{check-ins/index.mdx => check-ins.mdx} | 2 +- .../sdk/{ => telemetry}/client-reports.mdx | 2 +- develop-docs/sdk/telemetry/index.mdx | 1 + .../{metrics/index.mdx => metrics.mdx} | 8 ++++-- develop-docs/sdk/telemetry/profiles/index.mdx | 5 +++- .../telemetry/profiles/sample-format-v1.mdx | 3 ++- .../telemetry/profiles/sample-format-v2.mdx | 11 +++++---- develop-docs/sdk/{ => telemetry}/replays.mdx | 2 +- .../sessions/index.mdx} | 23 ++++++++++-------- .../telemetry/sessions}/sessionsAlert.png | Bin develop-docs/sdk/telemetry/traces/index.mdx | 2 +- 74 files changed, 122 insertions(+), 88 deletions(-) rename develop-docs/sdk/{ => data-model}/envelopes.mdx (99%) rename develop-docs/sdk/{ => data-model}/event-payloads/breadcrumbs.mdx (99%) rename develop-docs/sdk/{ => data-model}/event-payloads/contexts.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/debugmeta.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/exception.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/index.mdx (99%) rename develop-docs/sdk/{ => data-model}/event-payloads/lockreason.mdx (99%) rename develop-docs/sdk/{ => data-model}/event-payloads/message.mdx (99%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/contexts_trace.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/description.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/event_id.mdx (97%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/measurements.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/op.mdx (97%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/parent_span_id.mdx (88%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/span_id.mdx (87%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/span_start_timestamp.mdx (99%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/span_timestamp.mdx (98%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/spans.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/status.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/tags.mdx (97%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/trace_id.mdx (94%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/transaction_info.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/properties/type.mdx (95%) rename develop-docs/sdk/{ => data-model}/event-payloads/replay-recording.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/request.mdx (99%) rename develop-docs/sdk/{ => data-model}/event-payloads/sdk.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/span.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/stacktrace.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/template.mdx (99%) rename develop-docs/sdk/{ => data-model}/event-payloads/threads.mdx (99%) rename develop-docs/sdk/{ => data-model}/event-payloads/transaction.mdx (100%) rename develop-docs/sdk/{ => data-model}/event-payloads/user.mdx (100%) create mode 100644 develop-docs/sdk/data-model/index.mdx rename develop-docs/sdk/{ => development-process}/basics.mdx (90%) rename develop-docs/sdk/{processes => development-process}/index.mdx (76%) rename develop-docs/sdk/{processes/releases/index.mdx => development-process/releases.mdx} (99%) rename develop-docs/sdk/{processes/triaging/index.mdx => development-process/triaging.mdx} (99%) rename develop-docs/sdk/{ => expected-features}/data-handling.mdx (99%) rename develop-docs/sdk/{features.mdx => expected-features/index.mdx} (100%) rename develop-docs/sdk/{ => expected-features}/rate-limiting.mdx (99%) rename develop-docs/sdk/{ => expected-features}/setup-wizards/index.mdx (99%) rename develop-docs/sdk/{ => expected-features}/setup-wizards/setup-wizard-copy-paste.png (100%) rename develop-docs/sdk/{javascript => javascript-sdks}/browser-tracing.mdx (100%) rename develop-docs/sdk/{javascript => javascript-sdks}/bundle-size.mdx (100%) rename develop-docs/sdk/{javascript => javascript-sdks}/debug-ids.mdx (100%) rename develop-docs/sdk/{javascript => javascript-sdks}/index.mdx (92%) rename develop-docs/sdk/{javascript => javascript-sdks}/page-based-traces.png (100%) rename develop-docs/sdk/{javascript => javascript-sdks}/pageload-span.png (100%) rename develop-docs/sdk/{ => miscellaneous}/hub_and_scope_refactoring.mdx (99%) create mode 100644 develop-docs/sdk/miscellaneous/index.mdx rename develop-docs/sdk/{ => miscellaneous}/new-scopes-api.png (100%) rename develop-docs/sdk/{ => miscellaneous}/store.mdx (96%) rename develop-docs/sdk/{ => miscellaneous}/unified-api/index.mdx (98%) rename develop-docs/sdk/{ => miscellaneous}/unified-api/unified-api.excalidraw (99%) rename develop-docs/sdk/{ => miscellaneous}/unified-api/unified-api.png (100%) create mode 100644 develop-docs/sdk/native-sdks/index.mdx rename develop-docs/sdk/{ => native-sdks}/signal-handlers.mdx (94%) rename develop-docs/sdk/{serverless => serverless-sdks}/aws-lambda-lifecycle.png (100%) rename develop-docs/sdk/{serverless => serverless-sdks}/aws-lambda.mdx (100%) create mode 100644 develop-docs/sdk/serverless-sdks/index.mdx delete mode 100644 develop-docs/sdk/serverless/index.mdx rename develop-docs/sdk/telemetry/{check-ins/index.mdx => check-ins.mdx} (99%) rename develop-docs/sdk/{ => telemetry}/client-reports.mdx (99%) rename develop-docs/sdk/telemetry/{metrics/index.mdx => metrics.mdx} (97%) rename develop-docs/sdk/{ => telemetry}/replays.mdx (99%) rename develop-docs/sdk/{sessions.mdx => telemetry/sessions/index.mdx} (97%) rename develop-docs/{img => sdk/telemetry/sessions}/sessionsAlert.png (100%) diff --git a/develop-docs/sdk/envelopes.mdx b/develop-docs/sdk/data-model/envelopes.mdx similarity index 99% rename from develop-docs/sdk/envelopes.mdx rename to develop-docs/sdk/data-model/envelopes.mdx index 6f2374b91e987..bb950939a0530 100644 --- a/develop-docs/sdk/envelopes.mdx +++ b/develop-docs/sdk/data-model/envelopes.mdx @@ -1,6 +1,6 @@ --- title: Envelopes -sidebar_order: 7 +sidebar_order: 1 --- This document defines the Envelope and Item formats used by Sentry for data diff --git a/develop-docs/sdk/event-payloads/breadcrumbs.mdx b/develop-docs/sdk/data-model/event-payloads/breadcrumbs.mdx similarity index 99% rename from develop-docs/sdk/event-payloads/breadcrumbs.mdx rename to develop-docs/sdk/data-model/event-payloads/breadcrumbs.mdx index 8938cabed1ce2..77f3c6e2a4bb9 100644 --- a/develop-docs/sdk/event-payloads/breadcrumbs.mdx +++ b/develop-docs/sdk/data-model/event-payloads/breadcrumbs.mdx @@ -97,7 +97,7 @@ Contains a dictionary whose contents depend on the breadcrumb type. Additional p `timestamp` (recommended) -: A timestamp representing when the breadcrumb occurred. The format is either a string as defined in [RFC 3339](https://tools.ietf.org/html/rfc3339) or a numeric (integer or float) value representing the number of seconds that have elapsed since the [Unixepoch](https://en.wikipedia.org/wiki/Unix_time). +: A timestamp representing when the breadcrumb occurred. The format is either a string as defined in [RFC 3339](https://tools.ietf.org/html/rfc3339) or a numeric (integer or float) value representing the number of seconds that have elapsed since the [Unixepoch](https://en.wikipedia.org/wiki/Unix_time). Breadcrumbs are most useful when they include a timestamp, as it creates a timeline leading up to an event `expection/error`. diff --git a/develop-docs/sdk/event-payloads/contexts.mdx b/develop-docs/sdk/data-model/event-payloads/contexts.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/contexts.mdx rename to develop-docs/sdk/data-model/event-payloads/contexts.mdx diff --git a/develop-docs/sdk/event-payloads/debugmeta.mdx b/develop-docs/sdk/data-model/event-payloads/debugmeta.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/debugmeta.mdx rename to develop-docs/sdk/data-model/event-payloads/debugmeta.mdx diff --git a/develop-docs/sdk/event-payloads/exception.mdx b/develop-docs/sdk/data-model/event-payloads/exception.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/exception.mdx rename to develop-docs/sdk/data-model/event-payloads/exception.mdx diff --git a/develop-docs/sdk/event-payloads/index.mdx b/develop-docs/sdk/data-model/event-payloads/index.mdx similarity index 99% rename from develop-docs/sdk/event-payloads/index.mdx rename to develop-docs/sdk/data-model/event-payloads/index.mdx index c84c8bd2ad06a..cff1dfb1431db 100644 --- a/develop-docs/sdk/event-payloads/index.mdx +++ b/develop-docs/sdk/data-model/event-payloads/index.mdx @@ -1,5 +1,6 @@ --- title: Event Payloads +sidebar_order: 2 --- Events are the fundamental data that clients, often through the use of an SDK, send diff --git a/develop-docs/sdk/event-payloads/lockreason.mdx b/develop-docs/sdk/data-model/event-payloads/lockreason.mdx similarity index 99% rename from develop-docs/sdk/event-payloads/lockreason.mdx rename to develop-docs/sdk/data-model/event-payloads/lockreason.mdx index 58768cd09b7e1..30253de5c835b 100644 --- a/develop-docs/sdk/event-payloads/lockreason.mdx +++ b/develop-docs/sdk/data-model/event-payloads/lockreason.mdx @@ -8,7 +8,7 @@ to determine which other thread is holding the lock in case the current thread i -Lock reasons are always part of a [thread](/sdk/event-payloads/threads/). They cannot be declared as a top-level event property. +Lock reasons are always part of a [thread](/sdk/event-payloads/threads/). They cannot be declared as a top-level event property. diff --git a/develop-docs/sdk/event-payloads/message.mdx b/develop-docs/sdk/data-model/event-payloads/message.mdx similarity index 99% rename from develop-docs/sdk/event-payloads/message.mdx rename to develop-docs/sdk/data-model/event-payloads/message.mdx index 1bd5746fb4f0c..fe2fb90ff8db2 100644 --- a/develop-docs/sdk/event-payloads/message.mdx +++ b/develop-docs/sdk/data-model/event-payloads/message.mdx @@ -13,7 +13,7 @@ help to group similar messages into the same issue. : **Required**. The fully formatted message. If missing, Sentry will try to interpolate the message. - + It must not exceed 8192 characters. Longer messages will be truncated. Sentry also accepts a message where this is not set to support legacy SDKs. diff --git a/develop-docs/sdk/event-payloads/properties/contexts_trace.mdx b/develop-docs/sdk/data-model/event-payloads/properties/contexts_trace.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/properties/contexts_trace.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/contexts_trace.mdx diff --git a/develop-docs/sdk/event-payloads/properties/description.mdx b/develop-docs/sdk/data-model/event-payloads/properties/description.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/properties/description.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/description.mdx diff --git a/develop-docs/sdk/event-payloads/properties/event_id.mdx b/develop-docs/sdk/data-model/event-payloads/properties/event_id.mdx similarity index 97% rename from develop-docs/sdk/event-payloads/properties/event_id.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/event_id.mdx index dc3404ae344ed..d960ef41943eb 100644 --- a/develop-docs/sdk/event-payloads/properties/event_id.mdx +++ b/develop-docs/sdk/data-model/event-payloads/properties/event_id.mdx @@ -7,4 +7,4 @@ { "event_id": "fc6d8c0c43fc4630ad850ee518f1b9d0" } - ``` \ No newline at end of file + ``` diff --git a/develop-docs/sdk/event-payloads/properties/measurements.mdx b/develop-docs/sdk/data-model/event-payloads/properties/measurements.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/properties/measurements.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/measurements.mdx diff --git a/develop-docs/sdk/event-payloads/properties/op.mdx b/develop-docs/sdk/data-model/event-payloads/properties/op.mdx similarity index 97% rename from develop-docs/sdk/event-payloads/properties/op.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/op.mdx index 3fc0aca482838..c7ffa4a184aac 100644 --- a/develop-docs/sdk/event-payloads/properties/op.mdx +++ b/develop-docs/sdk/data-model/event-payloads/properties/op.mdx @@ -8,4 +8,4 @@ For more details, see Sentry's conv { "op": "db.query" } - ``` \ No newline at end of file + ``` diff --git a/develop-docs/sdk/event-payloads/properties/parent_span_id.mdx b/develop-docs/sdk/data-model/event-payloads/properties/parent_span_id.mdx similarity index 88% rename from develop-docs/sdk/event-payloads/properties/parent_span_id.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/parent_span_id.mdx index e418c32cf7b76..1d9cede550858 100644 --- a/develop-docs/sdk/event-payloads/properties/parent_span_id.mdx +++ b/develop-docs/sdk/data-model/event-payloads/properties/parent_span_id.mdx @@ -1,4 +1,4 @@ -`parent_span_id`: +`parent_span_id`: : _Optional_. If this Span should be rendered as a child of another Span, set this property to the id of the parent. @@ -6,4 +6,4 @@ { "parent_span_id": "b0e6f15b45c36b12" } - ``` \ No newline at end of file + ``` diff --git a/develop-docs/sdk/event-payloads/properties/span_id.mdx b/develop-docs/sdk/data-model/event-payloads/properties/span_id.mdx similarity index 87% rename from develop-docs/sdk/event-payloads/properties/span_id.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/span_id.mdx index 53d5d730acdf2..f5470fb789010 100644 --- a/develop-docs/sdk/event-payloads/properties/span_id.mdx +++ b/develop-docs/sdk/data-model/event-payloads/properties/span_id.mdx @@ -1,4 +1,4 @@ -`span_id`: +`span_id`: : _Required_. A random hex string with a length of 16 characters. @@ -6,4 +6,4 @@ { "span_id": "99659d76b7cdae94" } - ``` \ No newline at end of file + ``` diff --git a/develop-docs/sdk/event-payloads/properties/span_start_timestamp.mdx b/develop-docs/sdk/data-model/event-payloads/properties/span_start_timestamp.mdx similarity index 99% rename from develop-docs/sdk/event-payloads/properties/span_start_timestamp.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/span_start_timestamp.mdx index a9cbf9d310245..ba9d2f4dc45eb 100644 --- a/develop-docs/sdk/event-payloads/properties/span_start_timestamp.mdx +++ b/develop-docs/sdk/data-model/event-payloads/properties/span_start_timestamp.mdx @@ -13,7 +13,7 @@ } ``` -or: +or: ```json { diff --git a/develop-docs/sdk/event-payloads/properties/span_timestamp.mdx b/develop-docs/sdk/data-model/event-payloads/properties/span_timestamp.mdx similarity index 98% rename from develop-docs/sdk/event-payloads/properties/span_timestamp.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/span_timestamp.mdx index 88b88ae0f9437..81b3265703801 100644 --- a/develop-docs/sdk/event-payloads/properties/span_timestamp.mdx +++ b/develop-docs/sdk/data-model/event-payloads/properties/span_timestamp.mdx @@ -12,7 +12,7 @@ } ``` -or: +or: ```json { diff --git a/develop-docs/sdk/event-payloads/properties/spans.mdx b/develop-docs/sdk/data-model/event-payloads/properties/spans.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/properties/spans.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/spans.mdx diff --git a/develop-docs/sdk/event-payloads/properties/status.mdx b/develop-docs/sdk/data-model/event-payloads/properties/status.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/properties/status.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/status.mdx diff --git a/develop-docs/sdk/event-payloads/properties/tags.mdx b/develop-docs/sdk/data-model/event-payloads/properties/tags.mdx similarity index 97% rename from develop-docs/sdk/event-payloads/properties/tags.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/tags.mdx index 9241d8db103e8..2c3b2813a447e 100644 --- a/develop-docs/sdk/event-payloads/properties/tags.mdx +++ b/develop-docs/sdk/data-model/event-payloads/properties/tags.mdx @@ -9,4 +9,4 @@ "context": "production" } } - ``` \ No newline at end of file + ``` diff --git a/develop-docs/sdk/event-payloads/properties/trace_id.mdx b/develop-docs/sdk/data-model/event-payloads/properties/trace_id.mdx similarity index 94% rename from develop-docs/sdk/event-payloads/properties/trace_id.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/trace_id.mdx index 49f747da7f2ed..3e11f547a4529 100644 --- a/develop-docs/sdk/event-payloads/properties/trace_id.mdx +++ b/develop-docs/sdk/data-model/event-payloads/properties/trace_id.mdx @@ -1,4 +1,4 @@ -`trace_id`: +`trace_id`: : _Required_. Determines which `trace` the Span belongs to. The value should be 16 random bytes encoded as a hex string (32 characters long). diff --git a/develop-docs/sdk/event-payloads/properties/transaction_info.mdx b/develop-docs/sdk/data-model/event-payloads/properties/transaction_info.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/properties/transaction_info.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/transaction_info.mdx diff --git a/develop-docs/sdk/event-payloads/properties/type.mdx b/develop-docs/sdk/data-model/event-payloads/properties/type.mdx similarity index 95% rename from develop-docs/sdk/event-payloads/properties/type.mdx rename to develop-docs/sdk/data-model/event-payloads/properties/type.mdx index 42d7785b392e5..f027f4452d717 100644 --- a/develop-docs/sdk/event-payloads/properties/type.mdx +++ b/develop-docs/sdk/data-model/event-payloads/properties/type.mdx @@ -6,4 +6,4 @@ { "type": "transaction" } - ``` \ No newline at end of file + ``` diff --git a/develop-docs/sdk/event-payloads/replay-recording.mdx b/develop-docs/sdk/data-model/event-payloads/replay-recording.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/replay-recording.mdx rename to develop-docs/sdk/data-model/event-payloads/replay-recording.mdx diff --git a/develop-docs/sdk/event-payloads/request.mdx b/develop-docs/sdk/data-model/event-payloads/request.mdx similarity index 99% rename from develop-docs/sdk/event-payloads/request.mdx rename to develop-docs/sdk/data-model/event-payloads/request.mdx index 31b098c8924d3..7ebcb51c7897f 100644 --- a/develop-docs/sdk/event-payloads/request.mdx +++ b/develop-docs/sdk/data-model/event-payloads/request.mdx @@ -55,7 +55,7 @@ Example of the same headers as list of tuples: : _Optional_. The query string component of the URL. Can be given as unparsed string, dictionary, or list of tuples. - + If the query string is not declared and part of the `url` parameter, Sentry moves it to the query string. @@ -75,7 +75,7 @@ Example of the same headers as list of tuples: : _Optional_. The cookie values. Can be given unparsed as string, as dictionary, or as a list of tuples. - + `headers` : _Optional_. A dictionary of submitted headers. If a header appears multiple @@ -87,7 +87,7 @@ Example of the same headers as list of tuples: : _Optional_. A dictionary containing environment information passed from the server. This is where information such as CGI/WSGI/Rack keys go that are not HTTP headers. - + Sentry will explicitly look for `REMOTE_ADDR` to extract an IP address. ## Examples diff --git a/develop-docs/sdk/event-payloads/sdk.mdx b/develop-docs/sdk/data-model/event-payloads/sdk.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/sdk.mdx rename to develop-docs/sdk/data-model/event-payloads/sdk.mdx diff --git a/develop-docs/sdk/event-payloads/span.mdx b/develop-docs/sdk/data-model/event-payloads/span.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/span.mdx rename to develop-docs/sdk/data-model/event-payloads/span.mdx diff --git a/develop-docs/sdk/event-payloads/stacktrace.mdx b/develop-docs/sdk/data-model/event-payloads/stacktrace.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/stacktrace.mdx rename to develop-docs/sdk/data-model/event-payloads/stacktrace.mdx diff --git a/develop-docs/sdk/event-payloads/template.mdx b/develop-docs/sdk/data-model/event-payloads/template.mdx similarity index 99% rename from develop-docs/sdk/event-payloads/template.mdx rename to develop-docs/sdk/data-model/event-payloads/template.mdx index e58e18f9d40b6..4241da164ad0e 100644 --- a/develop-docs/sdk/event-payloads/template.mdx +++ b/develop-docs/sdk/data-model/event-payloads/template.mdx @@ -36,7 +36,7 @@ The attributes `filename`, `context_line`, and `lineno` are required. `post_context` -: A list of source code lines after `context_line` (in order) – usually +: A list of source code lines after `context_line` (in order) – usually `[lineno + 1:lineno + 5]`. ## Examples diff --git a/develop-docs/sdk/event-payloads/threads.mdx b/develop-docs/sdk/data-model/event-payloads/threads.mdx similarity index 99% rename from develop-docs/sdk/event-payloads/threads.mdx rename to develop-docs/sdk/data-model/event-payloads/threads.mdx index d3e0a7f63a6cc..99ef5c8bf9a4f 100644 --- a/develop-docs/sdk/event-payloads/threads.mdx +++ b/develop-docs/sdk/data-model/event-payloads/threads.mdx @@ -49,7 +49,7 @@ On mobile platforms this is oftentimes referred to as the "main thread" or "ui t `held_locks` -: _Optional_. Represents a collection of locks (monitor objects) held by a thread. A dictionary of lock object memory addresses and +: _Optional_. Represents a collection of locks (monitor objects) held by a thread. A dictionary of lock object memory addresses and their respective lock reason/details. Lock reason corresponds to the [Lock Reason Interface](/sdk/event-payloads/lockreason/). `stacktrace` diff --git a/develop-docs/sdk/event-payloads/transaction.mdx b/develop-docs/sdk/data-model/event-payloads/transaction.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/transaction.mdx rename to develop-docs/sdk/data-model/event-payloads/transaction.mdx diff --git a/develop-docs/sdk/event-payloads/user.mdx b/develop-docs/sdk/data-model/event-payloads/user.mdx similarity index 100% rename from develop-docs/sdk/event-payloads/user.mdx rename to develop-docs/sdk/data-model/event-payloads/user.mdx diff --git a/develop-docs/sdk/data-model/index.mdx b/develop-docs/sdk/data-model/index.mdx new file mode 100644 index 0000000000000..4438d3d165269 --- /dev/null +++ b/develop-docs/sdk/data-model/index.mdx @@ -0,0 +1,7 @@ +--- +title: Data Model +description: +sidebar_order: 6 +--- + + diff --git a/develop-docs/sdk/basics.mdx b/develop-docs/sdk/development-process/basics.mdx similarity index 90% rename from develop-docs/sdk/basics.mdx rename to develop-docs/sdk/development-process/basics.mdx index bdeed11d37ae2..146afc45f4c47 100644 --- a/develop-docs/sdk/basics.mdx +++ b/develop-docs/sdk/development-process/basics.mdx @@ -1,13 +1,13 @@ --- -title: Development Basics -sidebar_order: 2 +title: Basics +description: How to get started with SDK development. +sidebar_order: 1 --- So you want to develop an SDK? Before you get started here are some basics that are worth following to have a better experience. -Run a Local Relay ------------------ +## Run a Local Relay You do not need a local Sentry for SDK development but you will want to run a local [relay](https://docs.sentry.io/product/relay/). The reason for this is that Sentry's @@ -35,13 +35,11 @@ When sending events just substitute `orgXXX.ingest.sentry.io` with `localhost:30 whichever port you ended up chosing. Also note that a local relay will out of the box be available via HTTP only so don't try to send HTTPS requests there. -Join the SDK chat on Discord ---------------------- +## Join the SDK chat on Discord You can reach out to Sentry open source contributors and talk with other SDK maintainers in the [Sentry Discord server](https://discord.gg/sentry). Make sure to say hi in the `#sdk-chat`. -Consult Existing SDKs ---------------------- +## Consult Existing SDKs While we're trying to keep the docs up to date about all important things, it's usually a good idea to refer to already existing Sentry SDKs for input. In particular the diff --git a/develop-docs/sdk/processes/index.mdx b/develop-docs/sdk/development-process/index.mdx similarity index 76% rename from develop-docs/sdk/processes/index.mdx rename to develop-docs/sdk/development-process/index.mdx index d75c3d8e45367..940c33ea5d71a 100644 --- a/develop-docs/sdk/processes/index.mdx +++ b/develop-docs/sdk/development-process/index.mdx @@ -1,7 +1,7 @@ --- -title: Processes +title: Development Process description: In this section, we aim to highlight some key processes that are essential for SDK development at Sentry. -sidebar_order: 9000 +sidebar_order: 3 --- diff --git a/develop-docs/sdk/processes/releases/index.mdx b/develop-docs/sdk/development-process/releases.mdx similarity index 99% rename from develop-docs/sdk/processes/releases/index.mdx rename to develop-docs/sdk/development-process/releases.mdx index aab25c7719f12..7c395444bc7b2 100644 --- a/develop-docs/sdk/processes/releases/index.mdx +++ b/develop-docs/sdk/development-process/releases.mdx @@ -1,7 +1,7 @@ --- title: Releases description: Learn how to release a new SDK or new versions of an SDK. -sidebar_order: 90 +sidebar_order: 3 --- This guide goes over the minimal setup needed to publish something via diff --git a/develop-docs/sdk/processes/triaging/index.mdx b/develop-docs/sdk/development-process/triaging.mdx similarity index 99% rename from develop-docs/sdk/processes/triaging/index.mdx rename to develop-docs/sdk/development-process/triaging.mdx index 59fa7f99e0f0d..f0c7b1f852fca 100644 --- a/develop-docs/sdk/processes/triaging/index.mdx +++ b/develop-docs/sdk/development-process/triaging.mdx @@ -1,7 +1,7 @@ --- title: Triaging description: Learn about our principles and techniques when it comes to triaging user requests. -sidebar_order: 1 +sidebar_order: 2 --- The term *triage* originally comes from medicine and describes the process of quickly examining patients who are taken to a hospital in order to decide which ones are the most seriously ill and must be treated first. diff --git a/develop-docs/sdk/data-handling.mdx b/develop-docs/sdk/expected-features/data-handling.mdx similarity index 99% rename from develop-docs/sdk/data-handling.mdx rename to develop-docs/sdk/expected-features/data-handling.mdx index 7e3436add29d7..30977316e5536 100644 --- a/develop-docs/sdk/data-handling.mdx +++ b/develop-docs/sdk/expected-features/data-handling.mdx @@ -1,6 +1,6 @@ --- title: Data Handling -sidebar_order: 3 +sidebar_order: 1 --- Data handling is the standardized context in how we want SDKs help users filter data. diff --git a/develop-docs/sdk/features.mdx b/develop-docs/sdk/expected-features/index.mdx similarity index 100% rename from develop-docs/sdk/features.mdx rename to develop-docs/sdk/expected-features/index.mdx diff --git a/develop-docs/sdk/rate-limiting.mdx b/develop-docs/sdk/expected-features/rate-limiting.mdx similarity index 99% rename from develop-docs/sdk/rate-limiting.mdx rename to develop-docs/sdk/expected-features/rate-limiting.mdx index 79ec6a969e963..10839d44729e7 100644 --- a/develop-docs/sdk/rate-limiting.mdx +++ b/develop-docs/sdk/expected-features/rate-limiting.mdx @@ -1,6 +1,6 @@ --- title: Rate Limiting -sidebar_order: 5 +sidebar_order: 2 --- Rate limits are communicated to SDKs via status codes and response headers. For regular rate limit responses, we emit a [`429`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) status code and specify a [`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) header. diff --git a/develop-docs/sdk/setup-wizards/index.mdx b/develop-docs/sdk/expected-features/setup-wizards/index.mdx similarity index 99% rename from develop-docs/sdk/setup-wizards/index.mdx rename to develop-docs/sdk/expected-features/setup-wizards/index.mdx index 13ac39c415c5b..32f0a63785074 100644 --- a/develop-docs/sdk/setup-wizards/index.mdx +++ b/develop-docs/sdk/expected-features/setup-wizards/index.mdx @@ -1,6 +1,6 @@ --- title: Setup Wizards -sidebar_order: 21 +sidebar_order: 3 --- Some SDKs support automatic SDK setup with the Sentry Wizard to make setting up the SDK as easy as possible. diff --git a/develop-docs/sdk/setup-wizards/setup-wizard-copy-paste.png b/develop-docs/sdk/expected-features/setup-wizards/setup-wizard-copy-paste.png similarity index 100% rename from develop-docs/sdk/setup-wizards/setup-wizard-copy-paste.png rename to develop-docs/sdk/expected-features/setup-wizards/setup-wizard-copy-paste.png diff --git a/develop-docs/sdk/index.mdx b/develop-docs/sdk/index.mdx index ab2cf9f96799c..348cd7a0fc432 100644 --- a/develop-docs/sdk/index.mdx +++ b/develop-docs/sdk/index.mdx @@ -3,21 +3,17 @@ title: SDK Development sidebar_order: 70 --- -The following is a guide for implementing a new Sentry SDK based on the new Unified API.
+The following is a guide for implementing a Sentry SDK. + It covers the protocol for event submission as well as guidelines for how clients should typically look and behave. - Overview - Philosophy and Design Principles -- Development Basics -- Data Handling -- Unified API -- Hub & Scope Refactoring -- Expected Features -- Event Payloads -- Store Endpoint -- Envelopes -- Sessions -- Client Reports -- Profiles -- Setup Wizards +- Development Process +- Expected Features +- Telemetry +- Data Model +- Javascript SDKs +- Native SDKs +- Serverless SDKs diff --git a/develop-docs/sdk/javascript/browser-tracing.mdx b/develop-docs/sdk/javascript-sdks/browser-tracing.mdx similarity index 100% rename from develop-docs/sdk/javascript/browser-tracing.mdx rename to develop-docs/sdk/javascript-sdks/browser-tracing.mdx diff --git a/develop-docs/sdk/javascript/bundle-size.mdx b/develop-docs/sdk/javascript-sdks/bundle-size.mdx similarity index 100% rename from develop-docs/sdk/javascript/bundle-size.mdx rename to develop-docs/sdk/javascript-sdks/bundle-size.mdx diff --git a/develop-docs/sdk/javascript/debug-ids.mdx b/develop-docs/sdk/javascript-sdks/debug-ids.mdx similarity index 100% rename from develop-docs/sdk/javascript/debug-ids.mdx rename to develop-docs/sdk/javascript-sdks/debug-ids.mdx diff --git a/develop-docs/sdk/javascript/index.mdx b/develop-docs/sdk/javascript-sdks/index.mdx similarity index 92% rename from develop-docs/sdk/javascript/index.mdx rename to develop-docs/sdk/javascript-sdks/index.mdx index 77df6d767b1cb..8c335c61f5d33 100644 --- a/develop-docs/sdk/javascript/index.mdx +++ b/develop-docs/sdk/javascript-sdks/index.mdx @@ -1,6 +1,7 @@ --- title: JavaScript SDKs -sidebar_order: 31 +description: Information specific to developing Javascript based SDKs. +sidebar_order: 7 --- This Section contains JavaScript SDK-specific information that's useful for developing new or extending existing JS SDKs as well as for ingest and product teams to understanding how the JS SDKs works and what data it sends. diff --git a/develop-docs/sdk/javascript/page-based-traces.png b/develop-docs/sdk/javascript-sdks/page-based-traces.png similarity index 100% rename from develop-docs/sdk/javascript/page-based-traces.png rename to develop-docs/sdk/javascript-sdks/page-based-traces.png diff --git a/develop-docs/sdk/javascript/pageload-span.png b/develop-docs/sdk/javascript-sdks/pageload-span.png similarity index 100% rename from develop-docs/sdk/javascript/pageload-span.png rename to develop-docs/sdk/javascript-sdks/pageload-span.png diff --git a/develop-docs/sdk/hub_and_scope_refactoring.mdx b/develop-docs/sdk/miscellaneous/hub_and_scope_refactoring.mdx similarity index 99% rename from develop-docs/sdk/hub_and_scope_refactoring.mdx rename to develop-docs/sdk/miscellaneous/hub_and_scope_refactoring.mdx index 1ed34ee7c9df2..18866d0bdb6d3 100644 --- a/develop-docs/sdk/hub_and_scope_refactoring.mdx +++ b/develop-docs/sdk/miscellaneous/hub_and_scope_refactoring.mdx @@ -1,5 +1,6 @@ --- title: Hub & Scope Refactoring +sidebar_order: 3 --- diff --git a/develop-docs/sdk/miscellaneous/index.mdx b/develop-docs/sdk/miscellaneous/index.mdx new file mode 100644 index 0000000000000..ab3e7d57d45c7 --- /dev/null +++ b/develop-docs/sdk/miscellaneous/index.mdx @@ -0,0 +1,6 @@ +--- +title: Miscellaneous +sidebar_order: 10 +--- + + diff --git a/develop-docs/sdk/new-scopes-api.png b/develop-docs/sdk/miscellaneous/new-scopes-api.png similarity index 100% rename from develop-docs/sdk/new-scopes-api.png rename to develop-docs/sdk/miscellaneous/new-scopes-api.png diff --git a/develop-docs/sdk/store.mdx b/develop-docs/sdk/miscellaneous/store.mdx similarity index 96% rename from develop-docs/sdk/store.mdx rename to develop-docs/sdk/miscellaneous/store.mdx index b01e7f8479406..a428beed165c6 100644 --- a/develop-docs/sdk/store.mdx +++ b/develop-docs/sdk/miscellaneous/store.mdx @@ -1,11 +1,11 @@ --- -title: Store Endpoint -sidebar_order: 50 +title: Store Endpoint (deprecated) +sidebar_order: 2 --- - + -The `/store` endpoint is deprecated. All data should be sent to the `/envelope` endpoint. See [Envelopes](/sdk/envelopes/). +The `/store` endpoint is deprecated. All data should be sent to the `/envelope` endpoint. See [Envelopes](/sdk/data-model/envelopes/). diff --git a/develop-docs/sdk/unified-api/index.mdx b/develop-docs/sdk/miscellaneous/unified-api/index.mdx similarity index 98% rename from develop-docs/sdk/unified-api/index.mdx rename to develop-docs/sdk/miscellaneous/unified-api/index.mdx index 55c859781ecb5..79cd86a42b37c 100644 --- a/develop-docs/sdk/unified-api/index.mdx +++ b/develop-docs/sdk/miscellaneous/unified-api/index.mdx @@ -1,7 +1,12 @@ --- -title: Unified API +title: Unified API (deprecated) +sidebar_order: 1 --- + +The unified API is deprecated. It served us well over the years, but we are in the process of simplifying the API by removing the Hub and also move some of our instrumentation to OpenTelementry. + + Everything written here sounds real nice. However, we live in a practical world, and expect each platform to adhere to what makese sense for the developers there. What is written below is not to be taken as strict rules. It is a guide and to be thought of as a tool to help developers build SDKs which work well which eachother. diff --git a/develop-docs/sdk/unified-api/unified-api.excalidraw b/develop-docs/sdk/miscellaneous/unified-api/unified-api.excalidraw similarity index 99% rename from develop-docs/sdk/unified-api/unified-api.excalidraw rename to develop-docs/sdk/miscellaneous/unified-api/unified-api.excalidraw index 0526c95d73e7e..e3eb280f8187e 100644 --- a/develop-docs/sdk/unified-api/unified-api.excalidraw +++ b/develop-docs/sdk/miscellaneous/unified-api/unified-api.excalidraw @@ -793,4 +793,4 @@ "appState": { "viewBackgroundColor": "#ffffff" } -} \ No newline at end of file +} diff --git a/develop-docs/sdk/unified-api/unified-api.png b/develop-docs/sdk/miscellaneous/unified-api/unified-api.png similarity index 100% rename from develop-docs/sdk/unified-api/unified-api.png rename to develop-docs/sdk/miscellaneous/unified-api/unified-api.png diff --git a/develop-docs/sdk/native-sdks/index.mdx b/develop-docs/sdk/native-sdks/index.mdx new file mode 100644 index 0000000000000..f67d6e4398cd6 --- /dev/null +++ b/develop-docs/sdk/native-sdks/index.mdx @@ -0,0 +1,7 @@ +--- +title: Native SDKs +description: Information specific to developing native SDKs. +sidebar_order: 8 +--- + + diff --git a/develop-docs/sdk/signal-handlers.mdx b/develop-docs/sdk/native-sdks/signal-handlers.mdx similarity index 94% rename from develop-docs/sdk/signal-handlers.mdx rename to develop-docs/sdk/native-sdks/signal-handlers.mdx index 88863169ca99d..663a5e77a4099 100644 --- a/develop-docs/sdk/signal-handlers.mdx +++ b/develop-docs/sdk/native-sdks/signal-handlers.mdx @@ -3,7 +3,7 @@ title: Signal Handlers sidebar_order: 40 --- -Native Sentry SDKs like sentry-native and sentry-cocoa have to work with signal handlers +Native Sentry SDKs like [sentry-native](https://github.com/getsentry/sentry-native) and [sentry-cocoa](https://github.com/getsentry/sentry-cocoa/) have to work with signal handlers to trap processes before they crash. This applies to mobile SDKs as well as the native SDK. As signal handlers are notoriously difficult to work with and the restrictions placed on us are diff --git a/develop-docs/sdk/philosophy.mdx b/develop-docs/sdk/philosophy.mdx index 7b04fd52f1846..cbe45fd84ef53 100644 --- a/develop-docs/sdk/philosophy.mdx +++ b/develop-docs/sdk/philosophy.mdx @@ -1,6 +1,6 @@ --- title: Philosophy -sidebar_order: 0 +sidebar_order: 2 --- This document sets some general guidance for how to approach SDK development at Sentry. It should aid both internal and external developers to understand what motivations go into the design of the SDKs and why we're deciding in certain ways. diff --git a/develop-docs/sdk/serverless/aws-lambda-lifecycle.png b/develop-docs/sdk/serverless-sdks/aws-lambda-lifecycle.png similarity index 100% rename from develop-docs/sdk/serverless/aws-lambda-lifecycle.png rename to develop-docs/sdk/serverless-sdks/aws-lambda-lifecycle.png diff --git a/develop-docs/sdk/serverless/aws-lambda.mdx b/develop-docs/sdk/serverless-sdks/aws-lambda.mdx similarity index 100% rename from develop-docs/sdk/serverless/aws-lambda.mdx rename to develop-docs/sdk/serverless-sdks/aws-lambda.mdx diff --git a/develop-docs/sdk/serverless-sdks/index.mdx b/develop-docs/sdk/serverless-sdks/index.mdx new file mode 100644 index 0000000000000..b42f51dbfa107 --- /dev/null +++ b/develop-docs/sdk/serverless-sdks/index.mdx @@ -0,0 +1,7 @@ +--- +title: Serverless SDKs +description: Information specific to developing serverless SDKs. +sidebar_order: 9 +--- + +- [AWS Lambda](/sdk/serverless/aws-lambda/) diff --git a/develop-docs/sdk/serverless/index.mdx b/develop-docs/sdk/serverless/index.mdx deleted file mode 100644 index 6867661a1cc18..0000000000000 --- a/develop-docs/sdk/serverless/index.mdx +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Serverless SDKs -sidebar_order: 30 ---- - -Welcome to serverless land! - -- [AWS Lambda](/sdk/serverless/aws-lambda/) diff --git a/develop-docs/sdk/telemetry/check-ins/index.mdx b/develop-docs/sdk/telemetry/check-ins.mdx similarity index 99% rename from develop-docs/sdk/telemetry/check-ins/index.mdx rename to develop-docs/sdk/telemetry/check-ins.mdx index 05ed5fe6e917f..94b2405ee5e92 100644 --- a/develop-docs/sdk/telemetry/check-ins/index.mdx +++ b/develop-docs/sdk/telemetry/check-ins.mdx @@ -1,6 +1,6 @@ --- title: Check-Ins -sidebar_order: 50 +sidebar_order: 1 --- ## Cron Monitor Check-In Payload diff --git a/develop-docs/sdk/client-reports.mdx b/develop-docs/sdk/telemetry/client-reports.mdx similarity index 99% rename from develop-docs/sdk/client-reports.mdx rename to develop-docs/sdk/telemetry/client-reports.mdx index df4e4f504cf3b..bde68a6ff009d 100644 --- a/develop-docs/sdk/client-reports.mdx +++ b/develop-docs/sdk/telemetry/client-reports.mdx @@ -1,6 +1,6 @@ --- title: Client Reports -sidebar_order: 20 +sidebar_order: 2 --- ## Scope and Intent diff --git a/develop-docs/sdk/telemetry/index.mdx b/develop-docs/sdk/telemetry/index.mdx index d43e6be739a79..da72bbf150444 100644 --- a/develop-docs/sdk/telemetry/index.mdx +++ b/develop-docs/sdk/telemetry/index.mdx @@ -1,6 +1,7 @@ --- title: Telemetry description: Learn about the different telemetry data, that our SDKs can collect. +sidebar_order: 5 --- diff --git a/develop-docs/sdk/telemetry/metrics/index.mdx b/develop-docs/sdk/telemetry/metrics.mdx similarity index 97% rename from develop-docs/sdk/telemetry/metrics/index.mdx rename to develop-docs/sdk/telemetry/metrics.mdx index 9fe9d1500fd03..5435265ebc2a4 100644 --- a/develop-docs/sdk/telemetry/metrics/index.mdx +++ b/develop-docs/sdk/telemetry/metrics.mdx @@ -1,8 +1,12 @@ --- -title: Metrics -sidebar_order: 90 +title: Metrics (deprecated) +sidebar_order: 3 --- + +The metrics solution based on this documentation has been retired. We're actively developing a new solution that will make tracking and debugging any issues in your application easier. [Learn more.](https://sentry.zendesk.com/hc/en-us/articles/26369339769883-Metrics-Beta-Ended-on-October-7th) + + Sentry supports the emission of pre-aggregated metrics information via the `statsd` envelope item. This emission bypasses relay-side sampling and assumes a client side aggregator. In the product these are referred to as "custom metrics" and internally diff --git a/develop-docs/sdk/telemetry/profiles/index.mdx b/develop-docs/sdk/telemetry/profiles/index.mdx index 0e2c1a053fc33..f8b11b34f74c8 100644 --- a/develop-docs/sdk/telemetry/profiles/index.mdx +++ b/develop-docs/sdk/telemetry/profiles/index.mdx @@ -1,6 +1,6 @@ --- title: Profiles -sidebar_order: 40 +sidebar_order: 4 --- This document defines the Sample format used by Sentry to ingest profiles. This @@ -9,3 +9,6 @@ ingestion pipeline. This format is meant to be cross platform and allow to represent samples collected by a profiler. + + + diff --git a/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx b/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx index 30c4bd928abaf..1fde8b7c88298 100644 --- a/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx +++ b/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx @@ -1,6 +1,7 @@ --- title: Sample Format V1 -sidebar_order: 40 +description: Transaction based profiling. +sidebar_order: 1 --- For the *Sample Format V1*, a profile should always be associated with a transaction and it should be sent diff --git a/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx b/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx index ca9c1c7c92b8a..362cee4426b01 100644 --- a/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx +++ b/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx @@ -1,6 +1,7 @@ --- title: Sample Format V2 -sidebar_order: 40 +description: Continuous profiling. +sidebar_order: 2 --- The *Sample Format V2* is designed for use in continuous profiling. Therefore, a profile can exist independently and be sent in the envelope on its own. @@ -282,7 +283,7 @@ It's suggested to remove unnecessary data like thread data without samples from After this payload is generated, serialize it as JSON, pack it into an -[Envelope](/sdk/envelopes/) with the item type [`profile_chunk`](/sdk/envelopes/#profile-chunk) and send +[Envelope](/sdk/envelopes/) with the item type [`profile_chunk`](/sdk/envelopes/#profile-chunk) and send it to Relay. @@ -300,13 +301,13 @@ Additional context needs to be attached to the *transactions/spans* payloads for 1. Profile Context: -The profile context for a transaction needs to be updated to contain the profiler id so it can be associated back to the transaction. +The profile context for a transaction needs to be updated to contain the profiler id so it can be associated back to the transaction. The context at `.contexts.profile` should look like: ```json { "profiler_id": "42928c7ee9174231956f077581145489" -} +} ``` 2. Trace Context @@ -322,7 +323,7 @@ The context at `.contexts.trace` should look like: "thread.name": "thread name", }, // existing trace context -} +} ``` `thread.id` diff --git a/develop-docs/sdk/replays.mdx b/develop-docs/sdk/telemetry/replays.mdx similarity index 99% rename from develop-docs/sdk/replays.mdx rename to develop-docs/sdk/telemetry/replays.mdx index 13c5ddcaf6e7d..23616f28d4bab 100644 --- a/develop-docs/sdk/replays.mdx +++ b/develop-docs/sdk/telemetry/replays.mdx @@ -1,6 +1,6 @@ --- title: Replays -sidebar_order: 20 +sidebar_order: 5 --- This document defines the format used by Sentry to ingest replays. This diff --git a/develop-docs/sdk/sessions.mdx b/develop-docs/sdk/telemetry/sessions/index.mdx similarity index 97% rename from develop-docs/sdk/sessions.mdx rename to develop-docs/sdk/telemetry/sessions/index.mdx index 82858248b9724..e78da6707bd6a 100644 --- a/develop-docs/sdk/sessions.mdx +++ b/develop-docs/sdk/telemetry/sessions/index.mdx @@ -1,6 +1,6 @@ --- title: Sessions -sidebar_order: 12 +sidebar_order: 6 --- @@ -297,7 +297,7 @@ SDKs are encouraged to distinguish between different ways of ending a session: A session is supposed to transition to `crashed` when it encountered an unhandled error such as a full application crash. For applications that cannot fully crash such as a website, it's acceptable to transition to the crashed state if -the user encountered an error dialog. For server environments where we create sessions +the user encountered an error dialog. For server environments where we create sessions for every incoming request, `crashed` is basically like status code `500` internal server error. So if there is an unhandled error happening during the request, the session should be `crashed`. @@ -328,7 +328,7 @@ Create a new [issue alert](https://docs.sentry.io/product/alerts/alert-types/#is "An issue affects more than \{X} percent of sessions". See more issue alert options in the [Issue Alert Configuration](https://docs.sentry.io/product/alerts/create-alerts/issue-alert-config/) docs. -![Session issue alert](../img/sessionsAlert.png) +![Session issue alert](sessionsAlert.png) ## SDK Considerations @@ -453,21 +453,23 @@ The most basic API exposed is on the hub level and lets you start and stop sessi > This enables / disables automatic session tracking through integrations. - ## SDK Implementation Guideline - Before jumping into implementing this feature in an SDK, please reach out to the team. https://github.com/getsentry/develop/pull/323 + Before jumping into implementing this feature in an SDK, please reach out to + the team. https://github.com/getsentry/develop/pull/323 We track the health of each release of projects in Sentry by sending session payloads from SDKs. The session payload provide data such as session duration and the presence or absence of errors/crashes. SDKs track sessions in one of two modes: + - Single Session - Session Aggregates Single session is the general case, and is a good fit for (relatively short-lived) applications that are typically involving only a single user. Examples: + - command-line utility like [`craft`](https://github.com/getsentry/craft); every execution of a `craft` subcommand report a single session to Sentry - user interacting with a mobile app - user loading a web site with their favorite browser @@ -483,7 +485,7 @@ If an SDK can detect that an application is better served by session aggregates, #### Configuration - On by default for global/static API; -User should be able to disable sessions if they don't want to track them. + User should be able to disable sessions if they don't want to track them. Pre-requisites for reporting sessions and determining Release Health of projects in Sentry, such as release should be automatically detected by the SDK such as by looking up env vars. @@ -515,7 +517,7 @@ Sessions should be enabled by default, a session is started as soon as a request #### Lifetime of a Session Sessions are never tracked nor sent individually, instead they are aggregated and the aggregates are sent every 30s and a final time when the web server is terminating. -As an implementation hint to the point above, when a "Client" is closed or flushed the associated "Session Flusher" shall also be flushed and submit the current aggregates the the transport, before the transport is flushed/closed. +As an implementation hint to the point above, when a "Client" is closed or flushed the associated "Session Flusher" shall also be flushed and submit the current aggregates the the transport, before the transport is flushed/closed. Make sure this works reasonably for Serverless — there we shall not use "request mode" and SessionFlusher because we cannot have any work that happens outside of the request-response flow. Provide an easy way to integrate with existing Node frameworks (Express, Next.js, Koa). @@ -526,10 +528,11 @@ Our filtering mechanisms (sample rate, rate limiting, beforeSend, event processo #### Filter order The python SDK shall serve as a reference here. The order for filtering error events is: + 1. Check for ignored exception types (a.k.a `ignore_errors`) -3. Apply scoped `event_processor` (a.k.a `error_processor`) -4. Apply global `event_processor` -2. Apply `before_send` +2. Apply scoped `event_processor` (a.k.a `error_processor`) +3. Apply global `event_processor` +4. Apply `before_send` 5. Update the session if an event made it this far 6. Apply sampling rate diff --git a/develop-docs/img/sessionsAlert.png b/develop-docs/sdk/telemetry/sessions/sessionsAlert.png similarity index 100% rename from develop-docs/img/sessionsAlert.png rename to develop-docs/sdk/telemetry/sessions/sessionsAlert.png diff --git a/develop-docs/sdk/telemetry/traces/index.mdx b/develop-docs/sdk/telemetry/traces/index.mdx index 1c7168dff1889..fc8edde789153 100644 --- a/develop-docs/sdk/telemetry/traces/index.mdx +++ b/develop-docs/sdk/telemetry/traces/index.mdx @@ -1,6 +1,6 @@ --- title: Traces -sidebar_order: 20 +sidebar_order: 7 --- This document covers how SDKs should add support for Performance Monitoring with [Distributed From 1e9909bbc0beb00315f966a359799b8fd44c872f Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Thu, 10 Oct 2024 16:03:21 +0200 Subject: [PATCH 02/17] Move envelope items into separate page --- .../sdk/data-model/envelope-items.mdx | 349 ++++++++++++++++++ develop-docs/sdk/data-model/envelopes.mdx | 347 ----------------- .../sdk/data-model/event-payloads/index.mdx | 2 +- 3 files changed, 350 insertions(+), 348 deletions(-) create mode 100644 develop-docs/sdk/data-model/envelope-items.mdx diff --git a/develop-docs/sdk/data-model/envelope-items.mdx b/develop-docs/sdk/data-model/envelope-items.mdx new file mode 100644 index 0000000000000..b9a9ea2495779 --- /dev/null +++ b/develop-docs/sdk/data-model/envelope-items.mdx @@ -0,0 +1,349 @@ +--- +title: Envelope Items +sidebar_order: 2 +--- + +Each Envelope consists of headers and a potentially empty list of Items, each +with their own headers. Which Headers are required depends on the Items in an +Envelope. This section describes all Item types and their respective required +headers. It is worth noting that the list of Item types doesn't match the data +categories used for [rate limiting](/sdk/rate-limiting/#definitions) and +client reports. + +The type of an Item is declared in the `type` header, as well as the payload +size in `length`. See Serialization Format for a list of common Item headers. +The headers described in this section are **in addition to the common headers**. + +### Event + +Item type `"event"`. This Item contains an error or default event payload +encoded in JSON. + +**Constraints:** + +- This Item may occur at most once per Envelope. +- This Item is mutually exclusive with `"transaction"` Items. + +**Envelope Headers:** + +`event_id` + +: **UUID String, required.** Corresponds to the `event_id` field of the event + payload. Clients are required to generate an event identifier ahead of time + and set it at least in the Envelope headers. If the identifier mismatches + between the Envelope and payload, the Envelope header takes precedence. + +**Additional Item Headers:** + +*None* + +### Transaction + +Item type `"transaction"`. This Item contains a transaction payload encoded +in JSON. + +**Constraints:** + +- This Item may occur at most once per Envelope. +- This Item is mutually exclusive with `"event"` Items. + +**Envelope Headers:** + +`event_id` + +: **UUID String, required.** Corresponds to the `event_id` field of the + transaction payload. Clients are required to generate an event identifier + ahead of time and set it at least in the Envelope headers. If the identifier + mismatches between the Envelope and payload, the Envelope header takes + precedence. + +**Additional Item Headers:** + +*None* + +### Attachment + +Item type `"attachment"`. This Item contains a raw payload of an attachment +file. It is always associated to an event or transaction. + +**Constraints:** + +- This Item may occur multiple times per Envelope. +- For **minidump** and **apple crash report** attachments, the corresponding + `"event"` Item must be sent within the same Envelope. +- Generic attachments can be ingested separately from their events. We recommend + sending them in the same Envelope, which allows for more efficient rate + limiting and filtering. +- Generic attachments sent in separate Envelopes can be dropped independently of + an event. To ensure consistent handling, consider sending them in the same + request. +- The Sentry server supports special attachments to ingest event payloads for + backwards compatibility. These are not part of the official public API and the + behavior should not be relied upon. + +**Envelope Headers:** + +`event_id` + +: **UUID String, required.** The identifier of the event or transaction. + +**Additional Item Headers:** + +`filename` + +: **String, required.** The name of the uploaded file without a path component. + +`attachment_type` + +: *String, optional.* The special type of this attachment. Possible values are: + + - **`event.attachment` (default)**: A standard attachment without special + meaning. + - `event.minidump`: A minidump file that creates an error event and is + symbolicated. The file should start with the `MDMP` magic bytes. + - `event.applecrashreport`: An Apple crash report file that creates an error + event and is symbolicated. + - `unreal.context`: An XML file containing UE4 crash meta data. During event + ingestion, event contexts and extra fields are extracted from this file. + - `unreal.logs`: A plain-text log file obtained from UE4 crashes. During + event ingestion, the last logs are extracted into event breadcrumbs. + - `event.view_hierarchy`: An JSON file with a predefined structure, see [RFC #33](https://github.com/getsentry/rfcs/blob/main/text/0033-view-hierarchy.md). + +`content_type` + +: *String, optional.* The content type of the attachment payload. Any [MIME type](https://www.iana.org/assignments/media-types/media-types.xhtml) may be used; the default is `application/octet-stream`. + +### Session + +Item type `"session"` contains a single session initialization or update to an +existing session for Release Health. + +See the sessions documentation for the payload +details. + +**Constraints:** + +- This Item may occur multiple times per Envelope. +- Ingestion may limit the maximum number of Items per Envelope, see *Ingestion*. + +**Additional Item Headers:** + +*None* + +### Sessions + +Item type `"sessions"` contains buckets of pre-aggregated session counts. + +See the sessions documentation for the payload +details. + +**Constraints:** + +- This Item may occur multiple times per Envelope. +- Ingestion may limit the maximum number of Items per Envelope, see *Ingestion*. + +**Additional Item Headers:** + +*None* + +### Statsd + +Item type `"statsd"` contains metrics emissions in a superset of the statsd format. + +See the metrics documentation for the payload +details. + +**Constraints:** + +- This Item may occur multiple times per Envelope. +- Ingestion may limit the maximum number of Items per Envelope, see *Ingestion*. + +**Additional Item Headers:** + +*None* + +### Metric Meta + +Item type `"metric_meta"` contains per-metric meta data which is persisted alongside +metrics in the system. + +See the metrics documentation for the payload +details. + +**Constraints:** + +- This Item may occur multiple times per Envelope. +- Ingestion may limit the maximum number of Items per Envelope, see *Ingestion*. + +**Additional Item Headers:** + +*None* + +### User Feedback + +User Feedback was called User Report in the beginning. Therefore the envelope item type is `"user_report"`. +The item contains a user feedback / user report JSON payload: +```json +{"event_id":"9ec79c33ec9942ab8353589fcb2e04dc","email":"john@me.com","name":"John Me","comments":"It broke."}\n +``` + +**Attributes** + +`event_id` + +: **UUID String, required.** The identifier of the event or transaction. + + +`email` + +: *String, recommended.* The email of the user. + +`name` + +: *String, recommended.* The name of the user. + +`comments` + +: *String, recommended.* Comments of the user about what happened. + +**Constraints:** + +- This Item may occur once per Envelope. +- User Feedbacks / Reports can be ingested separately from their events. We recommended to + send them in the same Envelope. + +**Envelope Headers:** + +`event_id` + +: **UUID String, required.** The identifier of the event or transaction. + +**Additional Item Headers:** + +*None* + +### Client Report + +Item type `"client_report"` contains a client report payload encoded in JSON. + +See the client reports documentation for the payload +details. + +**Constraints:** + +- This Item may occur multiple times per Envelope, but please avoid sending more client reports than necessary. +- This Item can either be included in an Envelope with other Items, or it may be sent by itself. + +**Envelope Headers:** + +*None* + +**Additional Item Headers:** + +*None* + +### Replay Event + +Item type `"replay_event"` contains a replay payload encoded in JSON. + +See the replays documentation for the payload +details. + +**Constraints:** + +- This Item may occur at most once per Envelope. +- This Item must be sent with a Replay Recording Item. + +**Envelope Headers:** + +*None* + +**Additional Item Headers:** + +*None* + +### Replay Recording + +Item type `"replay_recording"` contains a replay recording payload encoded in JSON *or* a gzipped JSON. + +See the replays documentation for the payload +details. + +**Constraints:** + +- This Item may occur at most once per Envelope. +- This Item must be sent with a Replay Recording Item. + +**Envelope Headers:** + +*None* + +**Additional Item Headers:** + +`length` + +: **integer, required.** The size of the Replay recording payload + +### Profile + +Item type `"profile"`. This Item contains a profile payload encoded +in JSON. + +**Constraints:** + +- This Item may occur at most once per Envelope. +- This Item needs to be in the same Envelope as the associated transaction. + +**Envelope Headers:** + +*None* + +**Additional Item Headers:** + +*None* + +### Profile Chunk + +Item type `"profile_chunk"`. This Item contains a profile_chunk (profile sample format V2) payload encoded +in JSON. + +**Constraints:** + +*None* + +**Envelope Headers:** + +*None* + +**Additional Item Headers:** + +*None* + +### Check-Ins + +Item type `"check_in"` contains a check-in payload encoded as JSON. + +See the Check-Ins documentation for the payload +details. + +**Constraints:** + +- This Item may occur at most once per Envelope. +- This Item can either be included in an Envelope with other Items, or it may be sent by itself. + +**Envelope Headers:** + +*None* + +**Additional Item Headers:** + +*None* + +### Reserved Types + +Reserved types may not be written by any implementation. They are reserved for +future or internal use. This is the exhaustive list of reserved Item types: + +- `security` +- `unreal_report` +- `form_data` diff --git a/develop-docs/sdk/data-model/envelopes.mdx b/develop-docs/sdk/data-model/envelopes.mdx index bb950939a0530..f5bb88938d3d1 100644 --- a/develop-docs/sdk/data-model/envelopes.mdx +++ b/develop-docs/sdk/data-model/envelopes.mdx @@ -296,353 +296,6 @@ EOF:** {"started": "2020-02-07T14:16:00Z","attrs":{"release":"sentry-test@1.0.0"}} ``` -## Data Model - -Each Envelope consists of headers and a potentially empty list of Items, each -with their own headers. Which Headers are required depends on the Items in an -Envelope. This section describes all Item types and their respective required -headers. It is worth noting that the list of Item types doesn't match the data -categories used for [rate limiting](/sdk/rate-limiting/#definitions) and -client reports. - -The type of an Item is declared in the `type` header, as well as the payload -size in `length`. See Serialization Format for a list of common Item headers. -The headers described in this section are **in addition to the common headers**. - -### Event - -Item type `"event"`. This Item contains an error or default event payload -encoded in JSON. - -**Constraints:** - -- This Item may occur at most once per Envelope. -- This Item is mutually exclusive with `"transaction"` Items. - -**Envelope Headers:** - -`event_id` - -: **UUID String, required.** Corresponds to the `event_id` field of the event - payload. Clients are required to generate an event identifier ahead of time - and set it at least in the Envelope headers. If the identifier mismatches - between the Envelope and payload, the Envelope header takes precedence. - -**Additional Item Headers:** - -*None* - -### Transaction - -Item type `"transaction"`. This Item contains a transaction payload encoded -in JSON. - -**Constraints:** - -- This Item may occur at most once per Envelope. -- This Item is mutually exclusive with `"event"` Items. - -**Envelope Headers:** - -`event_id` - -: **UUID String, required.** Corresponds to the `event_id` field of the - transaction payload. Clients are required to generate an event identifier - ahead of time and set it at least in the Envelope headers. If the identifier - mismatches between the Envelope and payload, the Envelope header takes - precedence. - -**Additional Item Headers:** - -*None* - -### Attachment - -Item type `"attachment"`. This Item contains a raw payload of an attachment -file. It is always associated to an event or transaction. - -**Constraints:** - -- This Item may occur multiple times per Envelope. -- For **minidump** and **apple crash report** attachments, the corresponding - `"event"` Item must be sent within the same Envelope. -- Generic attachments can be ingested separately from their events. We recommend - sending them in the same Envelope, which allows for more efficient rate - limiting and filtering. -- Generic attachments sent in separate Envelopes can be dropped independently of - an event. To ensure consistent handling, consider sending them in the same - request. -- The Sentry server supports special attachments to ingest event payloads for - backwards compatibility. These are not part of the official public API and the - behavior should not be relied upon. - -**Envelope Headers:** - -`event_id` - -: **UUID String, required.** The identifier of the event or transaction. - -**Additional Item Headers:** - -`filename` - -: **String, required.** The name of the uploaded file without a path component. - -`attachment_type` - -: *String, optional.* The special type of this attachment. Possible values are: - - - **`event.attachment` (default)**: A standard attachment without special - meaning. - - `event.minidump`: A minidump file that creates an error event and is - symbolicated. The file should start with the `MDMP` magic bytes. - - `event.applecrashreport`: An Apple crash report file that creates an error - event and is symbolicated. - - `unreal.context`: An XML file containing UE4 crash meta data. During event - ingestion, event contexts and extra fields are extracted from this file. - - `unreal.logs`: A plain-text log file obtained from UE4 crashes. During - event ingestion, the last logs are extracted into event breadcrumbs. - - `event.view_hierarchy`: An JSON file with a predefined structure, see [RFC #33](https://github.com/getsentry/rfcs/blob/main/text/0033-view-hierarchy.md). - -`content_type` - -: *String, optional.* The content type of the attachment payload. Any [MIME type](https://www.iana.org/assignments/media-types/media-types.xhtml) may be used; the default is `application/octet-stream`. - -### Session - -Item type `"session"` contains a single session initialization or update to an -existing session for Release Health. - -See the sessions documentation for the payload -details. - -**Constraints:** - -- This Item may occur multiple times per Envelope. -- Ingestion may limit the maximum number of Items per Envelope, see *Ingestion*. - -**Additional Item Headers:** - -*None* - -### Sessions - -Item type `"sessions"` contains buckets of pre-aggregated session counts. - -See the sessions documentation for the payload -details. - -**Constraints:** - -- This Item may occur multiple times per Envelope. -- Ingestion may limit the maximum number of Items per Envelope, see *Ingestion*. - -**Additional Item Headers:** - -*None* - -### Statsd - -Item type `"statsd"` contains metrics emissions in a superset of the statsd format. - -See the metrics documentation for the payload -details. - -**Constraints:** - -- This Item may occur multiple times per Envelope. -- Ingestion may limit the maximum number of Items per Envelope, see *Ingestion*. - -**Additional Item Headers:** - -*None* - -### Metric Meta - -Item type `"metric_meta"` contains per-metric meta data which is persisted alongside -metrics in the system. - -See the metrics documentation for the payload -details. - -**Constraints:** - -- This Item may occur multiple times per Envelope. -- Ingestion may limit the maximum number of Items per Envelope, see *Ingestion*. - -**Additional Item Headers:** - -*None* - -### User Feedback - -User Feedback was called User Report in the beginning. Therefore the envelope item type is `"user_report"`. -The item contains a user feedback / user report JSON payload: -```json -{"event_id":"9ec79c33ec9942ab8353589fcb2e04dc","email":"john@me.com","name":"John Me","comments":"It broke."}\n -``` - -**Attributes** - -`event_id` - -: **UUID String, required.** The identifier of the event or transaction. - - -`email` - -: *String, recommended.* The email of the user. - -`name` - -: *String, recommended.* The name of the user. - -`comments` - -: *String, recommended.* Comments of the user about what happened. - -**Constraints:** - -- This Item may occur once per Envelope. -- User Feedbacks / Reports can be ingested separately from their events. We recommended to - send them in the same Envelope. - -**Envelope Headers:** - -`event_id` - -: **UUID String, required.** The identifier of the event or transaction. - -**Additional Item Headers:** - -*None* - -### Client Report - -Item type `"client_report"` contains a client report payload encoded in JSON. - -See the client reports documentation for the payload -details. - -**Constraints:** - -- This Item may occur multiple times per Envelope, but please avoid sending more client reports than necessary. -- This Item can either be included in an Envelope with other Items, or it may be sent by itself. - -**Envelope Headers:** - -*None* - -**Additional Item Headers:** - -*None* - -### Replay Event - -Item type `"replay_event"` contains a replay payload encoded in JSON. - -See the replays documentation for the payload -details. - -**Constraints:** - -- This Item may occur at most once per Envelope. -- This Item must be sent with a Replay Recording Item. - -**Envelope Headers:** - -*None* - -**Additional Item Headers:** - -*None* - -### Replay Recording - -Item type `"replay_recording"` contains a replay recording payload encoded in JSON *or* a gzipped JSON. - -See the replays documentation for the payload -details. - -**Constraints:** - -- This Item may occur at most once per Envelope. -- This Item must be sent with a Replay Recording Item. - -**Envelope Headers:** - -*None* - -**Additional Item Headers:** - -`length` - -: **integer, required.** The size of the Replay recording payload - -### Profile - -Item type `"profile"`. This Item contains a profile payload encoded -in JSON. - -**Constraints:** - -- This Item may occur at most once per Envelope. -- This Item needs to be in the same Envelope as the associated transaction. - -**Envelope Headers:** - -*None* - -**Additional Item Headers:** - -*None* - -### Profile Chunk - -Item type `"profile_chunk"`. This Item contains a profile_chunk (profile sample format V2) payload encoded -in JSON. - -**Constraints:** - -*None* - -**Envelope Headers:** - -*None* - -**Additional Item Headers:** - -*None* - -### Check-Ins - -Item type `"check_in"` contains a check-in payload encoded as JSON. - -See the Check-Ins documentation for the payload -details. - -**Constraints:** - -- This Item may occur at most once per Envelope. -- This Item can either be included in an Envelope with other Items, or it may be sent by itself. - -**Envelope Headers:** - -*None* - -**Additional Item Headers:** - -*None* - -### Reserved Types - -Reserved types may not be written by any implementation. They are reserved for -future or internal use. This is the exhaustive list of reserved Item types: - -- `security` -- `unreal_report` -- `form_data` - ## Ingestion This section describes how to ingest Envelopes into Relay or Sentry. The main diff --git a/develop-docs/sdk/data-model/event-payloads/index.mdx b/develop-docs/sdk/data-model/event-payloads/index.mdx index cff1dfb1431db..23fa830625f75 100644 --- a/develop-docs/sdk/data-model/event-payloads/index.mdx +++ b/develop-docs/sdk/data-model/event-payloads/index.mdx @@ -1,6 +1,6 @@ --- title: Event Payloads -sidebar_order: 2 +sidebar_order: 3 --- Events are the fundamental data that clients, often through the use of an SDK, send From 7fbdb6dbf69b9acfc6d0f9b45facafa6d3a85c92 Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Thu, 10 Oct 2024 16:20:53 +0200 Subject: [PATCH 03/17] Fixed links in overview page --- develop-docs/sdk/overview.mdx | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/develop-docs/sdk/overview.mdx b/develop-docs/sdk/overview.mdx index 648e054ed2c77..6a1f1a8aff52d 100644 --- a/develop-docs/sdk/overview.mdx +++ b/develop-docs/sdk/overview.mdx @@ -28,12 +28,12 @@ Additionally, the following features are highly encouraged: - Non-blocking event submission - Context data helpers (e.g. setting the current user, recording breadcrumbs) - Event sampling -- Honor Sentry’s Rate Limiting HTTP headers +- Honor Sentry’s Rate Limiting HTTP headers - Pre and Post event send hooks - Local variable values in stack trace (on platforms where this is possible) - Send an `environment` on each event. If none was detected or set by the user, `production` should be used. -Please see the features page for descriptions of commonly expected Sentry SDK features. +Please see the expected features page for descriptions of commonly Sentry SDK features. ## Usage for End-users @@ -119,8 +119,7 @@ All segments, including PROJECT_ID, are of type String. Sentry provides the following endpoints: -- /envelope/ for any submission using Envelopes. -- /store/ for plain JSON event submission. +- /envelope/ for any submission using Envelopes. - [`/minidump/`](https://docs.sentry.io/platforms/native/minidump/) for multipart requests containing Minidumps. - [`/unreal/`](https://docs.sentry.io/platforms/unreal/configuration/setup-crashreporter/) for Unreal Engine 4 crash reports. @@ -200,7 +199,7 @@ it’s possible to send these values via the querystring: `sentry_timestamp` : The unix timestamp representing the time at which this event was generated. - *This key is effectively deprecated, and it is ignored on the receiving side. Use the [`sent_at` envelope header](/sdk/envelopes/#envelope-headers) instead.* + *This key is effectively deprecated, and it is ignored on the receiving side. Use the [`sent_at` envelope header](/sdk/data-model/envelopes/#envelope-headers) instead.* `sentry_secret` @@ -333,7 +332,7 @@ server. SDKs are supposed to provide standardized concurrency handling through the concept of hubs and scopes. This is explained in more details in the -Concurrency chapter of the unified API docs. +Concurrency chapter of the unified API docs. ## Layer of Integration From c50e7bedeca75f7a035524f2e1dcfc2408609fd1 Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Thu, 10 Oct 2024 16:21:59 +0200 Subject: [PATCH 04/17] Fixed links in philosophy page --- develop-docs/sdk/philosophy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/sdk/philosophy.mdx b/develop-docs/sdk/philosophy.mdx index cbe45fd84ef53..86f6ab37e7b9d 100644 --- a/develop-docs/sdk/philosophy.mdx +++ b/develop-docs/sdk/philosophy.mdx @@ -52,7 +52,7 @@ While we generally should try to keep the API surfaces of SDKs reasonable small. Some types of errors cannot be resolved without the data that was given to the program. But make sure that auto instrumentations doesn't attach PII without an explicit opt-in from the user. The server must be aware of parts of the protocol that include PII to scrub them by default. -Please check Data Handling for more detail. +Please check Data Handling for more detail. ## Don’t forget the big picture From e158942c77548f51845b7d5cc71970104d0b7e3e Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Thu, 10 Oct 2024 16:41:57 +0200 Subject: [PATCH 05/17] Fixed links in Excepted Features page --- develop-docs/sdk/expected-features/index.mdx | 41 ++++++++++---------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/develop-docs/sdk/expected-features/index.mdx b/develop-docs/sdk/expected-features/index.mdx index 2693f853c425a..9948a41e56129 100644 --- a/develop-docs/sdk/expected-features/index.mdx +++ b/develop-docs/sdk/expected-features/index.mdx @@ -4,14 +4,15 @@ sidebar_order: 4 --- The following is a description of features that are commonly expected in Sentry SDKs. Make sure to also -have read the unified API design documentation +have read the unified API design documentation which explains the common API design. ## Background Sending Events should be transmitted in a background thread or similar system. This queue must be flushed when the application shuts down with a specific timeout. This feature is typically user facing and explained -as part of [shutdown and draining](https://docs.sentry.io/error-reporting/configuration/draining/?platform=swift). +as part of [shutdown and draining](https://docs.sentry.io/platforms/javascript/configuration/draining/). + ## Uncaught Exception Handler @@ -23,11 +24,11 @@ This behavior is typically provided by a default integration that can be disable Scopes should be provided by SDKs to set common attributes and context data on events sent to Sentry emitted from the current scope. They should be inherited to lower scopes so that they can be set "globally" on startup. Note that some attributes can only be set in the client options (`release`, `environment`) and not on scopes. -What scope means depends on the application, for a web framework it is most likely a single request/response cycle. For a mobile application there is often just one single scope that represents the single user and their actions. Scoping can be difficult to implement because it often has to deal with threads or concurrency and can involve deep integration with frameworks. see the scopes page for more information. +What scope means depends on the application, for a web framework it is most likely a single request/response cycle. For a mobile application there is often just one single scope that represents the single user and their actions. Scoping can be difficult to implement because it often has to deal with threads or concurrency and can involve deep integration with frameworks. see the scopes page for more information. ## Automatic Context Data -Automatic addition of useful attributes such as `tags` or `extra` or specific `contexts`. Typically means the SDK hooks into a framework so that it can set attributes that are known to be useful for most users. Please check [Data Handling](/sdk/data-handling) for considerations. +Automatic addition of useful attributes such as `tags` or `extra` or specific `contexts`. Typically means the SDK hooks into a framework so that it can set attributes that are known to be useful for most users. Please check [Data Handling](/sdk/expected-features/data-handling) for considerations. ## Breadcrumbs @@ -41,7 +42,7 @@ With deeper framework integration, the automatic recording of breadcrumbs is pos * System Events: low battery, low storage space, airplane mode started, memory warnings, device orientation changed, etc. * [Outgoing HTTP requests](#http-client-integrations) -Check out the [complete breadcrumb documentation](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#breadcrumb-types) for more types. +Check out the [complete breadcrumb documentation](/sdk/data-model/event-payloads/breadcrumbs/#breadcrumb-types) for more types. ## Event Sampling @@ -65,14 +66,14 @@ ignore_transactions = ['GET /api/health','/api/v1/*'] Respect Sentry’s HTTP 429 `Retry-After` header, or, if the SDK supports multiple payload types (e.g. errors and transactions), the `X-Sentry-Rate-Limits` header. Outgoing SDK requests should be dropped during the backoff period. -See Rate Limiting for details. +See Rate Limiting for details. ## Backpressure Management Backend SDKs (typically used in server applications) should have backpressure management logic that dynamically downsamples transactions when the throughput in the system is too high. -See Backpressure Management for details. +See Backpressure Management for details. ## In-App frames @@ -98,7 +99,7 @@ Ability to get the ID of the last event sent. Event IDs are useful for correlati ## User Feedback -For all SDKs, it is strongly recommended to send the `User Feedback` as an [envelope](/sdk/envelopes/#user-feedback). Alternatively, the SDKs can +For all SDKs, it is strongly recommended to send the `User Feedback` as an [envelope item](/sdk/data-model/envelope-items/#user-feedback). Alternatively, the SDKs can use the [User Feedback endpoint](https://docs.sentry.io/api/projects/submit-user-feedback/), which is not recommended. ### User Facing Platforms @@ -130,7 +131,7 @@ Envelope item: ## Attachments -Attachments are files stored alongside an event. To send an attachment, add it as an [envelope item](/sdk/envelopes/#attachment) +Attachments are files stored alongside an event. To send an attachment, add it as an [envelope item](/sdk/data-model/envelope-items/#attachment) to the corresponding event. We recommend implementing two types of attachments, one with a path and another with a byte array. @@ -142,7 +143,7 @@ The overload that takes a `path` should consider: * If reading the attachment fails, the SDK should not drop the whole envelope, but just the attachment's envelope item. * If the SDK is in debug mode log (`debug=true`) out errors to make debugging easier. -If the SDK supports [transactions](/sdk/envelopes/#transaction), the attachments should offer a flag `addToTransactions`, +If the SDK supports [transactions](/sdk/data-model/envelope-items/#transaction), the attachments should offer a flag `addToTransactions`, that specifies if SDK adds the attachment to every transaction or not. The default should be `false`. Use the implementations of [Java](https://github.com/getsentry/sentry-java/blob/main/sentry/src/main/java/io/sentry/Attachment.java), @@ -158,7 +159,7 @@ useful because attachments could quickly eat up the users' disk space. Furthermo ## Screenshots -When the user opts-in, if technically possible, take a screenshot of the application during a crash or error and include it as an [attachment](#attachments) to the [envelope](/sdk/envelopes/) with the event. +When the user opts-in, if technically possible, take a screenshot of the application during a crash or error and include it as an [attachment](#attachments) to the [envelope](/sdk/data-model/envelopes/) with the event. This feature only applies to SDKs with a user interface, such as Mobile and Desktop. In some environments such as native iOS, taking a screenshot requires the UI thread and in the event of a crash, that might not be available. So inherently this feature will be a best effort solution. @@ -209,7 +210,7 @@ Consider having the SDK retry sending events once the device is back online, whe Once the device is back online, the SDK is likely going to empty its disk queue in a quick burst of requests. This can trigger different abuse filters in Sentry. To account for that, it's considered to add a small delay between cached event captures. A recommended value is 100 milliseconds. -If the SDK is being [rate-limited](/sdk/rate-limiting/), which causes the SDK to drop any event that reaches its HTTP transport, cosider stop consuming the disk cache until the `Retry-After` timeout is reached or the app restarts. +If the SDK is being [rate-limited](/sdk/expected-features/rate-limiting/), which causes the SDK to drop any event that reaches its HTTP transport, cosider stop consuming the disk cache until the `Retry-After` timeout is reached or the app restarts. #### Example implementations @@ -287,7 +288,7 @@ If Performance Monitoring is both supported by the SDK and enabled in the client - HTTP requests must be enhanced with a [`sentry-trace` HTTP header](/sdk/performance/#header-sentry-trace) to support [distributed tracing](https://docs.sentry.io/product/sentry-basics/tracing/distributed-tracing) - HTTP requests must be enhanced with a [`traceparent` HTTP header](/sdk/performance/#header-traceparent) to support [distributed tracing](https://docs.sentry.io/product/sentry-basics/tracing/distributed-tracing) - HTTP requests must be enhanced with a [`baggage` HTTP header](/sdk/performance/dynamic-sampling-context/#baggage-header) to support [dynamic sampling](/sdk/performance/dynamic-sampling-context/) -- span status must match HTTP response status code ([see Span status to HTTP status code mapping](/sdk/event-payloads/span/)) +- span status must match HTTP response status code ([see Span status to HTTP status code mapping](/sdk/data-model/event-payloads/span/)) - when network error occurs, span status must be set to `internal_error` - span data must follow the [Span Data Conventions](/sdk/performance/span-data-conventions/) @@ -308,9 +309,9 @@ The HTTP Client integration should have 3 configuration options: The HTTP Client integration should capture error events with the following properties: -The Request interface, see the Spec for details. +The Request interface, see the Spec for details. -The Response context, see the Spec for details. +The Response context, see the Spec for details. ```json { @@ -329,12 +330,12 @@ The Response context, see the Spec for details. +The Exception Interface, see the Spec for details. If the HTTP Client integration does not throw an exception for unsuccessful requests, you can create a synthetic exception following this Spec: -- Set the Exception Mechanism with a proper `type` such as `SentryOkHttpInterceptor`. -- Set the Stack Trace Interface with `snapshot=true`. +- Set the Exception Mechanism with a proper `type` such as `SentryOkHttpInterceptor`. +- Set the Stack Trace Interface with `snapshot=true`. - `HTTP Client Error with status code: $code`. When capturing error events, pass the original `Request` and `Response` objects from the HTTP Client as `hints`, so the users may filter out events in `beforeSend` with the full context. @@ -345,7 +346,7 @@ As an example, see the [OkHTTP Client integration](https://github.com/getsentry/ ## GraphQL Client Integrations -The GraphQL Client integrations should match the guidelines for [HTTP Client Integrations](/sdk/features/#http-client-integrations) with a few differences: +The GraphQL Client integrations should match the guidelines for [HTTP Client Integrations](/sdk/expected-features/#http-client-integrations) with a few differences: The `failedRequestStatusCodes` parameter does not exist because GraphQL errors are not HTTP errors, so that the request can be errored even though the HTTP status code of the response is successful. @@ -412,7 +413,7 @@ The `fingerprints` field should be set to `["$operationName", "$operationType", ### Server -The GraphQL Performance integration should match the guidelines for [GraphQL Client Integrations](/sdk/features/#graphql-client-integrations) with a few differences: +The GraphQL Performance integration should match the guidelines for [GraphQL Client Integrations](/sdk/expected-features/#graphql-client-integrations) with a few differences: The transaction's name should be set with the GraphQL operation name, if possible, otherwise fallback to something unique that makes sense, e.g. the canonical name of the actual/generated class. From 638732cc30c176138fe7dd7abb4234e32d8bcb7d Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Fri, 11 Oct 2024 08:16:03 +0200 Subject: [PATCH 06/17] Fixed redirects in expected features page --- develop-docs/sdk/expected-features/index.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/develop-docs/sdk/expected-features/index.mdx b/develop-docs/sdk/expected-features/index.mdx index 9948a41e56129..4e2faac441aff 100644 --- a/develop-docs/sdk/expected-features/index.mdx +++ b/develop-docs/sdk/expected-features/index.mdx @@ -285,12 +285,12 @@ If Performance Monitoring is both supported by the SDK and enabled in the client - operation: `http.client` - description: `$METHOD $url` (uppercase HTTP method), e.g. `GET https://sentry.io` -- HTTP requests must be enhanced with a [`sentry-trace` HTTP header](/sdk/performance/#header-sentry-trace) to support [distributed tracing](https://docs.sentry.io/product/sentry-basics/tracing/distributed-tracing) -- HTTP requests must be enhanced with a [`traceparent` HTTP header](/sdk/performance/#header-traceparent) to support [distributed tracing](https://docs.sentry.io/product/sentry-basics/tracing/distributed-tracing) -- HTTP requests must be enhanced with a [`baggage` HTTP header](/sdk/performance/dynamic-sampling-context/#baggage-header) to support [dynamic sampling](/sdk/performance/dynamic-sampling-context/) +- 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) +- 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) +- 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/) - span status must match HTTP response status code ([see Span status to HTTP status code mapping](/sdk/data-model/event-payloads/span/)) - when network error occurs, span status must be set to `internal_error` -- span data must follow the [Span Data Conventions](/sdk/performance/span-data-conventions/) +- span data must follow the [Span Data Conventions](/sdk/telemetry/traces/span-data-conventions/) ### HTTP Client Errors @@ -303,7 +303,7 @@ The HTTP Client integration should have 3 configuration options: - `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`. - The SDK will only capture HTTP Client errors if the HTTP Response status code is within the defined ranges in `failedRequestStatusCodes`. - If the language has a `Range` type, it should be used instead of `HttpStatusCodeRange`. -- `failedRequestTargets` defaults to (`.*`), this configuration option accepts a `List` of `String` that may be Regular expressions as well, similar to tracePropagationTargets. +- `failedRequestTargets` defaults to (`.*`), this configuration option accepts a `List` of `String` that may be Regular expressions as well, similar to tracePropagationTargets. - The SDK will only capture HTTP Client errors if the HTTP Request URL is a match for any of the `failedRequestsTargets`. - sensitive `headers` should only be set if `sendDefaultPii` is enabled, e.g. `Cookie` and `Set-Cookie`. @@ -431,9 +431,9 @@ Spans should be created for [resolvers](https://www.apollographql.com/docs/apoll Spans should be created for [data loaders](https://graphql.org/learn/best-practices/#server-side-batching-caching/), if possible. -The operation type should follow the [Span Operation Conventions](/sdk/performance/span-operations/). +The operation type should follow the [Span Operation Conventions](/sdk/telemetry/traces/span-operations/). -Extra (`data`) attributes for transactions and/or spans, there are [Span Data](/sdk/performance/span-data-conventions/) and [OTel GraphQL](https://opentelemetry.io/docs/specs/otel/trace/semantic_conventions/instrumentation/graphql/) conventions. +Extra (`data`) attributes for transactions and/or spans, there are [Span Data](/sdk/telemetry/traces/span-data-conventions/) and [OTel GraphQL](https://opentelemetry.io/docs/specs/otel/trace/semantic_conventions/instrumentation/graphql/) conventions. Instrumenting APM for GraphQL will depend on the instrumented GraphQL library, if there are available hooks for it, the SDK should use them, otherwise, the SDK could try to monkeypatch the library or instrument the transport layer using heuristics, for example, if the URL ends with `graphql`, if there are HTTP Headers, etc. From f30005ffffec00e00d7fda60ab9e2d41d4b05479 Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Fri, 11 Oct 2024 15:35:16 +0200 Subject: [PATCH 07/17] Fix links to client-reports and envelopes --- develop-docs/application/feedback-architecture.mdx | 10 +++++----- develop-docs/sdk/data-model/envelope-items.mdx | 2 +- develop-docs/sdk/data-model/event-payloads/index.mdx | 4 ++-- .../sdk/data-model/event-payloads/transaction.mdx | 4 ++-- develop-docs/sdk/expected-features/data-handling.mdx | 2 +- develop-docs/sdk/expected-features/rate-limiting.mdx | 4 ++-- .../sdk/telemetry/profiles/sample-format-v1.mdx | 4 ++-- .../sdk/telemetry/profiles/sample-format-v2.mdx | 2 +- develop-docs/sdk/telemetry/sessions/index.mdx | 2 +- develop-docs/sdk/telemetry/traces/index.mdx | 2 +- docs/concepts/data-management/size-limits.mdx | 11 +++++------ docs/platforms/android/configuration/options.mdx | 4 ++-- .../android/enriching-events/attachments/index.mdx | 2 +- docs/platforms/apple/common/configuration/options.mdx | 4 ++-- .../common/enriching-events/attachments/index.mdx | 2 +- docs/platforms/apple/common/migration/index.mdx | 2 +- docs/platforms/dart/configuration/options.mdx | 2 +- .../dart/enriching-events/attachments/index.mdx | 2 +- .../platforms/dotnet/common/configuration/options.mdx | 4 ++-- .../common/enriching-events/attachments/index.mdx | 2 +- docs/platforms/dotnet/common/migration/index.mdx | 2 +- docs/platforms/elixir/configuration/options.mdx | 2 +- docs/platforms/flutter/configuration/options.mdx | 4 ++-- .../flutter/enriching-events/attachments/index.mdx | 2 +- docs/platforms/go/common/configuration/options.mdx | 2 +- docs/platforms/java/common/configuration/options.mdx | 4 ++-- .../common/enriching-events/attachments/index.mdx | 2 +- .../javascript/common/configuration/options.mdx | 2 +- .../kotlin-multiplatform/configuration/options.mdx | 4 ++-- .../enriching-events/attachments/index.mdx | 2 +- .../platforms/native/common/configuration/options.mdx | 2 +- docs/platforms/php/common/configuration/options.mdx | 2 +- docs/platforms/powershell/configuration/options.mdx | 4 ++-- .../powershell/enriching-events/attachments/index.mdx | 2 +- docs/platforms/python/configuration/options.mdx | 2 +- docs/platforms/react-native/configuration/options.mdx | 4 ++-- docs/platforms/react-native/migration/index.mdx | 2 +- docs/platforms/rust/common/configuration/options.mdx | 2 +- docs/platforms/unity/configuration/options.mdx | 4 ++-- .../unity/enriching-events/attachments/index.mdx | 2 +- docs/platforms/unreal/configuration/options.mdx | 2 +- .../unreal/enriching-events/attachments/index.mdx | 2 +- docs/product/stats/index.mdx | 4 ++-- 43 files changed, 65 insertions(+), 66 deletions(-) diff --git a/develop-docs/application/feedback-architecture.mdx b/develop-docs/application/feedback-architecture.mdx index fd9649efd08c9..78209cb86f0fc 100644 --- a/develop-docs/application/feedback-architecture.mdx +++ b/develop-docs/application/feedback-architecture.mdx @@ -15,12 +15,12 @@ When broken down, there are **5** ways to create feedback in our system 😵‍ `FeedbackCreationSource(Enum)` in [create_feedback.py](https://github.com/getsentry/sentry/blob/2b642e149c79b251e1c2f4339fc73d656347d74e/src/sentry/feedback/usecases/create_feedback.py#L33-L33). The 4 ways _clients_ can create feedback are: -`NEW_FEEDBACK_ENVELOPE`: [The new format](https://develop.sentry.dev/sdk/envelopes/#full-examples) created by the Replay team when adding +`NEW_FEEDBACK_ENVELOPE`: [The new format](https://develop.sentry.dev/sdk/data-model/envelopes/#full-examples) created by the Replay team when adding the [User Feedback Widget](https://docs.sentry.io/product/user-feedback/#user-feedback-widget) to the JavaScript SDK. It allows adding more information, for example tags, release, url, etc. -`USER_REPORT_ENVELOPE`: [The older format](https://develop.sentry.dev/sdk/envelopes/#user-feedback) with name/email/comments, that requires +`USER_REPORT_ENVELOPE`: [The older format](https://develop.sentry.dev/sdk/data-model/envelopes/#user-feedback) with name/email/comments, that requires `event_id` to link a Sentry error event. `USER_REPORT_DJANGO_ENDPOINT`: [The deprecated Web API](https://docs.sentry.io/api/projects/submit-user-feedback/) @@ -41,7 +41,7 @@ which ## Feedback events -The new and preferred way to send feedback from the SDK is in an [event envelope](https://develop.sentry.dev/sdk/envelopes/#full-examples). +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). The format is the same as error events, except the `type` header = `"feedback"`. While user reports have an associated event, **new feedback _is_ an event**. This offers 2 improvements: @@ -84,7 +84,7 @@ In Relay v24.5.1, we migrated feedback to its own kafka topic + consumer, ### Attachments We only use attachments for the widget’s screenshot feature, which allows users -to submit **at most 1 screenshot per feedback**. Attachments are another [item type](https://develop.sentry.dev/sdk/envelopes/#attachment) +to submit **at most 1 screenshot per feedback**. Attachments are another [item type](https://develop.sentry.dev/sdk/data-model/envelopes/#attachment) in an envelope. - SDK v8.0.0+, Relay v24.5.1+: Sends the feedback and attachment items in the same envelope. @@ -139,7 +139,7 @@ Simplified diagram: ### Envelopes -User reports are also sent to Relay in [envelope format](https://develop.sentry.dev/sdk/envelopes/#user-feedback). +User reports are also sent to Relay in [envelope format](https://develop.sentry.dev/sdk/data-model/envelopes/#user-feedback). **This item type is misleadingly called “user feedback” in some of our docs, but the item header will read `"user_report"`.** diff --git a/develop-docs/sdk/data-model/envelope-items.mdx b/develop-docs/sdk/data-model/envelope-items.mdx index b9a9ea2495779..39af5beb3de2f 100644 --- a/develop-docs/sdk/data-model/envelope-items.mdx +++ b/develop-docs/sdk/data-model/envelope-items.mdx @@ -226,7 +226,7 @@ The item contains a user feedback / user report JSON payload: Item type `"client_report"` contains a client report payload encoded in JSON. -See the client reports documentation for the payload +See the client reports documentation for the payload details. **Constraints:** diff --git a/develop-docs/sdk/data-model/event-payloads/index.mdx b/develop-docs/sdk/data-model/event-payloads/index.mdx index 23fa830625f75..447c7eef581c6 100644 --- a/develop-docs/sdk/data-model/event-payloads/index.mdx +++ b/develop-docs/sdk/data-model/event-payloads/index.mdx @@ -6,7 +6,7 @@ sidebar_order: 3 Events are the fundamental data that clients, often through the use of an SDK, send to the Sentry server. -Events are packed into [envelopes](/sdk/envelopes/) and are sent to the `/api/{PROJECT_ID}/envelope/` API endpoint. +Events are packed into [envelopes](/sdk/data-model/envelopes/) and are sent to the `/api/{PROJECT_ID}/envelope/` API endpoint. Sending event payloads to the `/api/{PROJECT_ID}/store/` API endpoint is deprecated. @@ -309,7 +309,7 @@ These limits are subject to future change and defined currently as: - *1MB* decompressed (and `200KB` compressed) for events of type `error` - *1MB* decompressed (and `200KB` compressed) for events of type `transaction` -Sessions, client reports, replays, check-ins, and profiles are not events and have different size limits. See [Envelope Size Limits](/sdk/envelopes/#size-limits). +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). ## Core Interfaces diff --git a/develop-docs/sdk/data-model/event-payloads/transaction.mdx b/develop-docs/sdk/data-model/event-payloads/transaction.mdx index b72a9db7cfd1e..cead0af18800f 100644 --- a/develop-docs/sdk/data-model/event-payloads/transaction.mdx +++ b/develop-docs/sdk/data-model/event-payloads/transaction.mdx @@ -4,11 +4,11 @@ title: Transaction Payloads Transactions are used to send tracing events to Sentry. -Transactions must be wrapped in an [Envelope](/sdk/envelopes/) and therefore also be sent to the Envelope endpoint. +Transactions must be wrapped in an [Envelope](/sdk/data-model/envelopes/) and therefore also be sent to the Envelope endpoint. Envelopes are a new format and therefore only work on Sentry >= 10. More - information can be found on the Envelope page. + information can be found on the Envelope page. ## Anatomy diff --git a/develop-docs/sdk/expected-features/data-handling.mdx b/develop-docs/sdk/expected-features/data-handling.mdx index 30977316e5536..309e5b64d3924 100644 --- a/develop-docs/sdk/expected-features/data-handling.mdx +++ b/develop-docs/sdk/expected-features/data-handling.mdx @@ -118,5 +118,5 @@ Fields in the event payload that allow user-specified or dynamic values are rest 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: -- Envelope Endpoint Size Limits +- Envelope Endpoint Size Limits - Store Endpoint Size Limits diff --git a/develop-docs/sdk/expected-features/rate-limiting.mdx b/develop-docs/sdk/expected-features/rate-limiting.mdx index 10839d44729e7..918f4b3d6b4e5 100644 --- a/develop-docs/sdk/expected-features/rate-limiting.mdx +++ b/develop-docs/sdk/expected-features/rate-limiting.mdx @@ -15,7 +15,7 @@ Each *quota_limit* has the form `retry_after:categories:scope:reason_code:namesp - `retry_after`: Number of seconds (as an integer or a floating point number) until this rate limit expires. - `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**. - While these categories might look similar to the [envelope item types](/sdk/envelopes/#data-model), they are not identical, and have slight differences. + 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. - `scope`: The scope that this limit applies to. Can be ignored by SDKs. - `reason_code`: A unique identifier for the quota hinting at the rate limiting reason. Can be ignored by SDKs. - `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: 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. - **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. -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. +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. - `default`: Events with an event_type not listed explicitly below. - `error`: Error events. - `transaction`: Transaction type events. diff --git a/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx b/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx index 1fde8b7c88298..ee7910dbd5278 100644 --- a/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx +++ b/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx @@ -389,8 +389,8 @@ It's suggested to remove unnecessary data like thread data without samples from ## Ingestion After this payload is generated, serialize it as JSON, pack it into the same -[Envelope](/sdk/envelopes/) as the associated transaction with the item type -[`profile`](/sdk/envelopes/#profile) and send it to Relay. +[Envelope](/sdk/data-model/envelopes/) as the associated transaction with the item type +[`profile`](/sdk/data-model/envelopes/#profile) and send it to Relay. This envelope should look like this: diff --git a/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx b/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx index 362cee4426b01..bc7e25e156ca3 100644 --- a/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx +++ b/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx @@ -283,7 +283,7 @@ It's suggested to remove unnecessary data like thread data without samples from After this payload is generated, serialize it as JSON, pack it into an -[Envelope](/sdk/envelopes/) with the item type [`profile_chunk`](/sdk/envelopes/#profile-chunk) and send +[Envelope](/sdk/data-model/envelopes/) with the item type [`profile_chunk`](/sdk/data-model/envelopes/#profile-chunk) and send it to Relay. diff --git a/develop-docs/sdk/telemetry/sessions/index.mdx b/develop-docs/sdk/telemetry/sessions/index.mdx index e78da6707bd6a..c17ee7375c0bc 100644 --- a/develop-docs/sdk/telemetry/sessions/index.mdx +++ b/develop-docs/sdk/telemetry/sessions/index.mdx @@ -9,7 +9,7 @@ Looking for Sentry's **Session Replay**? Click envelopes +For basic health tracking Sentry accepts envelopes containing session update events. These session update events can be used to inform Sentry about release and project associated project health. diff --git a/develop-docs/sdk/telemetry/traces/index.mdx b/develop-docs/sdk/telemetry/traces/index.mdx index fc8edde789153..e1ee55b10f6b0 100644 --- a/develop-docs/sdk/telemetry/traces/index.mdx +++ b/develop-docs/sdk/telemetry/traces/index.mdx @@ -139,7 +139,7 @@ tree as well as the unit of reporting to Sentry. - `super.finish()` (call finish on Span) - Send it to Sentry only if `sampled == true` - Like spans, can be given an optional `endTimestamp` value that should be passed into the `span.finish()` call - - A `Transaction` needs to be wrapped in an `Envelope` and sent to the [Envelope Endpoint](/sdk/envelopes/) + - A `Transaction` needs to be wrapped in an `Envelope` and sent to the [Envelope Endpoint](/sdk/data-model/envelopes/) - The `Transport` should use the same internal queue for `Transactions` / `Events` - The `Transport` should implement category-based rate limiting → - The `Transport` should deal with wrapping a `Transaction` in an `Envelope` internally diff --git a/docs/concepts/data-management/size-limits.mdx b/docs/concepts/data-management/size-limits.mdx index 2dd62cf0f9f9d..60d072dc79309 100644 --- a/docs/concepts/data-management/size-limits.mdx +++ b/docs/concepts/data-management/size-limits.mdx @@ -4,16 +4,16 @@ sidebar_order: 7 description: "Learn about the size limits for events and attachments, and how to avoid exceeding them." --- -Sentry imposes size limits on events, attachments, requests, and various event fields. +Sentry imposes size limits on events, attachments, requests, and various event fields. ## Behavior The following describes how Sentry treats size limits: -- Events, attachments, and requests exceeding payload size limits are immediately dropped with a `413 Payload Too Large` error. +- Events, attachments, and requests exceeding payload size limits are immediately dropped with a `413 Payload Too Large` error. - Sentry allows compressed content encoding, and applies separate limits before and after decompression. -- Events that exceed 200KB compressed or 1MB decompressed will be rejected. -- Minidump uploads that exceeed 20MB compressed or 100MB decompressed (for all files combined) will also be rejected. +- Events that exceed 200KB compressed or 1MB decompressed will be rejected. +- Minidump uploads that exceeed 20MB compressed or 100MB decompressed (for all files combined) will also be rejected. - Event fields exceeding the individual size limits are trimmed and truncated afterwards. - The number of events rejected due to size limits is counted towards the _Dropped_ category in [usage stats](/product/stats/#usage-stats). @@ -25,8 +25,7 @@ To avoid using up your attachments quota — which is based on size and not numb Sentry's exact size limits may change over time. For more information, please refer to the following resources: -- [Envelope Size Limits](https://develop.sentry.dev/sdk/envelopes/#size-limits) +- [Envelope Size Limits](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) - [Store Endpoint Size Limits](https://develop.sentry.dev/sdk/store/#size-limits) - [Minidump Size Limits](/platforms/native/guides/minidumps/#size-limits) - [Variable Size Limits](https://develop.sentry.dev/sdk/data-handling/#variable-size) - diff --git a/docs/platforms/android/configuration/options.mdx b/docs/platforms/android/configuration/options.mdx index 8389435bd8a77..69ece2608b43d 100644 --- a/docs/platforms/android/configuration/options.mdx +++ b/docs/platforms/android/configuration/options.mdx @@ -71,13 +71,13 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. -The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. +The maximum number of [envelopes](https://develop.sentry.dev/sdk/data-model/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. diff --git a/docs/platforms/android/enriching-events/attachments/index.mdx b/docs/platforms/android/enriching-events/attachments/index.mdx index ab6728af26b28..9a254f3bf124f 100644 --- a/docs/platforms/android/enriching-events/attachments/index.mdx +++ b/docs/platforms/android/enriching-events/attachments/index.mdx @@ -7,7 +7,7 @@ Sentry can enrich your events for further investigation by storing additional fi ## Creating Attachments -The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. +The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/data-model/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. diff --git a/docs/platforms/apple/common/configuration/options.mdx b/docs/platforms/apple/common/configuration/options.mdx index e3e87dc5c1242..7cd2196582dda 100644 --- a/docs/platforms/apple/common/configuration/options.mdx +++ b/docs/platforms/apple/common/configuration/options.mdx @@ -69,13 +69,13 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. -The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. +The maximum number of [envelopes](https://develop.sentry.dev/sdk/data-model/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. diff --git a/docs/platforms/apple/common/enriching-events/attachments/index.mdx b/docs/platforms/apple/common/enriching-events/attachments/index.mdx index b752a18b37a04..cbcb8a3343403 100644 --- a/docs/platforms/apple/common/enriching-events/attachments/index.mdx +++ b/docs/platforms/apple/common/enriching-events/attachments/index.mdx @@ -7,7 +7,7 @@ On this page, you will learn how to attach files, such as logs or config files, ## Creating Attachments -The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. +The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/data-model/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. diff --git a/docs/platforms/apple/common/migration/index.mdx b/docs/platforms/apple/common/migration/index.mdx index 8ae268737814e..b1d692a8d19f4 100644 --- a/docs/platforms/apple/common/migration/index.mdx +++ b/docs/platforms/apple/common/migration/index.mdx @@ -185,7 +185,7 @@ This version includes the following configuration changes: #### Store Endpoint -This version uses the [envelope endpoint](https://develop.sentry.dev/sdk/envelopes/). If you are using self-hosted Sentry, you must use Sentry version `>= v20.6.0` or higher. If you are using sentry.io, there is no impact. For this change, we also now cache events in envelopes on the disk. We decided not to migrate the few cached events from 5.x to 6.x into envelopes. Instead, we remove them from the disk. As a result, you might lose a few cached events when upgrading. +This version uses the [envelope endpoint](https://develop.sentry.dev/sdk/data-model/envelopes/). If you are using self-hosted Sentry, you must use Sentry version `>= v20.6.0` or higher. If you are using sentry.io, there is no impact. For this change, we also now cache events in envelopes on the disk. We decided not to migrate the few cached events from 5.x to 6.x into envelopes. Instead, we remove them from the disk. As a result, you might lose a few cached events when upgrading. #### SDK Inits diff --git a/docs/platforms/dart/configuration/options.mdx b/docs/platforms/dart/configuration/options.mdx index 97294bff318e3..45fcd1572fe88 100644 --- a/docs/platforms/dart/configuration/options.mdx +++ b/docs/platforms/dart/configuration/options.mdx @@ -71,7 +71,7 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. diff --git a/docs/platforms/dart/enriching-events/attachments/index.mdx b/docs/platforms/dart/enriching-events/attachments/index.mdx index bcbfa6f6b6ef1..cb56176a1cd93 100644 --- a/docs/platforms/dart/enriching-events/attachments/index.mdx +++ b/docs/platforms/dart/enriching-events/attachments/index.mdx @@ -7,7 +7,7 @@ Sentry can enrich your events for further investigation by storing additional fi ## Creating Attachments -The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. +The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/data-model/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. diff --git a/docs/platforms/dotnet/common/configuration/options.mdx b/docs/platforms/dotnet/common/configuration/options.mdx index a4c2481f4712a..14916bc8606f8 100644 --- a/docs/platforms/dotnet/common/configuration/options.mdx +++ b/docs/platforms/dotnet/common/configuration/options.mdx @@ -113,13 +113,13 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. -The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. +The maximum number of [envelopes](https://develop.sentry.dev/sdk/data-model/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. diff --git a/docs/platforms/dotnet/common/enriching-events/attachments/index.mdx b/docs/platforms/dotnet/common/enriching-events/attachments/index.mdx index 34bd56f6aeab9..bb8361bf04e02 100644 --- a/docs/platforms/dotnet/common/enriching-events/attachments/index.mdx +++ b/docs/platforms/dotnet/common/enriching-events/attachments/index.mdx @@ -13,7 +13,7 @@ Sentry can enrich your events for further investigation by storing additional fi ## Creating Attachments -The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. +The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/data-model/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. diff --git a/docs/platforms/dotnet/common/migration/index.mdx b/docs/platforms/dotnet/common/migration/index.mdx index 7777f2fcf955b..34a2d65f02689 100644 --- a/docs/platforms/dotnet/common/migration/index.mdx +++ b/docs/platforms/dotnet/common/migration/index.mdx @@ -271,7 +271,7 @@ The property of `SentryEvent` that supports a structured log entry was renamed t ### Self-Hosted Support -This version uses the [envelope endpoint](https://develop.sentry.dev/sdk/envelopes/). If you are using an on-premise installation it requires Sentry version >= v20.6.0 to work. If you are using sentry.io nothing will change and no action is needed. +This version uses the [envelope endpoint](https://develop.sentry.dev/sdk/data-model/envelopes/). If you are using an on-premise installation it requires Sentry version >= v20.6.0 to work. If you are using sentry.io nothing will change and no action is needed. ### New Features and Improvements diff --git a/docs/platforms/elixir/configuration/options.mdx b/docs/platforms/elixir/configuration/options.mdx index 65a45071c0640..2553df8fef794 100644 --- a/docs/platforms/elixir/configuration/options.mdx +++ b/docs/platforms/elixir/configuration/options.mdx @@ -47,7 +47,7 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. diff --git a/docs/platforms/flutter/configuration/options.mdx b/docs/platforms/flutter/configuration/options.mdx index f08a6ac06690f..ac0234e0aa277 100644 --- a/docs/platforms/flutter/configuration/options.mdx +++ b/docs/platforms/flutter/configuration/options.mdx @@ -71,13 +71,13 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. -The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. +The maximum number of [envelopes](https://develop.sentry.dev/sdk/data-model/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. diff --git a/docs/platforms/flutter/enriching-events/attachments/index.mdx b/docs/platforms/flutter/enriching-events/attachments/index.mdx index bcbfa6f6b6ef1..cb56176a1cd93 100644 --- a/docs/platforms/flutter/enriching-events/attachments/index.mdx +++ b/docs/platforms/flutter/enriching-events/attachments/index.mdx @@ -7,7 +7,7 @@ Sentry can enrich your events for further investigation by storing additional fi ## Creating Attachments -The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. +The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/data-model/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. diff --git a/docs/platforms/go/common/configuration/options.mdx b/docs/platforms/go/common/configuration/options.mdx index 8a72cf82b5cea..cfb80eb91a3c2 100644 --- a/docs/platforms/go/common/configuration/options.mdx +++ b/docs/platforms/go/common/configuration/options.mdx @@ -95,7 +95,7 @@ type ClientOptions struct { MaxBreadcrumbs int // Maximum number of spans. // - // See https://develop.sentry.dev/sdk/envelopes/#size-limits for size limits + // See https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits for size limits // applied during event ingestion. Events that exceed these limits might get dropped. MaxSpans int // An optional pointer to http.Client that will be used with a default diff --git a/docs/platforms/java/common/configuration/options.mdx b/docs/platforms/java/common/configuration/options.mdx index b77952856ba91..ed6628cfa6bab 100644 --- a/docs/platforms/java/common/configuration/options.mdx +++ b/docs/platforms/java/common/configuration/options.mdx @@ -71,13 +71,13 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. -The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. +The maximum number of [envelopes](https://develop.sentry.dev/sdk/data-model/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. diff --git a/docs/platforms/java/common/enriching-events/attachments/index.mdx b/docs/platforms/java/common/enriching-events/attachments/index.mdx index 1901f78f1f427..3a5bd1b985808 100644 --- a/docs/platforms/java/common/enriching-events/attachments/index.mdx +++ b/docs/platforms/java/common/enriching-events/attachments/index.mdx @@ -7,7 +7,7 @@ Sentry can enrich your events for further investigation by storing additional fi ## Creating Attachments -The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. +The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/data-model/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. diff --git a/docs/platforms/javascript/common/configuration/options.mdx b/docs/platforms/javascript/common/configuration/options.mdx index 72140d8f49470..5b61d11b02502 100644 --- a/docs/platforms/javascript/common/configuration/options.mdx +++ b/docs/platforms/javascript/common/configuration/options.mdx @@ -84,7 +84,7 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. diff --git a/docs/platforms/kotlin-multiplatform/configuration/options.mdx b/docs/platforms/kotlin-multiplatform/configuration/options.mdx index 75f72c6305954..2fd2559a664ae 100644 --- a/docs/platforms/kotlin-multiplatform/configuration/options.mdx +++ b/docs/platforms/kotlin-multiplatform/configuration/options.mdx @@ -71,13 +71,13 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. -The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. +The maximum number of [envelopes](https://develop.sentry.dev/sdk/data-model/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. diff --git a/docs/platforms/kotlin-multiplatform/enriching-events/attachments/index.mdx b/docs/platforms/kotlin-multiplatform/enriching-events/attachments/index.mdx index 1901f78f1f427..3a5bd1b985808 100644 --- a/docs/platforms/kotlin-multiplatform/enriching-events/attachments/index.mdx +++ b/docs/platforms/kotlin-multiplatform/enriching-events/attachments/index.mdx @@ -7,7 +7,7 @@ Sentry can enrich your events for further investigation by storing additional fi ## Creating Attachments -The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. +The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/data-model/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. diff --git a/docs/platforms/native/common/configuration/options.mdx b/docs/platforms/native/common/configuration/options.mdx index 3447aa34801b8..83ccc15db16f7 100644 --- a/docs/platforms/native/common/configuration/options.mdx +++ b/docs/platforms/native/common/configuration/options.mdx @@ -59,7 +59,7 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. diff --git a/docs/platforms/php/common/configuration/options.mdx b/docs/platforms/php/common/configuration/options.mdx index 3fe0e5b4f4a52..43b3ecca05972 100644 --- a/docs/platforms/php/common/configuration/options.mdx +++ b/docs/platforms/php/common/configuration/options.mdx @@ -64,7 +64,7 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. diff --git a/docs/platforms/powershell/configuration/options.mdx b/docs/platforms/powershell/configuration/options.mdx index 8b090635631c0..2644cfe71b6a1 100644 --- a/docs/platforms/powershell/configuration/options.mdx +++ b/docs/platforms/powershell/configuration/options.mdx @@ -79,13 +79,13 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. -The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. +The maximum number of [envelopes](https://develop.sentry.dev/sdk/data-model/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. diff --git a/docs/platforms/powershell/enriching-events/attachments/index.mdx b/docs/platforms/powershell/enriching-events/attachments/index.mdx index 615c3c1692919..f7ff6acdf9ceb 100644 --- a/docs/platforms/powershell/enriching-events/attachments/index.mdx +++ b/docs/platforms/powershell/enriching-events/attachments/index.mdx @@ -7,7 +7,7 @@ Sentry can enrich your events for further investigation by storing additional fi ## Creating Attachments -The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. +The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/data-model/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. diff --git a/docs/platforms/python/configuration/options.mdx b/docs/platforms/python/configuration/options.mdx index 586863249fbfb..b52e6dda1f47f 100644 --- a/docs/platforms/python/configuration/options.mdx +++ b/docs/platforms/python/configuration/options.mdx @@ -79,7 +79,7 @@ If this configuration option is specified, the -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. diff --git a/docs/platforms/react-native/configuration/options.mdx b/docs/platforms/react-native/configuration/options.mdx index 5a0307d44c8a5..58f5593c3fc69 100644 --- a/docs/platforms/react-native/configuration/options.mdx +++ b/docs/platforms/react-native/configuration/options.mdx @@ -59,13 +59,13 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. -The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `maxCacheItems`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. +The maximum number of [envelopes](https://develop.sentry.dev/sdk/data-model/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `maxCacheItems`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. diff --git a/docs/platforms/react-native/migration/index.mdx b/docs/platforms/react-native/migration/index.mdx index 88fb0767a0b2e..ba64ddbc4f64e 100644 --- a/docs/platforms/react-native/migration/index.mdx +++ b/docs/platforms/react-native/migration/index.mdx @@ -237,7 +237,7 @@ class App extends React.Component { Sentry's most recent version of our React Native SDK enables release health tracking and native stack traces by default. -This version of the SDK uses the [envelope endpoint](https://develop.sentry.dev/sdk/envelopes/). If you are using self-hosted Sentry, the SDK requires Sentry version 20.6.0 and above. If you are using our SaaS product ([sentry.io](https://sentry.io)), no changes or actions needed. +This version of the SDK uses the [envelope endpoint](https://develop.sentry.dev/sdk/data-model/envelopes/). If you are using self-hosted Sentry, the SDK requires Sentry version 20.6.0 and above. If you are using our SaaS product ([sentry.io](https://sentry.io)), no changes or actions needed. ### iOS/MacOS diff --git a/docs/platforms/rust/common/configuration/options.mdx b/docs/platforms/rust/common/configuration/options.mdx index 7b2477e66ee8b..f613ac76a7c4f 100644 --- a/docs/platforms/rust/common/configuration/options.mdx +++ b/docs/platforms/rust/common/configuration/options.mdx @@ -53,7 +53,7 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. diff --git a/docs/platforms/unity/configuration/options.mdx b/docs/platforms/unity/configuration/options.mdx index 17f1fe66f8725..375c93d51e337 100644 --- a/docs/platforms/unity/configuration/options.mdx +++ b/docs/platforms/unity/configuration/options.mdx @@ -119,13 +119,13 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. -The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. +The maximum number of [envelopes](https://develop.sentry.dev/sdk/data-model/envelopes/) to keep in cache. The SDKs use envelopes to send data, such as events, attachments, user feedback, and sessions to sentry.io. An envelope can contain multiple items, such as an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. If the number of envelopes in the local cache exceeds `max-cache-items`, the SDK deletes the oldest envelope and migrates the sessions to the next envelope to maintain the integrity of your release health stats. The default is `30`. diff --git a/docs/platforms/unity/enriching-events/attachments/index.mdx b/docs/platforms/unity/enriching-events/attachments/index.mdx index 8d8c3f1f1ed23..45e854356c721 100644 --- a/docs/platforms/unity/enriching-events/attachments/index.mdx +++ b/docs/platforms/unity/enriching-events/attachments/index.mdx @@ -13,7 +13,7 @@ Sentry can enrich your events for further investigation by storing additional fi ## Creating Attachments -The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. +The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/data-model/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. diff --git a/docs/platforms/unreal/configuration/options.mdx b/docs/platforms/unreal/configuration/options.mdx index 1bb053f6296bf..9560ca21abbdb 100644 --- a/docs/platforms/unreal/configuration/options.mdx +++ b/docs/platforms/unreal/configuration/options.mdx @@ -53,7 +53,7 @@ Configures the sample rate for error events, in the range of `0.0` to `1.0`. The -This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/envelopes/#size-limits) and any events exceeding that payload size will be dropped. +This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped. diff --git a/docs/platforms/unreal/enriching-events/attachments/index.mdx b/docs/platforms/unreal/enriching-events/attachments/index.mdx index 265988424fbea..9fc82d844b7a7 100644 --- a/docs/platforms/unreal/enriching-events/attachments/index.mdx +++ b/docs/platforms/unreal/enriching-events/attachments/index.mdx @@ -13,7 +13,7 @@ Sentry can enrich your events for further investigation by storing additional fi ## Creating Attachments -The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. +The simplest way to create an attachment is to use a `path`. The SDK will read the contents of the file each time it prepares an event or transaction, then adds the attachment to the same [envelope](https://develop.sentry.dev/sdk/data-model/envelopes/). If the SDK can't read the file, the SDK logs an error message and drops the attachment. ```cpp #include "SentryAttachment.h" diff --git a/docs/product/stats/index.mdx b/docs/product/stats/index.mdx index 5ae9a6d3eddf5..91a2b497488f9 100644 --- a/docs/product/stats/index.mdx +++ b/docs/product/stats/index.mdx @@ -68,7 +68,7 @@ Events and attachments might be discarded if they don't match the expected forma - **Project Missing**: The specified Sentry project is disabled or project information in the submitted request was inconclusive. - **Sampling**: Tracing data that is discarded during sampling. - **Security Report**: An invalid or unsupported security report was submitted. If this report originates from an up-to-date browser, please report a bug to Sentry. See [Security Policy Reporting](/security-legal-pii/security/security-policy-reporting/) for more information. -- **Too Large**: The HTTP submission or its contained data exceeds size limits. See [this document](https://develop.sentry.dev/sdk/envelopes/#size-limits) for the precise limits. +- **Too Large**: The HTTP submission or its contained data exceeds size limits. See [this document](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) for the precise limits. - **Unreal**: An unsupported or invalid Unreal Engine crash report was submitted. If this request originates from a recent or development version of the Unreal Engine, please report a bug to Sentry. See [Unreal Engine](/platforms/unreal/) for more information. - **Internal**: An internal problem at Sentry prevented regular processing or storage of the submitted information. @@ -87,7 +87,7 @@ Events and attachments discarded by the SDK. The following reasons are currently - **Insufficient Data**: An event was dropped due to a lack of data in the event (for example, not enough samples in a profile). - **Backpressure**: An event was dropped due to downsampling caused by the system being under load. -For more details, please consult the [Client Reports](https://develop.sentry.dev/sdk/client-reports/#envelope-item-payload) documentation. +For more details, please consult the [Client Reports](https://develop.sentry.dev/sdk/telemetry/client-reports/#envelope-item-payload) documentation. ### Usage Cards From 9a6b0088792bfabf44fd4db2543b24ff18314ffb Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Fri, 11 Oct 2024 15:36:11 +0200 Subject: [PATCH 08/17] Fixed links to event-payloads --- .../application/transaction-clustering/index.mdx | 2 +- develop-docs/sdk/data-model/envelopes.mdx | 2 +- .../sdk/data-model/event-payloads/contexts.mdx | 4 ++-- .../sdk/data-model/event-payloads/debugmeta.mdx | 2 +- .../sdk/data-model/event-payloads/exception.mdx | 8 ++++---- .../sdk/data-model/event-payloads/lockreason.mdx | 2 +- .../event-payloads/properties/contexts_trace.mdx | 2 +- .../data-model/event-payloads/properties/spans.mdx | 2 +- .../data-model/event-payloads/replay-recording.mdx | 2 +- develop-docs/sdk/data-model/event-payloads/sdk.mdx | 2 +- develop-docs/sdk/data-model/event-payloads/span.mdx | 4 ++-- .../sdk/data-model/event-payloads/stacktrace.mdx | 6 +++--- .../sdk/data-model/event-payloads/threads.mdx | 12 ++++++------ .../sdk/data-model/event-payloads/transaction.mdx | 10 +++++----- develop-docs/sdk/data-model/event-payloads/user.mdx | 2 +- develop-docs/sdk/miscellaneous/store.mdx | 2 +- develop-docs/sdk/miscellaneous/unified-api/index.mdx | 2 +- develop-docs/sdk/research/performance/index.mdx | 2 +- develop-docs/sdk/telemetry/check-ins.mdx | 2 +- develop-docs/sdk/telemetry/metrics.mdx | 4 ++-- .../sdk/telemetry/profiles/sample-format-v1.mdx | 4 ++-- .../sdk/telemetry/profiles/sample-format-v2.mdx | 4 ++-- develop-docs/sdk/telemetry/replays.mdx | 6 +++--- .../telemetry/traces/dynamic-sampling-context.mdx | 2 +- develop-docs/sdk/telemetry/traces/index.mdx | 6 +++--- develop-docs/sdk/telemetry/traces/opentelemetry.mdx | 4 ++-- .../sdk/telemetry/traces/span-data-conventions.mdx | 2 +- develop-docs/sdk/telemetry/traces/trace-origin.mdx | 6 +++--- docs/cli/send-event.mdx | 2 +- .../concepts/search/searchable-properties/events.mdx | 4 ++-- .../concepts/search/searchable-properties/issues.mdx | 2 +- docs/platforms/android/configuration/filtering.mdx | 2 +- .../android/enriching-events/breadcrumbs/index.mdx | 2 +- .../android/enriching-events/context/index.mdx | 2 +- .../apple/common/configuration/filtering.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../apple/common/enriching-events/context/index.mdx | 2 +- docs/platforms/apple/common/migration/index.mdx | 2 +- docs/platforms/dart/configuration/filtering.mdx | 2 +- .../dart/enriching-events/breadcrumbs/index.mdx | 2 +- .../dart/enriching-events/context/index.mdx | 2 +- .../dotnet/common/configuration/filtering.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../dotnet/common/enriching-events/context/index.mdx | 2 +- docs/platforms/elixir/configuration/filtering.mdx | 2 +- .../elixir/enriching-events/breadcrumbs/index.mdx | 2 +- .../elixir/enriching-events/context/index.mdx | 2 +- docs/platforms/flutter/configuration/filtering.mdx | 2 +- .../flutter/enriching-events/breadcrumbs/index.mdx | 2 +- .../flutter/enriching-events/context/index.mdx | 2 +- docs/platforms/go/common/configuration/filtering.mdx | 2 +- .../go/common/enriching-events/breadcrumbs/index.mdx | 2 +- .../go/common/enriching-events/context/index.mdx | 2 +- .../java/common/configuration/filtering.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../java/common/enriching-events/context/index.mdx | 2 +- .../javascript/common/configuration/filtering.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../common/enriching-events/context/index.mdx | 2 +- .../javascript/common/troubleshooting/index.mdx | 2 +- .../kotlin-multiplatform/configuration/filtering.mdx | 2 +- .../enriching-events/breadcrumbs/index.mdx | 2 +- .../enriching-events/context/index.mdx | 2 +- .../native/common/configuration/filtering.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../native/common/enriching-events/context/index.mdx | 2 +- docs/platforms/native/guides/minidumps/index.mdx | 2 +- docs/platforms/native/guides/wasm/index.mdx | 2 +- .../platforms/php/common/configuration/filtering.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../php/common/enriching-events/context/index.mdx | 2 +- .../platforms/powershell/configuration/filtering.mdx | 2 +- .../enriching-events/breadcrumbs/index.mdx | 2 +- .../powershell/enriching-events/context/index.mdx | 2 +- .../python/configuration/filtering/index.mdx | 2 +- .../python/enriching-events/breadcrumbs/index.mdx | 2 +- .../python/enriching-events/context/index.mdx | 2 +- .../integrations/cloudresourcecontext/index.mdx | 2 +- docs/platforms/python/legacy-sdk/breadcrumbs.mdx | 2 +- .../react-native/configuration/filtering.mdx | 2 +- .../enriching-events/breadcrumbs/index.mdx | 2 +- .../react-native/enriching-events/context/index.mdx | 2 +- .../ruby/common/configuration/filtering.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../ruby/common/enriching-events/context/index.mdx | 2 +- .../rust/common/configuration/filtering.mdx | 2 +- .../common/enriching-events/breadcrumbs/index.mdx | 2 +- .../rust/common/enriching-events/context/index.mdx | 2 +- docs/platforms/unity/configuration/filtering.mdx | 2 +- .../unity/enriching-events/breadcrumbs/index.mdx | 2 +- .../unity/enriching-events/context/index.mdx | 2 +- docs/platforms/unreal/configuration/filtering.mdx | 2 +- .../configuration/setup-crashreporter/index.mdx | 2 +- .../unreal/enriching-events/breadcrumbs/index.mdx | 2 +- .../unreal/enriching-events/context/index.mdx | 2 +- .../issues/issue-details/breadcrumbs/index.mdx | 4 ++-- docs/product/performance/metrics.mdx | 2 +- platform-includes/capture-message/native.mdx | 2 +- platform-includes/capture-message/unreal.mdx | 2 +- .../breadcrumbs/automatic-breadcrumbs/dart.mdx | 2 +- redirects.js | 4 ++-- src/data/relay_metrics.json | 6 +++--- src/middleware.ts | 2 +- 103 files changed, 134 insertions(+), 134 deletions(-) diff --git a/develop-docs/application/transaction-clustering/index.mdx b/develop-docs/application/transaction-clustering/index.mdx index 9db9117236c96..4d0b75448429e 100644 --- a/develop-docs/application/transaction-clustering/index.mdx +++ b/develop-docs/application/transaction-clustering/index.mdx @@ -12,7 +12,7 @@ In terms of technical implementation, it is similar to [Data Scrubbing](/pii/). ## The Problem In our [Performance](https://docs.sentry.io/product/performance/) product, transactions are grouped by their name -(the [`event.transaction`](/sdk/event-payloads/#optional-attributes) field). +(the [`event.transaction`](/sdk/data-model/event-payloads/#optional-attributes) field). This works well as long as the cardinality of distinct transaction names that the SDK sends is low, for example by using the [route of a web framework](https://docs.sentry.io/platforms/javascript/guides/react/configuration/integrations/react-router/) as the transaction name. diff --git a/develop-docs/sdk/data-model/envelopes.mdx b/develop-docs/sdk/data-model/envelopes.mdx index f5bb88938d3d1..0897d5a3572da 100644 --- a/develop-docs/sdk/data-model/envelopes.mdx +++ b/develop-docs/sdk/data-model/envelopes.mdx @@ -125,7 +125,7 @@ Envelopes can have a number of headers which are valid in all situations: `sdk` -: *Object, recommended.* This can carry the same payload as the [`sdk` interface](/sdk/event-payloads/sdk/) +: *Object, recommended.* This can carry the same payload as the [`sdk` interface](/sdk/data-model/event-payloads/sdk/) in the event payload but can be carried for all events. This means that SDK information can be carried for minidumps, session data and other submissions. diff --git a/develop-docs/sdk/data-model/event-payloads/contexts.mdx b/develop-docs/sdk/data-model/event-payloads/contexts.mdx index 694df139efc08..08b194d71eabc 100644 --- a/develop-docs/sdk/data-model/event-payloads/contexts.mdx +++ b/develop-docs/sdk/data-model/event-payloads/contexts.mdx @@ -206,7 +206,7 @@ confusion about which OS context represents what. So here's some examples: the SDK (if at all). Additionally, the Sentry server will attempt to parse the `User-Agent` header - from the event's [Request Interface](/sdk/event-payloads/request/) and create a _secondary_ OS + from the event's [Request Interface](/sdk/data-model/event-payloads/request/) and create a _secondary_ OS context under the non-default key `"client_os"`. - In events reported from a JS web frontend, the SDK typically reports no OS @@ -598,7 +598,7 @@ The `type` and default key is `"cloud_resource"`. ### Example Cloud Resource Context -The following example illustrates the contexts part of the event payload and omits other attributes for simplicity. +The following example illustrates the contexts part of the event payload and omits other attributes for simplicity. ```json { diff --git a/develop-docs/sdk/data-model/event-payloads/debugmeta.mdx b/develop-docs/sdk/data-model/event-payloads/debugmeta.mdx index b322d0cf98f5d..804eb9a5f13cf 100644 --- a/develop-docs/sdk/data-model/event-payloads/debugmeta.mdx +++ b/develop-docs/sdk/data-model/event-payloads/debugmeta.mdx @@ -29,7 +29,7 @@ system symbols, and is not required for other SDKs. ## Debug Images The list of debug images contains all dynamic libraries loaded into the process -and their memory addresses. Instruction addresses in the [Stack Trace](/sdk/event-payloads/stacktrace/) are +and their memory addresses. Instruction addresses in the [Stack Trace](/sdk/data-model/event-payloads/stacktrace/) are mapped into the list of debug images in order to retrieve debug files for symbolication. diff --git a/develop-docs/sdk/data-model/event-payloads/exception.mdx b/develop-docs/sdk/data-model/event-payloads/exception.mdx index a383f9d09fba5..2f0d92e3a1dbe 100644 --- a/develop-docs/sdk/data-model/event-payloads/exception.mdx +++ b/develop-docs/sdk/data-model/event-payloads/exception.mdx @@ -5,7 +5,7 @@ sidebar_order: 2 The Exception Interface specifies an exception or error that occurred in a program. -An event may contain one or more exceptions in an attribute named `exception`. +An event may contain one or more exceptions in an attribute named `exception`. The `exception` attribute should be an object with the attribute `values` containing a list of one or more values that are objects in the format described @@ -41,7 +41,7 @@ description of `ValueError`. `thread_id` -: An optional value which refers to a thread in the [Thread Interface](/sdk/event-payloads/threads/). +: An optional value which refers to a thread in the [Thread Interface](/sdk/data-model/event-payloads/threads/). `mechanism` @@ -50,7 +50,7 @@ created this exception. `stacktrace` -: An optional stack trace object corresponding to the [Stack Trace Interface](/sdk/event-payloads/stacktrace/). +: An optional stack trace object corresponding to the [Stack Trace Interface](/sdk/data-model/event-payloads/stacktrace/). ## Exception Mechanism @@ -206,7 +206,7 @@ information. ## Examples The following examples illustrate multiple ways to send exceptions. Each example -contains the exception part of the event payload and omits other +contains the exception part of the event payload and omits other attributes for simplicity. A single exception: diff --git a/develop-docs/sdk/data-model/event-payloads/lockreason.mdx b/develop-docs/sdk/data-model/event-payloads/lockreason.mdx index 30253de5c835b..0a63e1f36101f 100644 --- a/develop-docs/sdk/data-model/event-payloads/lockreason.mdx +++ b/develop-docs/sdk/data-model/event-payloads/lockreason.mdx @@ -8,7 +8,7 @@ to determine which other thread is holding the lock in case the current thread i -Lock reasons are always part of a [thread](/sdk/event-payloads/threads/). They cannot be declared as a top-level event property. +Lock reasons are always part of a [thread](/sdk/data-model/event-payloads/threads/). They cannot be declared as a top-level event property. diff --git a/develop-docs/sdk/data-model/event-payloads/properties/contexts_trace.mdx b/develop-docs/sdk/data-model/event-payloads/properties/contexts_trace.mdx index 69cab7262377e..28144f6a6f2cc 100644 --- a/develop-docs/sdk/data-model/event-payloads/properties/contexts_trace.mdx +++ b/develop-docs/sdk/data-model/event-payloads/properties/contexts_trace.mdx @@ -1,6 +1,6 @@ `contexts.trace` -: _Recommended_. A Transaction has to have a specific `contexts.trace` entry that contains tracing information. See the [Trace Context documentation](/sdk/event-payloads/contexts/#trace-context). +: _Recommended_. A Transaction has to have a specific `contexts.trace` entry that contains tracing information. See the [Trace Context documentation](/sdk/data-model/event-payloads/contexts/#trace-context). ```json { diff --git a/develop-docs/sdk/data-model/event-payloads/properties/spans.mdx b/develop-docs/sdk/data-model/event-payloads/properties/spans.mdx index ea83d55fc6ffb..bc7cd56724749 100644 --- a/develop-docs/sdk/data-model/event-payloads/properties/spans.mdx +++ b/develop-docs/sdk/data-model/event-payloads/properties/spans.mdx @@ -1,6 +1,6 @@ `spans` -: _Recommended_. A list of [Spans](/sdk/event-payloads/span/). +: _Recommended_. A list of [Spans](/sdk/data-model/event-payloads/span/). ```json { diff --git a/develop-docs/sdk/data-model/event-payloads/replay-recording.mdx b/develop-docs/sdk/data-model/event-payloads/replay-recording.mdx index e827f137668a3..c8f720e58e781 100644 --- a/develop-docs/sdk/data-model/event-payloads/replay-recording.mdx +++ b/develop-docs/sdk/data-model/event-payloads/replay-recording.mdx @@ -76,7 +76,7 @@ The payload for `"options"` is a record of configuration name -> configuration v ### Breadcrumbs -Breadcrumbs are named as such because they are intercepted from the web SDK and forwarded as a custom recording event. They have the same structure as describe in breadcrumbs interface. +Breadcrumbs are named as such because they are intercepted from the web SDK and forwarded as a custom recording event. They have the same structure as describe in breadcrumbs interface. ```json { diff --git a/develop-docs/sdk/data-model/event-payloads/sdk.mdx b/develop-docs/sdk/data-model/event-payloads/sdk.mdx index 8957abf377e70..b27c4fb1f91bf 100644 --- a/develop-docs/sdk/data-model/event-payloads/sdk.mdx +++ b/develop-docs/sdk/data-model/event-payloads/sdk.mdx @@ -71,7 +71,7 @@ reference (branch, tag or SHA). ## Example -The following example illustrates the SDK part of the event payload and omits other +The following example illustrates the SDK part of the event payload and omits other attributes for simplicity. ```json diff --git a/develop-docs/sdk/data-model/event-payloads/span.mdx b/develop-docs/sdk/data-model/event-payloads/span.mdx index 118850edf1dce..5a10a4d94b9f1 100644 --- a/develop-docs/sdk/data-model/event-payloads/span.mdx +++ b/develop-docs/sdk/data-model/event-payloads/span.mdx @@ -4,7 +4,7 @@ title: Span Interface The Span Interface specifies a series of _timed_ application events that have a start and end time. -A [Transaction](/sdk/event-payloads/transaction/) may contain zero or more Spans in an array attribute named `spans`. Spans in the list don't have to be ordered, they will be ordered by start / end time on the Server. +A [Transaction](/sdk/data-model/event-payloads/transaction/) may contain zero or more Spans in an array attribute named `spans`. Spans in the list don't have to be ordered, they will be ordered by start / end time on the Server. While Span attributes will be normalized on the server, a Span is most useful when it includes at least an `op` and `description`. @@ -173,7 +173,7 @@ The semantic conventions for the `data` field are described in Event Payloads. +For a list of all supported attributes and interfaces in event payloads, see Event Payloads. ## HTTP Headers diff --git a/develop-docs/sdk/miscellaneous/unified-api/index.mdx b/develop-docs/sdk/miscellaneous/unified-api/index.mdx index 79cd86a42b37c..da70c217a42ff 100644 --- a/develop-docs/sdk/miscellaneous/unified-api/index.mdx +++ b/develop-docs/sdk/miscellaneous/unified-api/index.mdx @@ -66,7 +66,7 @@ meant that certain integrations (such as breadcrumbs) were often not possible. - **client options**: Are parameters that are language and runtime specific and used to configure the client. This can be release and environment but also things like which integrations to configure, how in-app works etc. -- **context**: Contexts give extra data to Sentry. There are the special contexts (user and similar) and the generic ones (`runtime`, `os`, `device`), etc. Check out Contexts for some predefined keys - users can also add arbitrary context keys. _Note: In older SDKs, you might encounter an unrelated concept of context, which is now deprecated by scopes_ +- **context**: Contexts give extra data to Sentry. There are the special contexts (user and similar) and the generic ones (`runtime`, `os`, `device`), etc. Check out Contexts for some predefined keys - users can also add arbitrary context keys. _Note: In older SDKs, you might encounter an unrelated concept of context, which is now deprecated by scopes_ - **tags**: Tags can be arbitrary string→string pairs by which events can be searched. Contexts are converted into tags. diff --git a/develop-docs/sdk/research/performance/index.mdx b/develop-docs/sdk/research/performance/index.mdx index dac32ce83536e..0d5ead3dc348c 100644 --- a/develop-docs/sdk/research/performance/index.mdx +++ b/develop-docs/sdk/research/performance/index.mdx @@ -14,7 +14,7 @@ After settling with an API, performance monitoring support was then expanded to Our initial implementation reused the mechanisms we had in place for error reporting: -- The [Event type](https://develop.sentry.dev/sdk/event-payloads/) was extended with new fields. That meant that instead of designing and implementing a whole new ingestion pipeline, we could save time and quickly start sending "events" to Sentry, this time, instead of errors, a new "transaction" event type. +- The [Event type](https://develop.sentry.dev/sdk/data-model/event-payloads/) was extended with new fields. That meant that instead of designing and implementing a whole new ingestion pipeline, we could save time and quickly start sending "events" to Sentry, this time, instead of errors, a new "transaction" event type. - Since we were just sending a new type of event, the SDK transport layer was also reused. - And since we were sharing the ingestion pipeline, that meant we were sharing storage and the many parts of the processing that happens to all events. diff --git a/develop-docs/sdk/telemetry/check-ins.mdx b/develop-docs/sdk/telemetry/check-ins.mdx index 94b2405ee5e92..68e9f4684f082 100644 --- a/develop-docs/sdk/telemetry/check-ins.mdx +++ b/develop-docs/sdk/telemetry/check-ins.mdx @@ -66,7 +66,7 @@ The following fields exist: `contexts` : _Object, optional_. A dictionary of contextual information about the environment running - the check-in. Right now we only support the [trace context](https://develop.sentry.dev/sdk/event-payloads/contexts/#trace-context) + the check-in. Right now we only support the [trace context](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/#trace-context) and use the `trace_id` in order to link check-ins to associated errors. ## Monitor upsert support diff --git a/develop-docs/sdk/telemetry/metrics.mdx b/develop-docs/sdk/telemetry/metrics.mdx index 5435265ebc2a4..e00e9e084d77a 100644 --- a/develop-docs/sdk/telemetry/metrics.mdx +++ b/develop-docs/sdk/telemetry/metrics.mdx @@ -347,7 +347,7 @@ sentry_sdk.init( Additionally SDKs are encouraged to capture location information once per metric. At metric emission time the system shall be collecting which code location emitted a metric and retain it. -For that the same format as for the [`frame`](/sdk/event-payloads/stacktrace/) on the stacktrace +For that the same format as for the [`frame`](/sdk/data-model/event-payloads/stacktrace/) on the stacktrace shall be used. `stacklevel` number of frames shall be ignored. The meta data is emitted in JSON as envelope item called `metric_meta`: @@ -366,7 +366,7 @@ The meta data is emitted in JSON as envelope item called `metric_meta`: Today only code mappings are supported. Each key is an encoded MRI (eg: `c:custom/foo@none`), each value in the mapping array has a key called `type` which today can only be `"location"`. All other -keys are the same format as the [`frame`](/sdk/event-payloads/stacktrace/) on the stacktrace. Today +keys are the same format as the [`frame`](/sdk/data-model/event-payloads/stacktrace/) on the stacktrace. Today SDKs should send code locations at least once a day, and they can round the timestamp. ## Reference Implementation diff --git a/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx b/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx index ee7910dbd5278..3a025526fb464 100644 --- a/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx +++ b/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx @@ -83,7 +83,7 @@ in the same envelope as the associated transaction. `debug_meta` -: *Object, required on native platforms.* This carries the same payload as the [`debug_meta` interface](/sdk/event-payloads/sdk/). +: *Object, required on native platforms.* This carries the same payload as the [`debug_meta` interface](/sdk/data-model/event-payloads/sdk/). It is required to have it for native platforms in order to symbolicate. For non-native platforms, you can omit this. `device` @@ -327,7 +327,7 @@ the same `stack_id` for each sample that needs it. `frames` -: *List, required*. Contains a list of frame objects (see [Frame Attributes](/sdk/event-payloads/stacktrace/#frame-attributes)). +: *List, required*. Contains a list of frame objects (see [Frame Attributes](/sdk/data-model/event-payloads/stacktrace/#frame-attributes)). Each object should contain at least a `filename`, `function` or `instruction_addr` attribute. All values are optional, but recommended. diff --git a/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx b/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx index bc7e25e156ca3..d6cf6e56823d7 100644 --- a/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx +++ b/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx @@ -64,7 +64,7 @@ The *Sample Format V2* is designed for use in continuous profiling. Therefore, a `debug_meta` -: *Object, required on native platforms.* This carries the same payload as the [`debug_meta` interface](/sdk/event-payloads/sdk/). +: *Object, required on native platforms.* This carries the same payload as the [`debug_meta` interface](/sdk/data-model/event-payloads/sdk/). It is required to have it for native platforms in order to symbolicate, otherwise you can omit it. For non-native platforms, you can omit this. @@ -224,7 +224,7 @@ the same `stack_id` for each sample that needs it. `frames` -: *List, required*. Contains a list of frame objects (see [Frame Attributes](/sdk/event-payloads/stacktrace/#frame-attributes)). +: *List, required*. Contains a list of frame objects (see [Frame Attributes](/sdk/data-model/event-payloads/stacktrace/#frame-attributes)). Each object should contain at least a `filename`, `function` or `instruction_addr` attribute. All values are optional, but recommended. diff --git a/develop-docs/sdk/telemetry/replays.mdx b/develop-docs/sdk/telemetry/replays.mdx index 23616f28d4bab..35152f7dda622 100644 --- a/develop-docs/sdk/telemetry/replays.mdx +++ b/develop-docs/sdk/telemetry/replays.mdx @@ -19,7 +19,7 @@ The following attributes are specific to the `"replay_event"` Item type. | Key | Type | Description | | ---------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | type | `"replay_event"` | Must be `"replay_event"` | -| replay_id | string | A unique ID for the replay. Follows the [same requirements](https://develop.sentry.dev/sdk/event-payloads/#required-attributes) as an `event_id`: Hexadecimal string representing a uuid4 value. The length is exactly 32 characters. Dashes are not allowed. Has to be lowercase. | +| replay_id | string | A unique ID for the replay. Follows the [same requirements](https://develop.sentry.dev/sdk/data-model/event-payloads/#required-attributes) as an `event_id`: Hexadecimal string representing a uuid4 value. The length is exactly 32 characters. Dashes are not allowed. Has to be lowercase. | | replay_type | `"session"` \| `"buffer"` | Describes the type of replay. `buffer` means the replay is buffered while waiting for an error to occur or until a manual flush. `session` means the replay starts recording immediately and continues through the lifespan of the replay session. | | segment_id | number | The segment id. | | replay_start_timestamp | number | UNIX timestamp of the start of the replay (in seconds). This is only required on the first segment. | @@ -29,7 +29,7 @@ The following attributes are specific to the `"replay_event"` Item type. ### Event Attributes -The following attributes are a subset of the [optional attributes](https://develop.sentry.dev/sdk/event-payloads/#optional-attributes) of an Event. +The following attributes are a subset of the [optional attributes](https://develop.sentry.dev/sdk/data-model/event-payloads/#optional-attributes) of an Event. | Key | Type | Description | | -------------------------- | ------ | ------------------------------------------------ | @@ -100,7 +100,7 @@ The `"replay_recording"` item consists of two sub-items that are delimited by ne {"segment_id": 0} ``` -The other sub-item is the replay recording's instructions set. This payload should be gzipped, but uncompressed payloads are also accepted. Read more about replay recording events here. +The other sub-item is the replay recording's instructions set. This payload should be gzipped, but uncompressed payloads are also accepted. Read more about replay recording events here. ```json [ diff --git a/develop-docs/sdk/telemetry/traces/dynamic-sampling-context.mdx b/develop-docs/sdk/telemetry/traces/dynamic-sampling-context.mdx index 3b97b67d926fd..50be047547c85 100644 --- a/develop-docs/sdk/telemetry/traces/dynamic-sampling-context.mdx +++ b/develop-docs/sdk/telemetry/traces/dynamic-sampling-context.mdx @@ -89,7 +89,7 @@ For that reason: **Only if a transaction name has good quality, it should be inc - `"/organization/:organizationId/user/:userId"` - `"UserListUIComponent"` -SDKs can leverage transaction annotations (in particular the `source` of the transaction name) to determine which transaction names have a good quality. +SDKs can leverage transaction annotations (in particular the `source` of the transaction name) to determine which transaction names have a good quality. diff --git a/develop-docs/sdk/telemetry/traces/index.mdx b/develop-docs/sdk/telemetry/traces/index.mdx index e1ee55b10f6b0..a9fc9d314d31a 100644 --- a/develop-docs/sdk/telemetry/traces/index.mdx +++ b/develop-docs/sdk/telemetry/traces/index.mdx @@ -94,14 +94,14 @@ Over the wire, transactions are serialized to JSON as an augmented `Event`, and In the Sentry UI, you can use Discover to look at all events regardless of type, and the Issues and Performance sections to dive into errors and transactions, respectively. The [user-facing tracing documentation](https://docs.sentry.io/product/performance/distributed-tracing/#traces-transactions-and-spans) explains more of the concepts on the product level. -The [Span](/sdk/event-payloads/span/) class stores each individual span in a +The [Span](/sdk/data-model/event-payloads/span/) class stores each individual span in a trace. -The [Transaction](/sdk/event-payloads/transaction/) class is like a span, with a +The [Transaction](/sdk/data-model/event-payloads/transaction/) class is like a span, with a few key differences: - Transactions have `name`, spans don't. -- Transactions must specify the [source](/sdk/event-payloads/transaction/#transaction-annotations) of its `name` to indicate how the transaction name was generated. +- Transactions must specify the [source](/sdk/data-model/event-payloads/transaction/#transaction-annotations) of its `name` to indicate how the transaction name was generated. - Calling the `finish` method on spans record the span's end timestamp. For transactions, the `finish` method additionally sends an event to Sentry. diff --git a/develop-docs/sdk/telemetry/traces/opentelemetry.mdx b/develop-docs/sdk/telemetry/traces/opentelemetry.mdx index fc3e9077fac57..acf2782be6ef7 100644 --- a/develop-docs/sdk/telemetry/traces/opentelemetry.mdx +++ b/develop-docs/sdk/telemetry/traces/opentelemetry.mdx @@ -400,7 +400,7 @@ function generateSentryErrorsFromOtelSpan(otelSpan) { ## Span Protocol -Below describe the transformations between an OpenTelemetry span and a Sentry Span. Related: [the interface for a Sentry Span](https://develop.sentry.dev/sdk/event-payloads/span/), [the Relay spec for a Sentry Span](https://github.com/getsentry/relay/blob/master/relay-event-schema/src/protocol/span.rs) and the spec for an [OpenTelemetry span](https://github.com/open-telemetry/opentelemetry-proto/blob/724e427879e3d2bae2edc0218fff06e37b9eb46e/opentelemetry/proto/trace/v1/trace.proto#L80-L256). +Below describe the transformations between an OpenTelemetry span and a Sentry Span. Related: [the interface for a Sentry Span](https://develop.sentry.dev/sdk/data-model/event-payloads/span/), [the Relay spec for a Sentry Span](https://github.com/getsentry/relay/blob/master/relay-event-schema/src/protocol/span.rs) and the spec for an [OpenTelemetry span](https://github.com/open-telemetry/opentelemetry-proto/blob/724e427879e3d2bae2edc0218fff06e37b9eb46e/opentelemetry/proto/trace/v1/trace.proto#L80-L256). This is based on a mapping done as part of work on the [OpenTelemetry Sentry Exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/sentryexporter/docs/transformation.md). @@ -432,7 +432,7 @@ import {Span as OtelSpan} from '@opentelemetry/sdk-trace-base'; import {SemanticAttributes} from '@opentelemetry/semantic-conventions'; import {SpanStatusType as SentryStatus} from '@sentry/tracing'; -// canonicalCodesHTTPMap maps some HTTP codes to Sentry's span statuses. See possible mapping in https://develop.sentry.dev/sdk/event-payloads/span/ +// canonicalCodesHTTPMap maps some HTTP codes to Sentry's span statuses. See possible mapping in https://develop.sentry.dev/sdk/data-model/event-payloads/span/ const canonicalCodesHTTPMap: Record = { '400': 'failed_precondition', '401': 'unauthenticated', diff --git a/develop-docs/sdk/telemetry/traces/span-data-conventions.mdx b/develop-docs/sdk/telemetry/traces/span-data-conventions.mdx index 9da3e3d6de8b3..18c39756a9f23 100644 --- a/develop-docs/sdk/telemetry/traces/span-data-conventions.mdx +++ b/develop-docs/sdk/telemetry/traces/span-data-conventions.mdx @@ -38,7 +38,7 @@ Below describes the conventions for the Span interface for the `data` field on t | Attribute | Type | Description | Examples | | --------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | | `blocked_main_thread` | boolean | Whether the main thread was blocked by the span. | `true` | -| `call_stack` | StackFrame[] | The most relevant stack frames, that lead to the File I/O span. The stack frame should adhere to the [`StackFrame`](https://develop.sentry.dev/sdk/event-payloads/stacktrace/#frame-attributes) interface. | | +| `call_stack` | StackFrame[] | The most relevant stack frames, that lead to the File I/O span. The stack frame should adhere to the [`StackFrame`](https://develop.sentry.dev/sdk/data-model/event-payloads/stacktrace/#frame-attributes) interface. | | | `url` | string | The URL of the resource that was fetched. | `https://example.com` | | `type` | string | More granular type of the operation happening. | `fetch` | | `frames.total` | int | The number of total frames rendered during the lifetime of the span. | `60` | diff --git a/develop-docs/sdk/telemetry/traces/trace-origin.mdx b/develop-docs/sdk/telemetry/traces/trace-origin.mdx index 246d8efaf70ad..8f3a8d79cf8f2 100644 --- a/develop-docs/sdk/telemetry/traces/trace-origin.mdx +++ b/develop-docs/sdk/telemetry/traces/trace-origin.mdx @@ -4,7 +4,7 @@ title: Trace Origin Trace origin indicates what created a trace or a span. Not all traces and spans contain enough information to tell whether the user or what precisely in the SDK created it. Origin solves this problem. Origin can be sent with -the trace context or spans. +the trace context or spans. The SDKs should set this value automatically. It is not expected to be set manually by users. The value for origin should rarely change so that we can run proper analytics on them. @@ -62,6 +62,6 @@ automatically creates a span. In this case we end up with the following origins: ## See also: -- Span Interface -- Trace Context +- Span Interface +- Trace Context - Related [RFC](https://github.com/getsentry/rfcs/pull/73/); diff --git a/docs/cli/send-event.mdx b/docs/cli/send-event.mdx index 18f7532dc0599..55c03fb4c209d 100644 --- a/docs/cli/send-event.mdx +++ b/docs/cli/send-event.mdx @@ -69,7 +69,7 @@ sentry-cli send-event -m "a failure" -t task:create-user ## Stored Events -As of version `1.71`, the `send-event` command can accept an optional argument that specifies a path to the stored JSON representation of an [event payload](https://develop.sentry.dev/sdk/event-payloads/). When used, it will load the file, validate the event and send it to Sentry. +As of version `1.71`, the `send-event` command can accept an optional argument that specifies a path to the stored JSON representation of an [event payload](https://develop.sentry.dev/sdk/data-model/event-payloads/). When used, it will load the file, validate the event and send it to Sentry. ```bash sentry-cli send-event ./events/20211029150006.json diff --git a/docs/concepts/search/searchable-properties/events.mdx b/docs/concepts/search/searchable-properties/events.mdx index adf048f77a385..d7b135432b624 100644 --- a/docs/concepts/search/searchable-properties/events.mdx +++ b/docs/concepts/search/searchable-properties/events.mdx @@ -282,7 +282,7 @@ Returns results with the defined tag or field, but not the value of that tag or ### `http.method` -HTTP method of the [request](https://develop.sentry.dev/sdk/event-payloads/request/) that created the event. +HTTP method of the [request](https://develop.sentry.dev/sdk/data-model/event-payloads/request/) that created the event. - **Type:** string @@ -691,7 +691,7 @@ Short code identifying the [type of operation](https://develop.sentry.dev/sdk/pe ### `transaction.status` -Describes the status of the span/transaction. Check out our [Transaction Payloads documentation](https://develop.sentry.dev/sdk/event-payloads/transaction/) for all possible statuses. +Describes the status of the span/transaction. Check out our [Transaction Payloads documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/transaction/) for all possible statuses. - **Type:** string diff --git a/docs/concepts/search/searchable-properties/issues.mdx b/docs/concepts/search/searchable-properties/issues.mdx index cbd54e5a25668..6e966fb56eda6 100644 --- a/docs/concepts/search/searchable-properties/issues.mdx +++ b/docs/concepts/search/searchable-properties/issues.mdx @@ -204,7 +204,7 @@ Returns results with the defined tag or field, but not the value of that tag or ### `http.method` -HTTP method of the [request](https://develop.sentry.dev/sdk/event-payloads/request/) that created the event. +HTTP method of the [request](https://develop.sentry.dev/sdk/data-model/event-payloads/request/) that created the event. - **Type:** string diff --git a/docs/platforms/android/configuration/filtering.mdx b/docs/platforms/android/configuration/filtering.mdx index 977ae6c7ecfbe..5b1245e5c7d0a 100644 --- a/docs/platforms/android/configuration/filtering.mdx +++ b/docs/platforms/android/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/android/enriching-events/breadcrumbs/index.mdx b/docs/platforms/android/enriching-events/breadcrumbs/index.mdx index d8b7898a30c04..65ee11d1ef2c9 100644 --- a/docs/platforms/android/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/android/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/android/enriching-events/context/index.mdx b/docs/platforms/android/enriching-events/context/index.mdx index 61320414b69b4..09c20b026d024 100644 --- a/docs/platforms/android/enriching-events/context/index.mdx +++ b/docs/platforms/android/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use and give the context a uniqu There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/apple/common/configuration/filtering.mdx b/docs/platforms/apple/common/configuration/filtering.mdx index 56d9d865560c5..f184ba21aa98c 100644 --- a/docs/platforms/apple/common/configuration/filtering.mdx +++ b/docs/platforms/apple/common/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/apple/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/apple/common/enriching-events/breadcrumbs/index.mdx index 6f639e5884947..6dc26dd026ee5 100644 --- a/docs/platforms/apple/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/apple/common/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/apple/common/enriching-events/context/index.mdx b/docs/platforms/apple/common/enriching-events/context/index.mdx index 61320414b69b4..09c20b026d024 100644 --- a/docs/platforms/apple/common/enriching-events/context/index.mdx +++ b/docs/platforms/apple/common/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use and give the context a uniqu There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/apple/common/migration/index.mdx b/docs/platforms/apple/common/migration/index.mdx index b1d692a8d19f4..188698b9e5c17 100644 --- a/docs/platforms/apple/common/migration/index.mdx +++ b/docs/platforms/apple/common/migration/index.mdx @@ -268,7 +268,7 @@ if (eventId != SentryId.empty) { #### New type SentryMessage for Event.message -In 6.x, we introduce a new type [SentryMessage](https://develop.sentry.dev/sdk/event-payloads/message/) for `event.message`. SentryMessage provides you the ability to pass a format string with parameters to Sentry, which can help group similar messages into the same issue. +In 6.x, we introduce a new type [SentryMessage](https://develop.sentry.dev/sdk/data-model/event-payloads/message/) for `event.message`. SentryMessage provides you the ability to pass a format string with parameters to Sentry, which can help group similar messages into the same issue. Example in 5.x: diff --git a/docs/platforms/dart/configuration/filtering.mdx b/docs/platforms/dart/configuration/filtering.mdx index 09d6639c0db06..cbfd6077f23ca 100644 --- a/docs/platforms/dart/configuration/filtering.mdx +++ b/docs/platforms/dart/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/dart/enriching-events/breadcrumbs/index.mdx b/docs/platforms/dart/enriching-events/breadcrumbs/index.mdx index d8b7898a30c04..65ee11d1ef2c9 100644 --- a/docs/platforms/dart/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/dart/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/dart/enriching-events/context/index.mdx b/docs/platforms/dart/enriching-events/context/index.mdx index 61320414b69b4..09c20b026d024 100644 --- a/docs/platforms/dart/enriching-events/context/index.mdx +++ b/docs/platforms/dart/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use and give the context a uniqu There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/dotnet/common/configuration/filtering.mdx b/docs/platforms/dotnet/common/configuration/filtering.mdx index b3b1758789699..ccfb6cdf672a6 100644 --- a/docs/platforms/dotnet/common/configuration/filtering.mdx +++ b/docs/platforms/dotnet/common/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx index 650ea0a71a031..e65703cd2ddbc 100644 --- a/docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/dotnet/common/enriching-events/context/index.mdx b/docs/platforms/dotnet/common/enriching-events/context/index.mdx index 9d32483354ae7..8d76fbed95867 100644 --- a/docs/platforms/dotnet/common/enriching-events/context/index.mdx +++ b/docs/platforms/dotnet/common/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use `Contexts` and give the context a unique name: There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/elixir/configuration/filtering.mdx b/docs/platforms/elixir/configuration/filtering.mdx index c65c4a4727121..d97ca31054711 100644 --- a/docs/platforms/elixir/configuration/filtering.mdx +++ b/docs/platforms/elixir/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/elixir/enriching-events/breadcrumbs/index.mdx b/docs/platforms/elixir/enriching-events/breadcrumbs/index.mdx index d9dfc5a43d08c..d09de40983e63 100644 --- a/docs/platforms/elixir/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/elixir/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/elixir/enriching-events/context/index.mdx b/docs/platforms/elixir/enriching-events/context/index.mdx index 36874af597a98..23f3d986bd134 100644 --- a/docs/platforms/elixir/enriching-events/context/index.mdx +++ b/docs/platforms/elixir/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use and give the context a There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/flutter/configuration/filtering.mdx b/docs/platforms/flutter/configuration/filtering.mdx index 90a18e020abf9..273e5a46e6bbb 100644 --- a/docs/platforms/flutter/configuration/filtering.mdx +++ b/docs/platforms/flutter/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/flutter/enriching-events/breadcrumbs/index.mdx b/docs/platforms/flutter/enriching-events/breadcrumbs/index.mdx index d8b7898a30c04..65ee11d1ef2c9 100644 --- a/docs/platforms/flutter/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/flutter/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/flutter/enriching-events/context/index.mdx b/docs/platforms/flutter/enriching-events/context/index.mdx index 61320414b69b4..09c20b026d024 100644 --- a/docs/platforms/flutter/enriching-events/context/index.mdx +++ b/docs/platforms/flutter/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use and give the context a uniqu There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/go/common/configuration/filtering.mdx b/docs/platforms/go/common/configuration/filtering.mdx index ead7332a9e65a..b16dff6ce0cfd 100644 --- a/docs/platforms/go/common/configuration/filtering.mdx +++ b/docs/platforms/go/common/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/go/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/go/common/enriching-events/breadcrumbs/index.mdx index d8b7898a30c04..65ee11d1ef2c9 100644 --- a/docs/platforms/go/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/go/common/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/go/common/enriching-events/context/index.mdx b/docs/platforms/go/common/enriching-events/context/index.mdx index 61320414b69b4..09c20b026d024 100644 --- a/docs/platforms/go/common/enriching-events/context/index.mdx +++ b/docs/platforms/go/common/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use and give the context a uniqu There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/java/common/configuration/filtering.mdx b/docs/platforms/java/common/configuration/filtering.mdx index 977ae6c7ecfbe..5b1245e5c7d0a 100644 --- a/docs/platforms/java/common/configuration/filtering.mdx +++ b/docs/platforms/java/common/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/java/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/java/common/enriching-events/breadcrumbs/index.mdx index d8b7898a30c04..65ee11d1ef2c9 100644 --- a/docs/platforms/java/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/java/common/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/java/common/enriching-events/context/index.mdx b/docs/platforms/java/common/enriching-events/context/index.mdx index 61320414b69b4..09c20b026d024 100644 --- a/docs/platforms/java/common/enriching-events/context/index.mdx +++ b/docs/platforms/java/common/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use and give the context a uniqu There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/javascript/common/configuration/filtering.mdx b/docs/platforms/javascript/common/configuration/filtering.mdx index b2962c1e8b9b7..51731aadb0547 100644 --- a/docs/platforms/javascript/common/configuration/filtering.mdx +++ b/docs/platforms/javascript/common/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err Sentry offers [Inbound Filters](/concepts/data-management/filtering/) that you can enable per project to filter out various events in sentry.io. You can use our pre-defined inbound filters (e.g. filtering known browser extensions), as well as add your own message-based filters. -However, we recommend filtering at the client-level, because it removes the overhead of sending events you don't actually want. The Sentry SDKs have several configuration options, which are described in this document, to help you filter out events. To learn more about the event fields you can use for filtering, see [Event Payloads](https://develop.sentry.dev/sdk/event-payloads/). +However, we recommend filtering at the client-level, because it removes the overhead of sending events you don't actually want. The Sentry SDKs have several configuration options, which are described in this document, to help you filter out events. To learn more about the event fields you can use for filtering, see [Event Payloads](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/javascript/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/javascript/common/enriching-events/breadcrumbs/index.mdx index b6abd525bc0b5..2c84f0ffac7db 100644 --- a/docs/platforms/javascript/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/javascript/common/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/javascript/common/enriching-events/context/index.mdx b/docs/platforms/javascript/common/enriching-events/context/index.mdx index d7570a38a8956..9939b696e6714 100644 --- a/docs/platforms/javascript/common/enriching-events/context/index.mdx +++ b/docs/platforms/javascript/common/enriching-events/context/index.mdx @@ -29,7 +29,7 @@ There are no restrictions on context name. In the context object, all keys are a By default, Sentry SDKs normalize nested structured context data up to three levels deep. Any data beyond this depth will be trimmed and marked using its type instead. To adjust this default, use the `normalizeDepth` SDK option. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/javascript/common/troubleshooting/index.mdx b/docs/platforms/javascript/common/troubleshooting/index.mdx index ba785b6e612ae..68ee3a0d753a6 100644 --- a/docs/platforms/javascript/common/troubleshooting/index.mdx +++ b/docs/platforms/javascript/common/troubleshooting/index.mdx @@ -20,7 +20,7 @@ You can view the JSON payload of an event to see how Sentry stores additional da ![Red box highlighting where to find the JSON connected to an event](./img/event_JSON.png) -For more details, see the [full documentation on Event Payload](https://develop.sentry.dev/sdk/event-payloads/). +For more details, see the [full documentation on Event Payload](https://develop.sentry.dev/sdk/data-model/event-payloads/). diff --git a/docs/platforms/kotlin-multiplatform/configuration/filtering.mdx b/docs/platforms/kotlin-multiplatform/configuration/filtering.mdx index c65c4a4727121..d97ca31054711 100644 --- a/docs/platforms/kotlin-multiplatform/configuration/filtering.mdx +++ b/docs/platforms/kotlin-multiplatform/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/kotlin-multiplatform/enriching-events/breadcrumbs/index.mdx b/docs/platforms/kotlin-multiplatform/enriching-events/breadcrumbs/index.mdx index 650ea0a71a031..e65703cd2ddbc 100644 --- a/docs/platforms/kotlin-multiplatform/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/kotlin-multiplatform/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/kotlin-multiplatform/enriching-events/context/index.mdx b/docs/platforms/kotlin-multiplatform/enriching-events/context/index.mdx index 61320414b69b4..09c20b026d024 100644 --- a/docs/platforms/kotlin-multiplatform/enriching-events/context/index.mdx +++ b/docs/platforms/kotlin-multiplatform/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use and give the context a uniqu There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/native/common/configuration/filtering.mdx b/docs/platforms/native/common/configuration/filtering.mdx index 7dcdeffb4b4af..9aad5bb7d8995 100644 --- a/docs/platforms/native/common/configuration/filtering.mdx +++ b/docs/platforms/native/common/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/native/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/native/common/enriching-events/breadcrumbs/index.mdx index e05af5cf1abb3..e5e5824ec1ccc 100644 --- a/docs/platforms/native/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/native/common/enriching-events/breadcrumbs/index.mdx @@ -14,7 +14,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/native/common/enriching-events/context/index.mdx b/docs/platforms/native/common/enriching-events/context/index.mdx index f7fcbef64abc8..7bfa1202f0053 100644 --- a/docs/platforms/native/common/enriching-events/context/index.mdx +++ b/docs/platforms/native/common/enriching-events/context/index.mdx @@ -28,7 +28,7 @@ Then, use and give the context a uniqu There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/native/guides/minidumps/index.mdx b/docs/platforms/native/guides/minidumps/index.mdx index 183a17abb12eb..84a477ae45253 100644 --- a/docs/platforms/native/guides/minidumps/index.mdx +++ b/docs/platforms/native/guides/minidumps/index.mdx @@ -108,7 +108,7 @@ curl -X POST \ -F 'sentry[tags][mytag]=value' ``` -For the full list of supported values, see [_Event Payloads_](https://develop.sentry.dev/sdk/event-payloads/) and linked +For the full list of supported values, see [_Event Payloads_](https://develop.sentry.dev/sdk/data-model/event-payloads/) and linked documents. If your minidump's size exceeds the [limits](#size-limits) in the next section, you can compress it using `gzip`, `zstd`, `bzip2` or `xz` and refer the `upload_file_minidump` to the compressed file instead of the plain minidump. diff --git a/docs/platforms/native/guides/wasm/index.mdx b/docs/platforms/native/guides/wasm/index.mdx index 335138e311540..c131dea4da29e 100644 --- a/docs/platforms/native/guides/wasm/index.mdx +++ b/docs/platforms/native/guides/wasm/index.mdx @@ -89,7 +89,7 @@ async function loadWasm(url) { It's likely that if you're working with WebAssembly, you want to send custom crash reports; for example, if you don't execute WebAssembly in a browser, but in your own runtime. In that case, you can follow the general protocol documentation which -also covers how to describe WebAssembly frames: [stack trace interface](https://develop.sentry.dev/sdk/event-payloads/stacktrace/). +also covers how to describe WebAssembly frames: [stack trace interface](https://develop.sentry.dev/sdk/data-model/event-payloads/stacktrace/). Here is an example event for WebAssembly: diff --git a/docs/platforms/php/common/configuration/filtering.mdx b/docs/platforms/php/common/configuration/filtering.mdx index fc3e35a5f774b..28659183bbad0 100644 --- a/docs/platforms/php/common/configuration/filtering.mdx +++ b/docs/platforms/php/common/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx index 91ecb1c6999cc..77705a3b49b90 100644 --- a/docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/php/common/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/php/common/enriching-events/context/index.mdx b/docs/platforms/php/common/enriching-events/context/index.mdx index 61320414b69b4..09c20b026d024 100644 --- a/docs/platforms/php/common/enriching-events/context/index.mdx +++ b/docs/platforms/php/common/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use and give the context a uniqu There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/powershell/configuration/filtering.mdx b/docs/platforms/powershell/configuration/filtering.mdx index 5bc5a0d92e43c..5f7e82455996e 100644 --- a/docs/platforms/powershell/configuration/filtering.mdx +++ b/docs/platforms/powershell/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/powershell/enriching-events/breadcrumbs/index.mdx b/docs/platforms/powershell/enriching-events/breadcrumbs/index.mdx index dc56402c268f5..032b4b2fafdb0 100644 --- a/docs/platforms/powershell/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/powershell/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/powershell/enriching-events/context/index.mdx b/docs/platforms/powershell/enriching-events/context/index.mdx index 9d32483354ae7..8d76fbed95867 100644 --- a/docs/platforms/powershell/enriching-events/context/index.mdx +++ b/docs/platforms/powershell/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use `Contexts` and give the context a unique name: There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/python/configuration/filtering/index.mdx b/docs/platforms/python/configuration/filtering/index.mdx index 0519794255417..bc86e00577009 100644 --- a/docs/platforms/python/configuration/filtering/index.mdx +++ b/docs/platforms/python/configuration/filtering/index.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/python/enriching-events/breadcrumbs/index.mdx b/docs/platforms/python/enriching-events/breadcrumbs/index.mdx index 91ecb1c6999cc..77705a3b49b90 100644 --- a/docs/platforms/python/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/python/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/python/enriching-events/context/index.mdx b/docs/platforms/python/enriching-events/context/index.mdx index 61320414b69b4..09c20b026d024 100644 --- a/docs/platforms/python/enriching-events/context/index.mdx +++ b/docs/platforms/python/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use and give the context a uniqu There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/python/integrations/cloudresourcecontext/index.mdx b/docs/platforms/python/integrations/cloudresourcecontext/index.mdx index afeea531557d8..e22c460339d81 100644 --- a/docs/platforms/python/integrations/cloudresourcecontext/index.mdx +++ b/docs/platforms/python/integrations/cloudresourcecontext/index.mdx @@ -56,7 +56,7 @@ Trigger an error in the code running in your cloud and see the error and perform ## Behavior When the SDK starts up, information from the cloud provider the app is running in is retrieved and added to all error and performance events sent to Sentry. -The [developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/#runtime-context) lists all the information that's being added. +The [developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/#runtime-context) lists all the information that's being added. In AWS EC2 the context looks like this: diff --git a/docs/platforms/python/legacy-sdk/breadcrumbs.mdx b/docs/platforms/python/legacy-sdk/breadcrumbs.mdx index 2c8c513195461..a9e91b7092345 100644 --- a/docs/platforms/python/legacy-sdk/breadcrumbs.mdx +++ b/docs/platforms/python/legacy-sdk/breadcrumbs.mdx @@ -71,7 +71,7 @@ If you want to manually record breadcrumbs the most convenient way to do that is `raven.breadcrumbs.record(**options)` -This function accepts keyword arguments matching the attributes of a breadcrumb. For more information see [_Event Payloads_](https://develop.sentry.dev/sdk/event-payloads/). Additionally, a _processor_ callback can be passed which will be invoked to process the data if the crumb was not rejected. +This function accepts keyword arguments matching the attributes of a breadcrumb. For more information see [_Event Payloads_](https://develop.sentry.dev/sdk/data-model/event-payloads/). Additionally, a _processor_ callback can be passed which will be invoked to process the data if the crumb was not rejected. The most important parameters: diff --git a/docs/platforms/react-native/configuration/filtering.mdx b/docs/platforms/react-native/configuration/filtering.mdx index 4024bfa1b783c..e2c55b640355b 100644 --- a/docs/platforms/react-native/configuration/filtering.mdx +++ b/docs/platforms/react-native/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/react-native/enriching-events/breadcrumbs/index.mdx b/docs/platforms/react-native/enriching-events/breadcrumbs/index.mdx index b6abd525bc0b5..2c84f0ffac7db 100644 --- a/docs/platforms/react-native/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/react-native/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/react-native/enriching-events/context/index.mdx b/docs/platforms/react-native/enriching-events/context/index.mdx index cb533c9061010..3c6245fd95693 100644 --- a/docs/platforms/react-native/enriching-events/context/index.mdx +++ b/docs/platforms/react-native/enriching-events/context/index.mdx @@ -29,7 +29,7 @@ There are no restrictions on context name. In the context object, all keys are a By default, Sentry SDKs normalize nested structured context data up to three levels deep. Any data beyond this depth will be trimmed and marked using its type instead. To adjust this default, use the `normalizeDepth` SDK option. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/ruby/common/configuration/filtering.mdx b/docs/platforms/ruby/common/configuration/filtering.mdx index 13dfd61459c55..e88a6e7326865 100644 --- a/docs/platforms/ruby/common/configuration/filtering.mdx +++ b/docs/platforms/ruby/common/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/ruby/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/ruby/common/enriching-events/breadcrumbs/index.mdx index 91ecb1c6999cc..77705a3b49b90 100644 --- a/docs/platforms/ruby/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/ruby/common/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/ruby/common/enriching-events/context/index.mdx b/docs/platforms/ruby/common/enriching-events/context/index.mdx index 61320414b69b4..09c20b026d024 100644 --- a/docs/platforms/ruby/common/enriching-events/context/index.mdx +++ b/docs/platforms/ruby/common/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use and give the context a uniqu There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/rust/common/configuration/filtering.mdx b/docs/platforms/rust/common/configuration/filtering.mdx index 36a4da0f0e183..433d3be7e89d0 100644 --- a/docs/platforms/rust/common/configuration/filtering.mdx +++ b/docs/platforms/rust/common/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/rust/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/rust/common/enriching-events/breadcrumbs/index.mdx index affa1cdc9eb8e..04082cdb3efd9 100644 --- a/docs/platforms/rust/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/rust/common/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/rust/common/enriching-events/context/index.mdx b/docs/platforms/rust/common/enriching-events/context/index.mdx index 61320414b69b4..09c20b026d024 100644 --- a/docs/platforms/rust/common/enriching-events/context/index.mdx +++ b/docs/platforms/rust/common/enriching-events/context/index.mdx @@ -23,7 +23,7 @@ Then, use and give the context a uniqu There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/unity/configuration/filtering.mdx b/docs/platforms/unity/configuration/filtering.mdx index 574096acc027d..a192c3c5e5a86 100644 --- a/docs/platforms/unity/configuration/filtering.mdx +++ b/docs/platforms/unity/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/unity/enriching-events/breadcrumbs/index.mdx b/docs/platforms/unity/enriching-events/breadcrumbs/index.mdx index 650ea0a71a031..e65703cd2ddbc 100644 --- a/docs/platforms/unity/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/unity/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/unity/enriching-events/context/index.mdx b/docs/platforms/unity/enriching-events/context/index.mdx index 076308cfc121d..6b0957ab985b4 100644 --- a/docs/platforms/unity/enriching-events/context/index.mdx +++ b/docs/platforms/unity/enriching-events/context/index.mdx @@ -29,7 +29,7 @@ The class must be serializable and only properties are included; fields are not. There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/platforms/unreal/configuration/filtering.mdx b/docs/platforms/unreal/configuration/filtering.mdx index c65c4a4727121..d97ca31054711 100644 --- a/docs/platforms/unreal/configuration/filtering.mdx +++ b/docs/platforms/unreal/configuration/filtering.mdx @@ -8,7 +8,7 @@ When you add Sentry to your app, you get a lot of valuable information about err The Sentry SDKs have several configuration options to help you filter out events. -We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/event-payloads/). +We also offer [Inbound Filters](/concepts/data-management/filtering/) to filter events in sentry.io. We recommend filtering at the client level though, because it removes the overhead of sending events you don't actually want. Learn more about the [fields available in an event](https://develop.sentry.dev/sdk/data-model/event-payloads/). ## Filtering Error Events diff --git a/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx b/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx index 6a7d4f52831c9..b46deae0c5445 100644 --- a/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx +++ b/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx @@ -123,7 +123,7 @@ void ConfigureCrashReporter() ``` You need to call the `ConfigureCrashReporter` some time after your game -starts. Any [event attribute](https://develop.sentry.dev/sdk/event-payloads/) can be set. +starts. Any [event attribute](https://develop.sentry.dev/sdk/data-model/event-payloads/) can be set. diff --git a/docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx b/docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx index d354f42708562..9ffe4d3d05fc0 100644 --- a/docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx @@ -9,7 +9,7 @@ This page provides an overview of manual breadcrumb recording and customization. -Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/platforms/unreal/enriching-events/context/index.mdx b/docs/platforms/unreal/enriching-events/context/index.mdx index 94e73902ac0b3..b2bd3f677e398 100644 --- a/docs/platforms/unreal/enriching-events/context/index.mdx +++ b/docs/platforms/unreal/enriching-events/context/index.mdx @@ -43,7 +43,7 @@ Sentry's SDK automatically attaches certain context values such as `Engine versi There are no restrictions on context name. In the context object, all keys are allowed except for `type`, which is used internally. -Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/contexts/). +Learn more about conventions for common contexts in the [contexts interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/). ## Size Limitations diff --git a/docs/product/issues/issue-details/breadcrumbs/index.mdx b/docs/product/issues/issue-details/breadcrumbs/index.mdx index 5077af9adddb2..00d42f2dae99f 100644 --- a/docs/product/issues/issue-details/breadcrumbs/index.mdx +++ b/docs/product/issues/issue-details/breadcrumbs/index.mdx @@ -29,7 +29,7 @@ Here are all the ways you can narrow down what you see: Each breadcrumb is composed of the following: -- **Type**: `type` is a semi-internal attribute that controls how breadcrumbs are categorized. If left unchanged, all breadcrumbs are recorded as `default`, but Sentry provides other [types](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#breadcrumb-types) that each have their own color/icon in the UI. +- **Type**: `type` is a semi-internal attribute that controls how breadcrumbs are categorized. If left unchanged, all breadcrumbs are recorded as `default`, but Sentry provides other [types](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/#breadcrumb-types) that each have their own color/icon in the UI. - **Category**: The event category. This data is similar to a logger name and helps you understand where an event took place, such as `auth`. @@ -42,4 +42,4 @@ Each breadcrumb is composed of the following: - **Time**: A timestamp showing when the breadcrumb occurred. The format is either a string, as defined in [RFC 3339](https://tools.ietf.org/html/rfc3339), or a numeric value representing the number of seconds that have elapsed since the Unix epoch. -Learn more detailed information about breadcrumb data in the [Breadcrumbs Interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/). +Learn more detailed information about breadcrumb data in the [Breadcrumbs Interface developer documentation](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/). diff --git a/docs/product/performance/metrics.mdx b/docs/product/performance/metrics.mdx index 11f193382b2bc..2490c0ecf859a 100644 --- a/docs/product/performance/metrics.mdx +++ b/docs/product/performance/metrics.mdx @@ -22,7 +22,7 @@ Configure what a satisfactory response time threshold (ms) is for Apdex in **Set ## Failure Rate -`failure_rate()` indicates the percentage of unsuccessful transactions. Sentry treats transactions with a status other than “ok,” “cancelled,” and “unknown” as failures. For more details, see a [list of possible status values](https://develop.sentry.dev/sdk/event-payloads/span/). +`failure_rate()` indicates the percentage of unsuccessful transactions. Sentry treats transactions with a status other than “ok,” “cancelled,” and “unknown” as failures. For more details, see a [list of possible status values](https://develop.sentry.dev/sdk/data-model/event-payloads/span/). ## Throughput (Total, TPM, TPS) diff --git a/platform-includes/capture-message/native.mdx b/platform-includes/capture-message/native.mdx index b715586c42349..b09c560aa43a5 100644 --- a/platform-includes/capture-message/native.mdx +++ b/platform-includes/capture-message/native.mdx @@ -37,4 +37,4 @@ sentry_value_set_by_key(event, "contexts", contexts); sentry_capture_event(event); ``` -For the full list of supported values, see [_Event Payloads_](https://develop.sentry.dev/sdk/event-payloads/) and linked documents. +For the full list of supported values, see [_Event Payloads_](https://develop.sentry.dev/sdk/data-model/event-payloads/) and linked documents. diff --git a/platform-includes/capture-message/unreal.mdx b/platform-includes/capture-message/unreal.mdx index b7ac24fc23296..e45126e4a1728 100644 --- a/platform-includes/capture-message/unreal.mdx +++ b/platform-includes/capture-message/unreal.mdx @@ -86,4 +86,4 @@ Scoped events capturing is supported only on macOS, iOS and Android platforms. -For the full list of supported values, check out [_Event Payloads_](https://develop.sentry.dev/sdk/event-payloads/) and linked documents. +For the full list of supported values, check out [_Event Payloads_](https://develop.sentry.dev/sdk/data-model/event-payloads/) and linked documents. diff --git a/platform-includes/enriching-events/breadcrumbs/automatic-breadcrumbs/dart.mdx b/platform-includes/enriching-events/breadcrumbs/automatic-breadcrumbs/dart.mdx index ac3b4dd39cf50..f90e347ea9268 100644 --- a/platform-includes/enriching-events/breadcrumbs/automatic-breadcrumbs/dart.mdx +++ b/platform-includes/enriching-events/breadcrumbs/automatic-breadcrumbs/dart.mdx @@ -1,4 +1,4 @@ -To track automatic [Breadcrumbs for HTTP requests](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#breadcrumb-types), you can add a Sentry wrapper that does it automatically for you. +To track automatic [Breadcrumbs for HTTP requests](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/#breadcrumb-types), you can add a Sentry wrapper that does it automatically for you. This is only possible if you are using the [http.Client](https://pub.dev/documentation/http/latest/http/Client-class.html) class from the [http](https://pub.dev/packages/http) library. diff --git a/redirects.js b/redirects.js index 7f077aeedc2d1..7b4617424b005 100644 --- a/redirects.js +++ b/redirects.js @@ -27,8 +27,8 @@ const developerDocsRedirects = [ destination: '/sdk/telemetry/traces/:path*', }, { - source: '/sdk/event-payloads/types/', - destination: '/sdk/event-payloads/', + source: '/sdk/data-model/event-payloads/types/', + destination: '/sdk/data-model/event-payloads/', }, ]; diff --git a/src/data/relay_metrics.json b/src/data/relay_metrics.json index 4470730c1b0ed..e6ff2a25a79ad 100644 --- a/src/data/relay_metrics.json +++ b/src/data/relay_metrics.json @@ -230,13 +230,13 @@ { "type": "Counter", "name": "event.transaction", - "description": "The number of transaction events processed by the source of the transaction name.\n\nThis metric is tagged with:\n- `platform`: The event's platform, such as `\"javascript\"`.\n- `source`: The source of the transaction name on the client. See the [transaction source\ndocumentation](https://develop.sentry.dev/sdk/event-payloads/properties/transaction_info/)\nfor all valid values.\n- `contains_slashes`: Whether the transaction name contains `/`. We use this as a heuristic\nto represent URL transactions.", + "description": "The number of transaction events processed by the source of the transaction name.\n\nThis metric is tagged with:\n- `platform`: The event's platform, such as `\"javascript\"`.\n- `source`: The source of the transaction name on the client. See the [transaction source\ndocumentation](https://develop.sentry.dev/sdk/data-model/event-payloads/properties/transaction_info/)\nfor all valid values.\n- `contains_slashes`: Whether the transaction name contains `/`. We use this as a heuristic\nto represent URL transactions.", "features": [] }, { "type": "Counter", "name": "event.transaction_name_changes", - "description": "The number of transaction events processed grouped by transaction name modifications.\nThis metric is tagged with:\n- `source_in`: The source of the transaction name before normalization.\nSee the [transaction source\ndocumentation](https://develop.sentry.dev/sdk/event-payloads/properties/transaction_info/)\nfor all valid values.\n- `change`: The mechanism that changed the transaction name.\nEither `\"none\"`, `\"pattern\"`, `\"rule\"`, or `\"both\"`.\n- `source_out`: The source of the transaction name after normalization.", + "description": "The number of transaction events processed grouped by transaction name modifications.\nThis metric is tagged with:\n- `source_in`: The source of the transaction name before normalization.\nSee the [transaction source\ndocumentation](https://develop.sentry.dev/sdk/data-model/event-payloads/properties/transaction_info/)\nfor all valid values.\n- `change`: The mechanism that changed the transaction name.\nEither `\"none\"`, `\"pattern\"`, `\"rule\"`, or `\"both\"`.\n- `source_out`: The source of the transaction name after normalization.", "features": [] }, { @@ -947,4 +947,4 @@ "description": "Counts the number of retries for each upstream http request.\n\nThis metric is tagged with:\n\n- `result`: What happened to the request, an enumeration with the following values:\n* `success`: The request was sent and returned a success code `HTTP 2xx`\n* `response_error`: The request was sent and it returned an HTTP error.\n* `payload_failed`: The request was sent but there was an error in interpreting the response.\n* `send_failed`: Failed to send the request due to a network error.\n* `rate_limited`: The request was rate limited.\n* `invalid_json`: The response could not be parsed back into JSON.\n- `route`: The endpoint that was called on the upstream.\n- `status-code`: The status code of the request when available, otherwise \"-\".", "features": [] } -] \ No newline at end of file +] diff --git a/src/middleware.ts b/src/middleware.ts index 1edcb9ed0f42d..a9e5426bbea37 100644 --- a/src/middleware.ts +++ b/src/middleware.ts @@ -2715,7 +2715,7 @@ const USER_DOCS_REDIRECTS: Redirect[] = [ }, { from: '/clientdev/interfaces/http/', - to: 'https://develop.sentry.dev/sdk/event-payloads/request', + to: 'https://develop.sentry.dev/sdk/data-model/event-payloads/request', }, { from: '/clients/csharp/', From 1487c7bd4ffb1057732e739c9b06b46cbf93898f Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Fri, 11 Oct 2024 15:38:32 +0200 Subject: [PATCH 09/17] Fixed more links --- develop-docs/sdk/data-model/envelope-items.mdx | 10 +++++----- develop-docs/sdk/expected-features/data-handling.mdx | 4 ++-- .../sdk/miscellaneous/hub_and_scope_refactoring.mdx | 4 ++-- develop-docs/sdk/miscellaneous/unified-api/index.mdx | 2 +- develop-docs/sdk/research/performance/index.mdx | 4 ++-- develop-docs/sdk/serverless-sdks/index.mdx | 2 +- develop-docs/sdk/telemetry/client-reports.mdx | 2 +- develop-docs/sdk/telemetry/sessions/index.mdx | 2 +- docs/concepts/data-management/size-limits.mdx | 2 +- docs/platforms/android/migration/index.mdx | 2 +- docs/platforms/apple/common/migration/index.mdx | 4 ++-- docs/platforms/java/migration/1.x-to-4.x.mdx | 2 +- redirects.js | 2 +- 13 files changed, 21 insertions(+), 21 deletions(-) diff --git a/develop-docs/sdk/data-model/envelope-items.mdx b/develop-docs/sdk/data-model/envelope-items.mdx index 39af5beb3de2f..7e3cfb6593ce4 100644 --- a/develop-docs/sdk/data-model/envelope-items.mdx +++ b/develop-docs/sdk/data-model/envelope-items.mdx @@ -7,7 +7,7 @@ Each Envelope consists of headers and a potentially empty list of Items, each with their own headers. Which Headers are required depends on the Items in an Envelope. This section describes all Item types and their respective required headers. It is worth noting that the list of Item types doesn't match the data -categories used for [rate limiting](/sdk/rate-limiting/#definitions) and +categories used for [rate limiting](/sdk/expected-features/rate-limiting/#definitions) and client reports. The type of an Item is declared in the `type` header, as well as the payload @@ -118,7 +118,7 @@ file. It is always associated to an event or transaction. Item type `"session"` contains a single session initialization or update to an existing session for Release Health. -See the sessions documentation for the payload +See the sessions documentation for the payload details. **Constraints:** @@ -134,7 +134,7 @@ details. Item type `"sessions"` contains buckets of pre-aggregated session counts. -See the sessions documentation for the payload +See the sessions documentation for the payload details. **Constraints:** @@ -246,7 +246,7 @@ details. Item type `"replay_event"` contains a replay payload encoded in JSON. -See the replays documentation for the payload +See the replays documentation for the payload details. **Constraints:** @@ -266,7 +266,7 @@ details. Item type `"replay_recording"` contains a replay recording payload encoded in JSON *or* a gzipped JSON. -See the replays documentation for the payload +See the replays documentation for the payload details. **Constraints:** diff --git a/develop-docs/sdk/expected-features/data-handling.mdx b/develop-docs/sdk/expected-features/data-handling.mdx index 309e5b64d3924..3913282c8840e 100644 --- a/develop-docs/sdk/expected-features/data-handling.mdx +++ b/develop-docs/sdk/expected-features/data-handling.mdx @@ -31,7 +31,7 @@ All other platforms require the event to include `user.ip={{auto}}` which happen Before sending events to Sentry, the SDKs should invokes callbacks. That allows users to remove any sensitive data client-side. -- [`before-send` and `event-processors`](https://develop.sentry.dev/sdk/unified-api/#static-api) can be used to register a callback with custom logic to remove sensitive data. +- [`before-send` and `event-processors`](https://develop.sentry.dev/sdk/miscellaneous/unified-api/#static-api) can be used to register a callback with custom logic to remove sensitive data. ### Application State @@ -119,4 +119,4 @@ Fields in the event payload that allow user-specified or dynamic values are rest 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: - Envelope Endpoint Size Limits -- Store Endpoint Size Limits +- Store Endpoint Size Limits diff --git a/develop-docs/sdk/miscellaneous/hub_and_scope_refactoring.mdx b/develop-docs/sdk/miscellaneous/hub_and_scope_refactoring.mdx index 18866d0bdb6d3..e70cf1eaecd1f 100644 --- a/develop-docs/sdk/miscellaneous/hub_and_scope_refactoring.mdx +++ b/develop-docs/sdk/miscellaneous/hub_and_scope_refactoring.mdx @@ -9,7 +9,7 @@ This is work in progress. Development has started in JS and Python, but we are still ironing out the wrinkles. -Historically Sentry's SDKs implemented the Hubs and Scopes models, a major defining aspect of the Unified API. This introduced a lot of complexity in a user facing manner, allowed more room for error from the user as well as SDK maintainers. Since looking at adopting OpenTelemetry "packages", to replace or in addition to, our existing performance packages in SDKs, there is a forcing factor. Sentry's model being different to OpenTelemetry's prevents us from supporting OpenTelemetry. +Historically Sentry's SDKs implemented the Hubs and Scopes models, a major defining aspect of the Unified API. This introduced a lot of complexity in a user facing manner, allowed more room for error from the user as well as SDK maintainers. Since looking at adopting OpenTelemetry "packages", to replace or in addition to, our existing performance packages in SDKs, there is a forcing factor. Sentry's model being different to OpenTelemetry's prevents us from supporting OpenTelemetry. ## A) Why Are We Doing This? @@ -135,7 +135,7 @@ We should make it very clear in the changelog that top level API only writes to ## E) Implementation Details -We will merge the functionality of the `Hub` and the `Scope` of the Unified API into the `Scope` and we will remove the `Hub`. We will add some new APIs that make it easier for the user to do custom instrumentation. We will update our auto instrumentation to fork a scope whenever a new span is created. This aligns us with what OTel does. +We will merge the functionality of the `Hub` and the `Scope` of the Unified API into the `Scope` and we will remove the `Hub`. We will add some new APIs that make it easier for the user to do custom instrumentation. We will update our auto instrumentation to fork a scope whenever a new span is created. This aligns us with what OTel does. TODO: add where the propagation context is stored and applied, add how tracing without performance works, where spans/transactions live and other problems we discovered and solved in implementing this in the first two SDKs. diff --git a/develop-docs/sdk/miscellaneous/unified-api/index.mdx b/develop-docs/sdk/miscellaneous/unified-api/index.mdx index da70c217a42ff..62851492e77da 100644 --- a/develop-docs/sdk/miscellaneous/unified-api/index.mdx +++ b/develop-docs/sdk/miscellaneous/unified-api/index.mdx @@ -17,7 +17,7 @@ _Types Example:_ Typed languages might have very different developer experience _Platform Example:_ Does Rust have exceptions? Nope, don't name APIs for rust like `captureException`. -_Unified API Example:_ We don't like Hubs and Scopes anymore, and we are redefining that, Hub & Scope Refactoring +_Unified API Example:_ We don't like Hubs and Scopes anymore, and we are redefining that, Hub & Scope Refactoring diff --git a/develop-docs/sdk/research/performance/index.mdx b/develop-docs/sdk/research/performance/index.mdx index 0d5ead3dc348c..d3b48fd26c0bc 100644 --- a/develop-docs/sdk/research/performance/index.mdx +++ b/develop-docs/sdk/research/performance/index.mdx @@ -26,7 +26,7 @@ In the next section, we’ll discuss some of the shortcomings with the current m ## Identified Issues -While the reuse of the [Unified SDK architecture](https://develop.sentry.dev/sdk/unified-api/) (hubs, clients, scopes) and the transaction ingestion model have merits, experience revealed some issues that we categorize into two groups. +While the reuse of the [Unified SDK architecture](https://develop.sentry.dev/sdk/miscellaneous/unified-api/) (hubs, clients, scopes) and the transaction ingestion model have merits, experience revealed some issues that we categorize into two groups. The first group has to do with scope propagation, in essence the ability to determine what the “current scope” is. This operation is required for both manual instrumentation in user code as well as for automatic instrumentation in SDK integrations. @@ -36,7 +36,7 @@ The second group is for issues related to the wire format used to send transacti _This issue is tracked by [getsentry/sentry-javascript#3751](https://github.com/getsentry/sentry-javascript/issues/3751)._ -The [Unified SDK architecture](https://develop.sentry.dev/sdk/unified-api/) is fundamentally based on the existence of a `hub` per unit of concurrency, each `hub` having a stack of pairs of `client` and `scope`. A `client` holds configuration and is responsible for sending data to Sentry by means of a `transport`, while a `scope` holds contextual data that gets appended to outgoing events, such as tags and breadcrumbs. +The [Unified SDK architecture](https://develop.sentry.dev/sdk/miscellaneous/unified-api/) is fundamentally based on the existence of a `hub` per unit of concurrency, each `hub` having a stack of pairs of `client` and `scope`. A `client` holds configuration and is responsible for sending data to Sentry by means of a `transport`, while a `scope` holds contextual data that gets appended to outgoing events, such as tags and breadcrumbs. Every `hub` knows what the current scope is. It is always the scope on top of the stack. The difficult part is having a `hub` “per unit of concurrency”. diff --git a/develop-docs/sdk/serverless-sdks/index.mdx b/develop-docs/sdk/serverless-sdks/index.mdx index b42f51dbfa107..1aa43270a09a1 100644 --- a/develop-docs/sdk/serverless-sdks/index.mdx +++ b/develop-docs/sdk/serverless-sdks/index.mdx @@ -4,4 +4,4 @@ description: Information specific to developing serverless SDKs. sidebar_order: 9 --- -- [AWS Lambda](/sdk/serverless/aws-lambda/) +- [AWS Lambda](/sdk/serverless-sdks/aws-lambda/) diff --git a/develop-docs/sdk/telemetry/client-reports.mdx b/develop-docs/sdk/telemetry/client-reports.mdx index bde68a6ff009d..a1169a1920b4f 100644 --- a/develop-docs/sdk/telemetry/client-reports.mdx +++ b/develop-docs/sdk/telemetry/client-reports.mdx @@ -82,7 +82,7 @@ The following fields exist: : _List of outcome objects_ \{`reason`, `category`, `quantity`\} - `reason`: A string reason that defines why events were lost. -- `category`: The data category for which the discard reason applies. These are the same data categories used for [rate limits](/sdk/rate-limiting/#definitions). +- `category`: The data category for which the discard reason applies. These are the same data categories used for [rate limits](/sdk/expected-features/rate-limiting/#definitions). - `quantity`: The number of events which were lost The following discard reasons are currently defined for `discarded_events`: diff --git a/develop-docs/sdk/telemetry/sessions/index.mdx b/develop-docs/sdk/telemetry/sessions/index.mdx index c17ee7375c0bc..106b65955ed30 100644 --- a/develop-docs/sdk/telemetry/sessions/index.mdx +++ b/develop-docs/sdk/telemetry/sessions/index.mdx @@ -378,7 +378,7 @@ received and end it when a response is returned. ### Unified API Implications -The Unified API that SDKs should +The Unified API that SDKs should adhere to defines the concepts of `Hub`, `Scope` and `Client`. Conceptually speaking, the session is a concern of the `Hub`, and unlike scopes, diff --git a/docs/concepts/data-management/size-limits.mdx b/docs/concepts/data-management/size-limits.mdx index 60d072dc79309..7efae679d36ca 100644 --- a/docs/concepts/data-management/size-limits.mdx +++ b/docs/concepts/data-management/size-limits.mdx @@ -26,6 +26,6 @@ To avoid using up your attachments quota — which is based on size and not numb Sentry's exact size limits may change over time. For more information, please refer to the following resources: - [Envelope Size Limits](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) -- [Store Endpoint Size Limits](https://develop.sentry.dev/sdk/store/#size-limits) +- [Store Endpoint Size Limits](https://develop.sentry.dev/sdk/miscellaneous/store/#size-limits) - [Minidump Size Limits](/platforms/native/guides/minidumps/#size-limits) - [Variable Size Limits](https://develop.sentry.dev/sdk/data-handling/#variable-size) diff --git a/docs/platforms/android/migration/index.mdx b/docs/platforms/android/migration/index.mdx index c24b4c1cf0c17..ad018851f8831 100644 --- a/docs/platforms/android/migration/index.mdx +++ b/docs/platforms/android/migration/index.mdx @@ -420,7 +420,7 @@ Other than that, the APIs didn't change. Release Heath sets by default. If you p ## Migrating from `io.sentry:sentry-android 1.x` to `io.sentry:sentry-android 2.x` -With Sentry Android, we've updated the API to resemble the [Unified API](https://develop.sentry.dev/sdk/unified-api/) more closely. And now that the SDK isn't built on top of `io.sentry:sentry-java`, Sentry Android has more Android-specific features. +With Sentry Android, we've updated the API to resemble the [Unified API](https://develop.sentry.dev/sdk/miscellaneous/unified-api/) more closely. And now that the SDK isn't built on top of `io.sentry:sentry-java`, Sentry Android has more Android-specific features. If you want to upgrade from the previous version of the SDK, please check the following sections of changes that may need updating in your code. diff --git a/docs/platforms/apple/common/migration/index.mdx b/docs/platforms/apple/common/migration/index.mdx index 188698b9e5c17..0ee4a263f6e40 100644 --- a/docs/platforms/apple/common/migration/index.mdx +++ b/docs/platforms/apple/common/migration/index.mdx @@ -135,8 +135,8 @@ We cleaned up our public classes by removing a few functions and properties, tha - Remove `SentryClient.storeEnvelope`, which is reserved for Hybrid SDKs. - Make `closeCachedSessionWithTimestamp` private, which is reserved for internal use. - Remove deprecated `SentryHub.getScope`. Use `SentryHub.scope` instead. -- Replace `SentryException.thread` with `SentryException.threadId` and `SentryException.stacktrace` to align with the [unified API](https://develop.sentry.dev/sdk/unified-api/). -- Replace dict `SentryMechanism.meta` with new class `SentryMechanismMeta` and move `SenryNSError` to `SentryMechanismMeta` to align with the [unified API](https://develop.sentry.dev/sdk/unified-api/). +- Replace `SentryException.thread` with `SentryException.threadId` and `SentryException.stacktrace` to align with the [unified API](https://develop.sentry.dev/sdk/miscellaneous/unified-api/). +- Replace dict `SentryMechanism.meta` with new class `SentryMechanismMeta` and move `SenryNSError` to `SentryMechanismMeta` to align with the [unified API](https://develop.sentry.dev/sdk/miscellaneous/unified-api/). - Change `SentryEvent.timestamp` to `nullable`. ### SentryLogLevel diff --git a/docs/platforms/java/migration/1.x-to-4.x.mdx b/docs/platforms/java/migration/1.x-to-4.x.mdx index 9c7771e59e407..0617450fbb0fb 100644 --- a/docs/platforms/java/migration/1.x-to-4.x.mdx +++ b/docs/platforms/java/migration/1.x-to-4.x.mdx @@ -6,7 +6,7 @@ description: "Learn about migrating from version 1.x to 4.x" ## Migrating from `io.sentry:sentry` `1.x` to `io.sentry:sentry` `4.x` -Our update to the API follows the [Unified API](https://develop.sentry.dev/sdk/unified-api/) more closely. It's a completely updated code base, written to support our Android SDK. +Our update to the API follows the [Unified API](https://develop.sentry.dev/sdk/miscellaneous/unified-api/) more closely. It's a completely updated code base, written to support our Android SDK. ### API Changes diff --git a/redirects.js b/redirects.js index 7b4617424b005..b8f2781fb52d0 100644 --- a/redirects.js +++ b/redirects.js @@ -3,7 +3,7 @@ const isDeveloperDocs = !!process.env.NEXT_PUBLIC_DEVELOPER_DOCS; /** @type {import('next/dist/lib/load-custom-routes').Redirect[]} */ const developerDocsRedirects = [ { - source: '/sdk/unified-api/tracing/:path*', + source: '/sdk/miscellaneous/unified-api/tracing/:path*', destination: '/sdk/performance/:path*', }, { From 07900dcb717b58804f03bc9372c2b53a5358b349 Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Fri, 11 Oct 2024 16:34:49 +0200 Subject: [PATCH 10/17] Some more link fixes --- develop-docs/sdk/data-model/envelopes.mdx | 7 +++---- .../sdk/data-model/event-payloads/contexts.mdx | 4 ++-- develop-docs/sdk/expected-features/data-handling.mdx | 2 +- develop-docs/sdk/expected-features/rate-limiting.mdx | 4 ++-- develop-docs/sdk/miscellaneous/unified-api/index.mdx | 4 ++-- develop-docs/sdk/telemetry/check-ins.mdx | 2 +- develop-docs/sdk/telemetry/replays.mdx | 4 ++-- develop-docs/sdk/telemetry/traces/frames-delay.mdx | 10 +++++----- 8 files changed, 18 insertions(+), 19 deletions(-) diff --git a/develop-docs/sdk/data-model/envelopes.mdx b/develop-docs/sdk/data-model/envelopes.mdx index 0897d5a3572da..6dc93ddc770b2 100644 --- a/develop-docs/sdk/data-model/envelopes.mdx +++ b/develop-docs/sdk/data-model/envelopes.mdx @@ -44,8 +44,7 @@ POST /api//envelope/ ## Serialization Format This section defines the Envelope data format and serialization. For details on -data integrity and a list of valid Item types refer to the next section [Data -Model](#data-model). +data integrity and a list of valid Item types refer to [Envelope Items](/sdk/data-model/envelope-items/). ### Prerequisites @@ -102,7 +101,7 @@ Payload = { * } ; [Headers](#headers) section. Attributes defined in the Envelope header scope the contents of the Envelope and can be thought of as applying to all Items. - Based on the contents of the Envelope, certain header attributes may be - required. See [Data Model](#data-model) for a specification of required + required. See [Envelope Items](/sdk/data-model/envelope-items/) for a specification of required attributes. - **Items** comprise their own headers and a payload. There can be an arbitrary number of **Items** in an Envelope separated by a newline. An @@ -185,7 +184,7 @@ There are two generic headers for every Item: `type` : **String, required.** Specifies the type of this Item and its contents. Based - on the Item type, more headers may be required. See [Data Model](#data-model) for a list + on the Item type, more headers may be required. See [Envelope Items](/sdk/data-model/envelope-items/) for a list of all Item types. `length` diff --git a/develop-docs/sdk/data-model/event-payloads/contexts.mdx b/develop-docs/sdk/data-model/event-payloads/contexts.mdx index 08b194d71eabc..5393af606c38f 100644 --- a/develop-docs/sdk/data-model/event-payloads/contexts.mdx +++ b/develop-docs/sdk/data-model/event-payloads/contexts.mdx @@ -640,7 +640,7 @@ Additional information that allows Sentry to connect multiple transactions, span `op` -: _Optional_. Short code identifying the type of operation the span is measuring. For more details, see [Sentry's conventions around span operations](https://develop.sentry.dev/sdk/performance/span-operations/). +: _Optional_. Short code identifying the type of operation the span is measuring. For more details, see [Sentry's conventions around span operations](/sdk/performance/span-operations/). - Example: `"http.server"` @@ -692,7 +692,7 @@ Additional information that allows Sentry to connect multiple transactions, span `dynamic_sampling_context` -: _Optional_. The [Dynamic Sampling Context](https://develop.sentry.dev/sdk/performance/dynamic-sampling-context/). +: _Optional_. The [Dynamic Sampling Context](/sdk/performance/dynamic-sampling-context/). - Example: `{ "trace_id": "12312012123120121231201212312012", "sample_rate": "1.0", "public_key": "93D0D1125146288EAEE2A9B3AF4F96CCBE3CB316" },` diff --git a/develop-docs/sdk/expected-features/data-handling.mdx b/develop-docs/sdk/expected-features/data-handling.mdx index 3913282c8840e..60a8d2748c728 100644 --- a/develop-docs/sdk/expected-features/data-handling.mdx +++ b/develop-docs/sdk/expected-features/data-handling.mdx @@ -31,7 +31,7 @@ All other platforms require the event to include `user.ip={{auto}}` which happen Before sending events to Sentry, the SDKs should invokes callbacks. That allows users to remove any sensitive data client-side. -- [`before-send` and `event-processors`](https://develop.sentry.dev/sdk/miscellaneous/unified-api/#static-api) can be used to register a callback with custom logic to remove sensitive data. +- [`before-send` and `event-processors`](/sdk/miscellaneous/unified-api/#static-api) can be used to register a callback with custom logic to remove sensitive data. ### Application State diff --git a/develop-docs/sdk/expected-features/rate-limiting.mdx b/develop-docs/sdk/expected-features/rate-limiting.mdx index 918f4b3d6b4e5..f2f8bbf75a2e3 100644 --- a/develop-docs/sdk/expected-features/rate-limiting.mdx +++ b/develop-docs/sdk/expected-features/rate-limiting.mdx @@ -15,7 +15,7 @@ Each *quota_limit* has the form `retry_after:categories:scope:reason_code:namesp - `retry_after`: Number of seconds (as an integer or a floating point number) until this rate limit expires. - `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**. - 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. + While these categories might look similar to the [envelope item types](/sdk/data-model/envelope-items/), they are not identical, and have slight differences. - `scope`: The scope that this limit applies to. Can be ignored by SDKs. - `reason_code`: A unique identifier for the quota hinting at the rate limiting reason. Can be ignored by SDKs. - `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: 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. - **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. -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. +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/envelope-items/), they are not identical, and have slight differences. - `default`: Events with an event_type not listed explicitly below. - `error`: Error events. - `transaction`: Transaction type events. diff --git a/develop-docs/sdk/miscellaneous/unified-api/index.mdx b/develop-docs/sdk/miscellaneous/unified-api/index.mdx index 62851492e77da..5b8476a08e5c7 100644 --- a/develop-docs/sdk/miscellaneous/unified-api/index.mdx +++ b/develop-docs/sdk/miscellaneous/unified-api/index.mdx @@ -17,7 +17,7 @@ _Types Example:_ Typed languages might have very different developer experience _Platform Example:_ Does Rust have exceptions? Nope, don't name APIs for rust like `captureException`. -_Unified API Example:_ We don't like Hubs and Scopes anymore, and we are redefining that, Hub & Scope Refactoring +_Unified API Example:_ We don't like Hubs and Scopes anymore, and we are redefining that, Hub & Scope Refactoring @@ -280,7 +280,7 @@ processing happens. ## Options -Many options are standardized across SDKs. For a list of these refer to [the main options documentation](https://docs.sentry.io/error-reporting/configuration/). +Many options are standardized across SDKs. For a list of these refer to [the main options documentation](https://docs.sentry.io/platforms/javascript/configuration/). ## Integrations diff --git a/develop-docs/sdk/telemetry/check-ins.mdx b/develop-docs/sdk/telemetry/check-ins.mdx index 68e9f4684f082..5fecd7afbb732 100644 --- a/develop-docs/sdk/telemetry/check-ins.mdx +++ b/develop-docs/sdk/telemetry/check-ins.mdx @@ -66,7 +66,7 @@ The following fields exist: `contexts` : _Object, optional_. A dictionary of contextual information about the environment running - the check-in. Right now we only support the [trace context](https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/#trace-context) + the check-in. Right now we only support the [trace context](/sdk/data-model/event-payloads/contexts/#trace-context) and use the `trace_id` in order to link check-ins to associated errors. ## Monitor upsert support diff --git a/develop-docs/sdk/telemetry/replays.mdx b/develop-docs/sdk/telemetry/replays.mdx index 35152f7dda622..e668fd955d99c 100644 --- a/develop-docs/sdk/telemetry/replays.mdx +++ b/develop-docs/sdk/telemetry/replays.mdx @@ -19,7 +19,7 @@ The following attributes are specific to the `"replay_event"` Item type. | Key | Type | Description | | ---------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | type | `"replay_event"` | Must be `"replay_event"` | -| replay_id | string | A unique ID for the replay. Follows the [same requirements](https://develop.sentry.dev/sdk/data-model/event-payloads/#required-attributes) as an `event_id`: Hexadecimal string representing a uuid4 value. The length is exactly 32 characters. Dashes are not allowed. Has to be lowercase. | +| replay_id | string | A unique ID for the replay. Follows the [same requirements](/sdk/data-model/event-payloads/#required-attributes) as an `event_id`: Hexadecimal string representing a uuid4 value. The length is exactly 32 characters. Dashes are not allowed. Has to be lowercase. | | replay_type | `"session"` \| `"buffer"` | Describes the type of replay. `buffer` means the replay is buffered while waiting for an error to occur or until a manual flush. `session` means the replay starts recording immediately and continues through the lifespan of the replay session. | | segment_id | number | The segment id. | | replay_start_timestamp | number | UNIX timestamp of the start of the replay (in seconds). This is only required on the first segment. | @@ -29,7 +29,7 @@ The following attributes are specific to the `"replay_event"` Item type. ### Event Attributes -The following attributes are a subset of the [optional attributes](https://develop.sentry.dev/sdk/data-model/event-payloads/#optional-attributes) of an Event. +The following attributes are a subset of the [optional attributes](/sdk/data-model/event-payloads/#optional-attributes) of an Event. | Key | Type | Description | | -------------------------- | ------ | ------------------------------------------------ | diff --git a/develop-docs/sdk/telemetry/traces/frames-delay.mdx b/develop-docs/sdk/telemetry/traces/frames-delay.mdx index edd2698457c91..4bc367929bb1e 100644 --- a/develop-docs/sdk/telemetry/traces/frames-delay.mdx +++ b/develop-docs/sdk/telemetry/traces/frames-delay.mdx @@ -21,11 +21,11 @@ The major downside is that they lack essential information on how long they last significant problem when prioritizing which unresponsive application parts need improvement. The following scenarios highlight the problem when prioritizing by looking at slow and frozen frames. -Scenario | Slow Frames | Frozen Frames | --- | -- | -- | -- -1 | 5 all 500ms | 0 | -2 | 10 all 20ms | 0 | -3 | 0 | 1 with 800ms | +Scenario | Slow Frames | Frozen Frames +-- | -- | -- +1 | 5 all 500ms | 0 +2 | 10 all 20ms | 0 +3 | 0 | 1 with 800ms When comparing the different scenarios, a user might want to fix scenario 3 first because it contains one frozen frame. When comparing scenarios 1 and 2, they would pick scenario 2 cause it has more slow frames. While scenario From a9d35616f46b68faf0d67beaa0136f2a7ed68efb Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Fri, 11 Oct 2024 16:35:27 +0200 Subject: [PATCH 11/17] One more --- develop-docs/application/issue-platform/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/application/issue-platform/index.mdx b/develop-docs/application/issue-platform/index.mdx index 004d39c8c2879..a4d9b6baea84a 100644 --- a/develop-docs/application/issue-platform/index.mdx +++ b/develop-docs/application/issue-platform/index.mdx @@ -143,7 +143,7 @@ The most current version of this schema is documented here: Schema -The event schema should match the Sentry event schema. Any fields/interfaces defined here can be passed along with your event. It's best to fill in as many of these as makes sense for your issue type. +The event schema should match the Sentry event schema. Any fields/interfaces defined here can be passed along with your event. It's best to fill in as many of these as makes sense for your issue type. There's a minimum set of fields which should be included: From a73181f3ff261ebb65b99346d8498f58169eee62 Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Mon, 14 Oct 2024 09:31:19 +0200 Subject: [PATCH 12/17] Added redirects from old to new pages in develop docs. --- redirects.js | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/redirects.js b/redirects.js index b8f2781fb52d0..9848e87846e0d 100644 --- a/redirects.js +++ b/redirects.js @@ -30,6 +30,70 @@ const developerDocsRedirects = [ source: '/sdk/data-model/event-payloads/types/', destination: '/sdk/data-model/event-payloads/', }, + { + source: '/sdk/basics/:path*', + destination: '/sdk/development-process/basics/:path*', + }, + { + source: '/sdk/data-handling/:path*', + destination: '/sdk/expected-features/data-handling/:path*', + }, + { + source: '/sdk/features/:path*', + destination: '/sdk/expected-features/:path*', + }, + { + source: '/sdk/rate-limiting/:path*', + destination: '/sdk/expected-features/rate-limiting/:path*', + }, + { + source: '/sdk/envelopes/:path*', + destination: '/sdk/data-model/envelopes/:path*', + }, + { + source: '/sdk/event-payloads/:path*', + destination: '/sdk/data-model/event-payloads/:path*', + }, + { + source: '/sdk/hub_and_scope_refactoring/:path*', + destination: '/sdk/miscellaneous/hub_and_scope_refactoring/:path*', + }, + { + source: '/sdk/unified-api/:path*', + destination: '/sdk/miscellaneous/unified-api/:path*', + }, + { + source: '/sdk/sessions/:path*', + destination: '/sdk/telemetry/sessions/:path*', + }, + { + source: '/sdk/client-reports/:path*', + destination: '/sdk/telemetry/client-reports/:path*', + }, + { + source: '/sdk/replays/:path*', + destination: '/sdk/telemetry/replays/:path*', + }, + { + source: '/sdk/setup-wizards/:path*', + destination: '/sdk/expected-features/setup-wizards/:path*', + }, + { + source: '/sdk/serverless/:path*', + destination: '/sdk/serverless-sdks/:path*', + }, + { + source: '/sdk/signal-handlers/:path*', + destination: '/sdk/native-sdks/signal-handlers/:path*', + }, + { + source: '/sdk/store/:path*', + destination: '/sdk/miscellaneous/store/#size-limits:path*', + }, + { + source: '/sdk/processes/:path*', + destination: '/sdk/development-process/:path*', + }, ]; /** @type {import('next/dist/lib/load-custom-routes').Redirect[]} */ From 9f0e4f036288a1d72b4928c3e7d82908a29e0536 Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Mon, 14 Oct 2024 09:59:38 +0200 Subject: [PATCH 13/17] Small redirect fix --- redirects.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/redirects.js b/redirects.js index 9848e87846e0d..f93908e414101 100644 --- a/redirects.js +++ b/redirects.js @@ -88,7 +88,7 @@ const developerDocsRedirects = [ }, { source: '/sdk/store/:path*', - destination: '/sdk/miscellaneous/store/#size-limits:path*', + destination: '/sdk/miscellaneous/store/:path*', }, { source: '/sdk/processes/:path*', From 6f7a7f5aa30f91314c141c9b735d1db73c950a5c Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Mon, 14 Oct 2024 10:08:47 +0200 Subject: [PATCH 14/17] Redirects from subsection to new page --- develop-docs/sdk/data-model/envelopes.mdx | 3 ++ redirects.js | 57 +++++++++++++++++++++++ 2 files changed, 60 insertions(+) diff --git a/develop-docs/sdk/data-model/envelopes.mdx b/develop-docs/sdk/data-model/envelopes.mdx index 6dc93ddc770b2..b8b7c4fd1bb1b 100644 --- a/develop-docs/sdk/data-model/envelopes.mdx +++ b/develop-docs/sdk/data-model/envelopes.mdx @@ -295,6 +295,9 @@ EOF:** {"started": "2020-02-07T14:16:00Z","attrs":{"release":"sentry-test@1.0.0"}} ``` +## Data Model + +This section has been moved to [Envelope Items](/sdk/data-model/envelope-items/). ## Ingestion This section describes how to ingest Envelopes into Relay or Sentry. The main diff --git a/redirects.js b/redirects.js index f93908e414101..bfe9b53b89f53 100644 --- a/redirects.js +++ b/redirects.js @@ -94,6 +94,63 @@ const developerDocsRedirects = [ source: '/sdk/processes/:path*', destination: '/sdk/development-process/:path*', }, + // Redirects of sections in /sdk/envelope pages that now live on /sdk/data-model/envelope-items/ page + { + source: '/sdk/envelopes/#event', + destination: '/sdk/data-model/envelope-items/#event', + }, + { + source: '/sdk/envelopes/#transaction', + destination: '/sdk/data-model/envelope-items/#transaction', + }, + { + source: '/sdk/envelopes/#attachment', + destination: '/sdk/data-model/envelope-items/#attachment', + }, + { + source: '/sdk/envelopes/#session', + destination: '/sdk/data-model/envelope-items/#session', + }, + { + source: '/sdk/envelopes/#statsd', + destination: '/sdk/data-model/envelope-items/#statsd', + }, + { + source: '/sdk/envelopes/#metric-meta', + destination: '/sdk/data-model/envelope-items/#metric-meta', + }, + { + source: '/sdk/envelopes/#user-feedback', + destination: '/sdk/data-model/envelope-items/#user-feedback', + }, + { + source: '/sdk/envelopes/#client-report', + destination: '/sdk/data-model/envelope-items/#client-report', + }, + { + source: '/sdk/envelopes/#replay-event', + destination: '/sdk/data-model/envelope-items/#replay-event', + }, + { + source: '/sdk/envelopes/#replay-recording', + destination: '/sdk/data-model/envelope-items/#replay-recording', + }, + { + source: '/sdk/envelopes/#profile', + destination: '/sdk/data-model/envelope-items/#profile', + }, + { + source: '/sdk/envelopes/#profile-chunk', + destination: '/sdk/data-model/envelope-items/#profile-chunk', + }, + { + source: '/sdk/envelopes/#check-ins', + destination: '/sdk/data-model/envelope-items/#check-ins', + }, + { + source: '/sdk/envelopes/#reserved-types', + destination: '/sdk/data-model/envelope-items/#reserved-types', + }, ]; /** @type {import('next/dist/lib/load-custom-routes').Redirect[]} */ From 1165da0dd4f879dbe7756ddeca15b6c5c2c65b1e Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Mon, 14 Oct 2024 10:20:47 +0200 Subject: [PATCH 15/17] Fixed redirects --- redirects.js | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/redirects.js b/redirects.js index bfe9b53b89f53..a56c4fd638c27 100644 --- a/redirects.js +++ b/redirects.js @@ -46,10 +46,6 @@ const developerDocsRedirects = [ source: '/sdk/rate-limiting/:path*', destination: '/sdk/expected-features/rate-limiting/:path*', }, - { - source: '/sdk/envelopes/:path*', - destination: '/sdk/data-model/envelopes/:path*', - }, { source: '/sdk/event-payloads/:path*', destination: '/sdk/data-model/event-payloads/:path*', @@ -151,6 +147,12 @@ const developerDocsRedirects = [ source: '/sdk/envelopes/#reserved-types', destination: '/sdk/data-model/envelope-items/#reserved-types', }, + // Redirect of the main /sdk/envelopes page that now lives on /sdk/data-model/envelopes/ page + // Must come after the redirects of the sub sections above. + { + source: '/sdk/envelopes/:path*', + destination: '/sdk/data-model/envelopes/:path*', + }, ]; /** @type {import('next/dist/lib/load-custom-routes').Redirect[]} */ From be956db70baad5eb8f8087df4d14b2eed25c24cc Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Mon, 14 Oct 2024 10:34:04 +0200 Subject: [PATCH 16/17] Removed not working redirects --- redirects.js | 67 ++++------------------------------------------------ 1 file changed, 4 insertions(+), 63 deletions(-) diff --git a/redirects.js b/redirects.js index a56c4fd638c27..f93908e414101 100644 --- a/redirects.js +++ b/redirects.js @@ -46,6 +46,10 @@ const developerDocsRedirects = [ source: '/sdk/rate-limiting/:path*', destination: '/sdk/expected-features/rate-limiting/:path*', }, + { + source: '/sdk/envelopes/:path*', + destination: '/sdk/data-model/envelopes/:path*', + }, { source: '/sdk/event-payloads/:path*', destination: '/sdk/data-model/event-payloads/:path*', @@ -90,69 +94,6 @@ const developerDocsRedirects = [ source: '/sdk/processes/:path*', destination: '/sdk/development-process/:path*', }, - // Redirects of sections in /sdk/envelope pages that now live on /sdk/data-model/envelope-items/ page - { - source: '/sdk/envelopes/#event', - destination: '/sdk/data-model/envelope-items/#event', - }, - { - source: '/sdk/envelopes/#transaction', - destination: '/sdk/data-model/envelope-items/#transaction', - }, - { - source: '/sdk/envelopes/#attachment', - destination: '/sdk/data-model/envelope-items/#attachment', - }, - { - source: '/sdk/envelopes/#session', - destination: '/sdk/data-model/envelope-items/#session', - }, - { - source: '/sdk/envelopes/#statsd', - destination: '/sdk/data-model/envelope-items/#statsd', - }, - { - source: '/sdk/envelopes/#metric-meta', - destination: '/sdk/data-model/envelope-items/#metric-meta', - }, - { - source: '/sdk/envelopes/#user-feedback', - destination: '/sdk/data-model/envelope-items/#user-feedback', - }, - { - source: '/sdk/envelopes/#client-report', - destination: '/sdk/data-model/envelope-items/#client-report', - }, - { - source: '/sdk/envelopes/#replay-event', - destination: '/sdk/data-model/envelope-items/#replay-event', - }, - { - source: '/sdk/envelopes/#replay-recording', - destination: '/sdk/data-model/envelope-items/#replay-recording', - }, - { - source: '/sdk/envelopes/#profile', - destination: '/sdk/data-model/envelope-items/#profile', - }, - { - source: '/sdk/envelopes/#profile-chunk', - destination: '/sdk/data-model/envelope-items/#profile-chunk', - }, - { - source: '/sdk/envelopes/#check-ins', - destination: '/sdk/data-model/envelope-items/#check-ins', - }, - { - source: '/sdk/envelopes/#reserved-types', - destination: '/sdk/data-model/envelope-items/#reserved-types', - }, - // Redirect of the main /sdk/envelopes page that now lives on /sdk/data-model/envelopes/ page - // Must come after the redirects of the sub sections above. - { - source: '/sdk/envelopes/:path*', - destination: '/sdk/data-model/envelopes/:path*', - }, ]; /** @type {import('next/dist/lib/load-custom-routes').Redirect[]} */ From 244ee682875cc77f1164be8aa83ceba95abd7dac Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Mon, 14 Oct 2024 10:34:26 +0200 Subject: [PATCH 17/17] Fixed last redirects --- develop-docs/application/feedback-architecture.mdx | 4 ++-- develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx | 2 +- develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/develop-docs/application/feedback-architecture.mdx b/develop-docs/application/feedback-architecture.mdx index 78209cb86f0fc..38001a22c87a4 100644 --- a/develop-docs/application/feedback-architecture.mdx +++ b/develop-docs/application/feedback-architecture.mdx @@ -20,7 +20,7 @@ the [User Feedback Widget](https://docs.sentry.io/product/user-feedback/#user-fe to the JavaScript SDK. It allows adding more information, for example tags, release, url, etc. -`USER_REPORT_ENVELOPE`: [The older format](https://develop.sentry.dev/sdk/data-model/envelopes/#user-feedback) with name/email/comments, that requires +`USER_REPORT_ENVELOPE`: [The older format](https://develop.sentry.dev/sdk/data-model/envelope-items/#user-feedback) with name/email/comments, that requires `event_id` to link a Sentry error event. `USER_REPORT_DJANGO_ENDPOINT`: [The deprecated Web API](https://docs.sentry.io/api/projects/submit-user-feedback/) @@ -139,7 +139,7 @@ Simplified diagram: ### Envelopes -User reports are also sent to Relay in [envelope format](https://develop.sentry.dev/sdk/data-model/envelopes/#user-feedback). +User reports are also sent to Relay in [envelope format](https://develop.sentry.dev/sdk/data-model/envelope-items/#user-feedback). **This item type is misleadingly called “user feedback” in some of our docs, but the item header will read `"user_report"`.** diff --git a/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx b/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx index 3a025526fb464..d24c8daf18dda 100644 --- a/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx +++ b/develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx @@ -390,7 +390,7 @@ It's suggested to remove unnecessary data like thread data without samples from After this payload is generated, serialize it as JSON, pack it into the same [Envelope](/sdk/data-model/envelopes/) as the associated transaction with the item type -[`profile`](/sdk/data-model/envelopes/#profile) and send it to Relay. +[`profile`](/sdk/data-model/envelope-items/#profile) and send it to Relay. This envelope should look like this: diff --git a/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx b/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx index d6cf6e56823d7..c18a2f69c429c 100644 --- a/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx +++ b/develop-docs/sdk/telemetry/profiles/sample-format-v2.mdx @@ -283,7 +283,7 @@ It's suggested to remove unnecessary data like thread data without samples from After this payload is generated, serialize it as JSON, pack it into an -[Envelope](/sdk/data-model/envelopes/) with the item type [`profile_chunk`](/sdk/data-model/envelopes/#profile-chunk) and send +[Envelope](/sdk/data-model/envelopes/) with the item type [`profile_chunk`](/sdk/data-model/envelope-items/#profile-chunk) and send it to Relay.