From a715187134cb31485becfeda3c281892388b544b Mon Sep 17 00:00:00 2001 From: Charly Gomez Date: Tue, 23 Jul 2024 10:45:28 +0200 Subject: [PATCH] fix: Remove unsupported definition list syntax (#10739) --- develop-docs/sdk/check-ins.mdx | 38 ++-- develop-docs/sdk/client-reports.mdx | 6 +- develop-docs/sdk/envelopes.mdx | 14 +- develop-docs/sdk/event-payloads/contexts.mdx | 212 +++++++++--------- develop-docs/sdk/event-payloads/debugmeta.mdx | 70 +++--- .../sdk/event-payloads/lockreason.mdx | 10 +- develop-docs/sdk/event-payloads/message.mdx | 6 +- .../properties/contexts_trace.mdx | 2 +- .../event-payloads/properties/description.mdx | 2 +- .../event-payloads/properties/event_id.mdx | 2 +- .../properties/measurements.mdx | 2 +- .../sdk/event-payloads/properties/op.mdx | 2 +- .../properties/parent_span_id.mdx | 2 +- .../sdk/event-payloads/properties/span_id.mdx | 2 +- .../properties/span_start_timestamp.mdx | 2 +- .../properties/span_timestamp.mdx | 2 +- .../sdk/event-payloads/properties/spans.mdx | 2 +- .../sdk/event-payloads/properties/status.mdx | 2 +- .../sdk/event-payloads/properties/tags.mdx | 2 +- .../event-payloads/properties/trace_id.mdx | 2 +- .../properties/transaction_info.mdx | 4 +- .../sdk/event-payloads/properties/type.mdx | 2 +- develop-docs/sdk/event-payloads/request.mdx | 14 +- develop-docs/sdk/event-payloads/sdk.mdx | 10 +- develop-docs/sdk/event-payloads/span.mdx | 4 +- .../sdk/event-payloads/stacktrace.mdx | 4 +- develop-docs/sdk/event-payloads/threads.mdx | 16 +- develop-docs/sdk/overview.mdx | 9 +- develop-docs/sdk/performance/trace-origin.mdx | 8 +- develop-docs/sdk/sessions.mdx | 26 +-- 30 files changed, 240 insertions(+), 239 deletions(-) diff --git a/develop-docs/sdk/check-ins.mdx b/develop-docs/sdk/check-ins.mdx index f421ca8952c84..f2e98ec21d61f 100644 --- a/develop-docs/sdk/check-ins.mdx +++ b/develop-docs/sdk/check-ins.mdx @@ -27,7 +27,7 @@ The following fields exist: `check_in_id` -: **String, required**. Check-In ID (unique and client generated). +**String, required**. Check-In ID (unique and client generated). This may be provided as a empty UUID (128 bit zero value) to indicate to Sentry that the checkin should update the most recent "in_progress" check-in. @@ -36,36 +36,36 @@ The following fields exist: `monitor_slug` -: **String, required**. The distinct slug of the monitor. +**String, required**. The distinct slug of the monitor. `status` -: **String, required**. The status of the check-in. Can be one of the following: +**String, required**. The status of the check-in. Can be one of the following: - `in_progress`: The check-in has started. - `ok`: The check-in has completed successfully. - `error`: The check-in has failed. `duration` -: _Number, optional_. The duration of the check-in in seconds. Will only take effect if the +_Number, optional_. The duration of the check-in in seconds. Will only take effect if the status is `ok` or `error`. `release` -: _String, optional_. The release. +_String, optional_. The release. `environment` -: _String, optional_. The environment. +_String, optional_. The environment. `monitor_config` -: _Object, optional_. A monitor configuration (defined below) that is stored with the +_Object, optional_. A monitor configuration (defined below) that is stored with the check-in in order to verify the state of the monitor at the time of the check-in. `contexts` -: _Object, optional_. A dictionary of contextual information about the environment running +_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) and use the `trace_id` in order to link check-ins to associated errors. @@ -99,37 +99,37 @@ The following fields exist under the `monitor_config` key: `schedule` -: **Object, required**. [See schedule configuration](#schedule-configuration). +**Object, required**. [See schedule configuration](#schedule-configuration). `checkin_margin` -: _Number, optional_. The allowed margin of minutes after the expected +_Number, optional_. The allowed margin of minutes after the expected check-in time that the monitor will not be considered missed for. `max_runtime` -: _Number, optional_. The allowed duration in minutes that the monitor +_Number, optional_. The allowed duration in minutes that the monitor may be `in_progress` for before being considered failed due to timeout. `failure_issue_threshold` -: _Number, optional_. The number of consecutive failed check-ins it takes +_Number, optional_. The number of consecutive failed check-ins it takes before an issue is created. `recovery_threshold` -: _Number, optional_. The number of consecutive OK check-ins it takes +_Number, optional_. The number of consecutive OK check-ins it takes before an issue is resolved. `timezone` -: _String, optional_. A [`tz +_String, optional_. A [`tz database`](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) string representing the timezone which the monitor's execution schedule is in. `owner` -: _String, optional_. An actor identifier string. This looks like +_String, optional_. An actor identifier string. This looks like `user:john@example.com` `team:a-sentry-team`. IDs can also be used but will result in a poor DX. @@ -142,20 +142,20 @@ monitors frontend APIs. `type` -: **String, required**. One of `crontab` or `interval`. +**String, required**. One of `crontab` or `interval`. #### Using `crontab` `value` -: **String, required**. The crontab schedule string, e.g. `0 * * * *`. +**String, required**. The crontab schedule string, e.g. `0 * * * *`. #### Using `interval` `value` -: **Number, required**. The interval value. +**Number, required**. The interval value. `unit` -: **String, required**. The interval unit. Should be one of `year`, `month`, `week`, `day`, `hour`, `minute`. +**String, required**. The interval unit. Should be one of `year`, `month`, `week`, `day`, `hour`, `minute`. diff --git a/develop-docs/sdk/client-reports.mdx b/develop-docs/sdk/client-reports.mdx index ea652f53f9631..d7a9b50a706a0 100644 --- a/develop-docs/sdk/client-reports.mdx +++ b/develop-docs/sdk/client-reports.mdx @@ -75,14 +75,14 @@ The following fields exist: `timestamp` -: _String | Number, optional_. The timestamp of when the client report was created. +_String | Number, optional_. The timestamp of when the client report was created. Must be an ISO DateTime string or a UNIX timestamp. If not sent, the server will assume the current UTC timestamp. In the data model, this is called `received`. `discarded_events` -: _List of outcome objects_ {`reason`, `category`, `quantity`} +_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). @@ -111,7 +111,7 @@ that SDKs send these under normal operation: `rate_limited_events`, `filtered_events`, `filtered_sampling_events` -: _List of outcome objects_ {`reason`, `category`, `quantity`} +_List of outcome objects_ (`reason`, `category`, `quantity`) These function like `discarded_events` but identify events that were rate limited, filtered or filtered by by dynamic sampling _at a relay_. Client SDKs must never diff --git a/develop-docs/sdk/envelopes.mdx b/develop-docs/sdk/envelopes.mdx index 0e816c83c8f9e..305b0252ef332 100644 --- a/develop-docs/sdk/envelopes.mdx +++ b/develop-docs/sdk/envelopes.mdx @@ -184,7 +184,7 @@ There are two generic headers for every Item: `type` -: **String, required.** Specifies the type of this Item and its contents. Based +**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 of all Item types. @@ -323,7 +323,7 @@ encoded in JSON. `event_id` -: **UUID String, required.** Corresponds to the `event_id` field of the event +**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. @@ -346,7 +346,7 @@ in JSON. `event_id` -: **UUID String, required.** Corresponds to the `event_id` field of the +**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 @@ -380,13 +380,13 @@ file. It is always associated to an event or transaction. `event_id` -: **UUID String, required.** The identifier of the event or transaction. +**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. +**String, required.** The name of the uploaded file without a path component. `attachment_type` @@ -486,7 +486,7 @@ The item contains a user feedback / user report JSON payload: `event_id` -: **UUID String, required.** The identifier of the event or transaction. +**UUID String, required.** The identifier of the event or transaction. `email` @@ -511,7 +511,7 @@ The item contains a user feedback / user report JSON payload: `event_id` -: **UUID String, required.** The identifier of the event or transaction. +**UUID String, required.** The identifier of the event or transaction. **Additional Item Headers:** diff --git a/develop-docs/sdk/event-payloads/contexts.mdx b/develop-docs/sdk/event-payloads/contexts.mdx index 0d31991eaade1..402e2e0b99eec 100644 --- a/develop-docs/sdk/event-payloads/contexts.mdx +++ b/develop-docs/sdk/event-payloads/contexts.mdx @@ -33,173 +33,173 @@ The `type` and default key is `"device"`. `name` -: **Required**. The name of the device. This is typically a hostname. +**Required**. The name of the device. This is typically a hostname. `family` -: _Optional_. The family of the device. This is usually the common part of model +_Optional_. The family of the device. This is usually the common part of model names across generations. For instance, `iPhone` would be a reasonable family, so would be `Samsung Galaxy`. `model` -: _Optional_. The model name. This, for example, can be `Samsung Galaxy S3`. +_Optional_. The model name. This, for example, can be `Samsung Galaxy S3`. `model_id` -: _Optional_. An internal hardware revision to identify the device exactly. +_Optional_. An internal hardware revision to identify the device exactly. `arch` -: _Optional_. The CPU architecture. +_Optional_. The CPU architecture. `battery_level` -: _Optional_. If the device has a battery, this can be a floating point value +_Optional_. If the device has a battery, this can be a floating point value defining the battery level (in the range 0-100). `battery_temperature` -: _Optional_. If the device has a battery, this can be a floating point value +_Optional_. If the device has a battery, this can be a floating point value defining the battery temperature in Celsius. `orientation` -: _Optional_. This can be a string `portrait` or `landscape` to define the +_Optional_. This can be a string `portrait` or `landscape` to define the orientation of a device. `manufacturer` -: _Optional_. The manufacturer of the device. +_Optional_. The manufacturer of the device. `brand` -: _Optional_. The brand of the device. +_Optional_. The brand of the device. `screen_resolution` -: _Optional_. The screen resolution. (e.g.: 800x600, 3040x1444). +_Optional_. The screen resolution. (e.g.: 800x600, 3040x1444). `screen_height_pixels` -: _Optional_. The height of the screen. +_Optional_. The height of the screen. `screen_width_pixels` -: _Optional_. The width of the screen. +_Optional_. The width of the screen. `screen_density` -: _Optional_. A floating point denoting the screen density. +_Optional_. A floating point denoting the screen density. `screen_dpi` -: _Optional_. A decimal value reflecting the DPI (dots-per-inch) density. +_Optional_. A decimal value reflecting the DPI (dots-per-inch) density. `online` -: _Optional_. Whether the device was online or not. +_Optional_. Whether the device was online or not. `charging` -: _Optional_. Whether the device was charging or not. +_Optional_. Whether the device was charging or not. `low_memory` -: _Optional_. Whether the device was low on memory. +_Optional_. Whether the device was low on memory. `simulator` -: _Optional_. A flag indicating whether this device is a simulator or an actual +_Optional_. A flag indicating whether this device is a simulator or an actual device. `memory_size` -: _Optional_. Total system memory available in bytes. +_Optional_. Total system memory available in bytes. `free_memory` -: _Optional_. Free system memory in bytes. +_Optional_. Free system memory in bytes. `usable_memory` -: _Optional_. Memory usable for the app in bytes. +_Optional_. Memory usable for the app in bytes. `storage_size` -: _Optional_. Total device storage in bytes. +_Optional_. Total device storage in bytes. `free_storage` -: _Optional_. Free device storage in bytes. +_Optional_. Free device storage in bytes. `external_storage_size` -: _Optional_. Total size of an attached external storage in bytes (for example, +_Optional_. Total size of an attached external storage in bytes (for example, android SDK card). `external_free_storage` -: _Optional_. Free size of an attached external storage in bytes (for example, +_Optional_. Free size of an attached external storage in bytes (for example, android SDK card). `boot_time` -: _Optional_. A formatted UTC timestamp when the system was booted. For example, +_Optional_. A formatted UTC timestamp when the system was booted. For example, `"2018-02-08T12:52:12Z"`. `timezone` -: _Optional_. The timezone of the device. For example, `Europe/Vienna`. This field is deprecated, please use `timezone` of [culture context](#culture-context) instead. +_Optional_. The timezone of the device. For example, `Europe/Vienna`. This field is deprecated, please use `timezone` of [culture context](#culture-context) instead. `language` -: _Optional_. The language of the device. For example, `en`. This field is deprecated, please use `locale` of [culture context](#culture-context) instead. +_Optional_. The language of the device. For example, `en`. This field is deprecated, please use `locale` of [culture context](#culture-context) instead. `processor_count` -: _Optional_. Number of "logical processors". For example, `8`. +_Optional_. Number of "logical processors". For example, `8`. `cpu_description` -: _Optional_. CPU description. For example, `Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz`. +_Optional_. CPU description. For example, `Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz`. `processor_frequency` -: _Optional_. Processor frequency in MHz. Note that the actual CPU frequency might vary depending on current load and power conditions, +_Optional_. Processor frequency in MHz. Note that the actual CPU frequency might vary depending on current load and power conditions, especially on low-powered devices like phones and laptops. `device_type` -: _Optional_. Kind of device the application is running on. For example, `Unknown, Handheld, Console, Desktop`. +_Optional_. Kind of device the application is running on. For example, `Unknown, Handheld, Console, Desktop`. `battery_status` -: _Optional_. Status of the device's battery. For example, `Unknown, Charging, Discharging, NotCharging, Full`. +_Optional_. Status of the device's battery. For example, `Unknown, Charging, Discharging, NotCharging, Full`. `device_unique_identifier` -: _Optional_. Unique device identifier. This value might only be used if `sendDefaultPii` is enabled. +_Optional_. Unique device identifier. This value might only be used if `sendDefaultPii` is enabled. `supports_vibration` -: _Optional_. Is vibration available on the device? +_Optional_. Is vibration available on the device? `supports_accelerometer` -: _Optional_. Is accelerometer available on the device? +_Optional_. Is accelerometer available on the device? `supports_gyroscope` -: _Optional_. Is gyroscope available on the device? +_Optional_. Is gyroscope available on the device? `supports_audio` -: _Optional_. Is audio available on the device? +_Optional_. Is audio available on the device? `supports_location_service` -: _Optional_. Is the device capable of reporting its location? +_Optional_. Is the device capable of reporting its location? ## OS Context @@ -244,38 +244,38 @@ To summarize: `name` -: _Recommended_. The name of the operating system. It might be derived from `raw_description`. It is **required** if `raw_description` is not provided. +_Recommended_. The name of the operating system. It might be derived from `raw_description`. It is **required** if `raw_description` is not provided. `version` -: _Optional_. The version of the operating system. +_Optional_. The version of the operating system. `build` -: _Optional_. The internal build revision of the operating system. +_Optional_. The internal build revision of the operating system. `kernel_version` -: _Optional_. An independent kernel version string. This is typically the entire +_Optional_. An independent kernel version string. This is typically the entire output of the `uname` syscall. `rooted` -: _Optional_. A flag indicating whether the OS has been jailbroken or rooted. +_Optional_. A flag indicating whether the OS has been jailbroken or rooted. `theme` -: _Optional_. Either `light` or `dark`. Describes whether the OS runs in dark mode or not. +_Optional_. Either `light` or `dark`. Describes whether the OS runs in dark mode or not. `raw_description` -: _Optional_. An unprocessed description string obtained by the operating +_Optional_. An unprocessed description string obtained by the operating system. For some well-known runtimes, Sentry will attempt to parse `name` and `version` from this string, if they are not explicitly given. `distribution` -: _Optional_. An object that provides meta-data for Linux distributions. The values correspond to entries from the [`/etc/os-release`](https://www.freedesktop.org/software/systemd/man/latest/os-release.html#Options) configuration. Contains the following keys: +_Optional_. An object that provides meta-data for Linux distributions. The values correspond to entries from the [`/etc/os-release`](https://www.freedesktop.org/software/systemd/man/latest/os-release.html#Options) configuration. Contains the following keys: - `name`: A stable name for each distribution. This maps to `ID` in `/etc/os-release` (examples: `ubuntu`, `rhel`, `alpine`; a full list of tested identifiers is available in the [Native SDK repository](https://github.com/getsentry/sentry-native/blob/feat/add_linux_distros_to_os_context/tests/fixtures/os_releases/distribution_names.txt). @@ -324,15 +324,15 @@ The `type` and default key is `"runtime"`. `name` -: _Recommended_. The name of the runtime. It might be derived from `raw_description`. It is **required** if `raw_description` is not provided. +_Recommended_. The name of the runtime. It might be derived from `raw_description`. It is **required** if `raw_description` is not provided. `version` -: _Optional_. The version identifier of the runtime. +_Optional_. The version identifier of the runtime. `raw_description` -: _Optional_. An unprocessed description string obtained by the runtime. For +_Optional_. An unprocessed description string obtained by the runtime. For some well-known runtimes, Sentry will attempt to parse `name` and `version` from this string, if they are not explicitly given. @@ -346,53 +346,53 @@ The `type` and default key is `"app"`. `app_start_time` -: _Optional_. Formatted UTC timestamp when the user started the application. +_Optional_. Formatted UTC timestamp when the user started the application. `device_app_hash` -: _Optional_. Application-specific device identifier. +_Optional_. Application-specific device identifier. `build_type` -: _Optional_. String identifying the kind of build. For example, `testflight`. +_Optional_. String identifying the kind of build. For example, `testflight`. `app_identifier` -: _Optional_. Version-independent application identifier, often a dotted bundle +_Optional_. Version-independent application identifier, often a dotted bundle ID. `app_name` -: _Optional_. Human readable application name, as it appears on the platform. +_Optional_. Human readable application name, as it appears on the platform. `app_version` -: _Optional_. Human readable application version, as it appears on the platform. +_Optional_. Human readable application version, as it appears on the platform. `app_build` -: _Optional_. Internal build identifier, as it appears on the platform. +_Optional_. Internal build identifier, as it appears on the platform. `app_memory` -: _Optional_. Amount of memory used by the application in bytes. +_Optional_. Amount of memory used by the application in bytes. `app_arch` -: _Optional_. The CPU architecture of the application. This may differ from the device CPU architecture. +_Optional_. The CPU architecture of the application. This may differ from the device CPU architecture. `in_foreground` -: _Optional_. A flag indicating whether the app is in foreground or not. An app is in foreground when it's visible to the user. +_Optional_. A flag indicating whether the app is in foreground or not. An app is in foreground when it's visible to the user. `permissions` -: _Optional_. A dictionary of permissions that the application uses. Each entry in the dictionary conforms to the following structure: `: 'granted|denied|not_granted'`. +_Optional_. A dictionary of permissions that the application uses. Each entry in the dictionary conforms to the following structure: `: 'granted|denied|not_granted'`. If a platform doesn't provide capabilities to identify whether a permission has been `denied`, then `not_granted` can be used. `view_names` -: _Optional_. A list of visible UI screens at the current point in time. +_Optional_. A list of visible UI screens at the current point in time. ## Browser Context @@ -404,11 +404,11 @@ The `type` and default key is `"browser"`. `name` -: **Required**. Display name of the browser application. +**Required**. Display name of the browser application. `version` -: _Optional_. Version string of the browser. +_Optional_. Version string of the browser. ## GPU Context @@ -416,65 +416,65 @@ GPU context describes the GPU of the device. `name` -: **Required**. The name of the graphics device. +**Required**. The name of the graphics device. `version` -: _Optional_. The Version of the graphics device. +_Optional_. The Version of the graphics device. `id` -: _Optional_. The PCI identifier of the graphics device. +_Optional_. The PCI identifier of the graphics device. `vendor_id` -: _Optional_. The PCI vendor identifier of the graphics device. +_Optional_. The PCI vendor identifier of the graphics device. `vendor_name` -: _Optional_. The vendor name as reported by the graphics device. +_Optional_. The vendor name as reported by the graphics device. `memory_size` -: _Optional_. The total GPU memory available in Megabytes. +_Optional_. The total GPU memory available in Megabytes. `api_type` -: _Optional_. The device low-level API type. +_Optional_. The device low-level API type. Examples: `"Apple Metal"` or `"Direct3D11"` `multi_threaded_rendering` -: _Optional_. Whether the GPU has multi-threaded rendering or not. +_Optional_. Whether the GPU has multi-threaded rendering or not. `npot_support` -: _Optional_. The Non-Power-Of-Two-Support support. +_Optional_. The Non-Power-Of-Two-Support support. `max_texture_size` -: _Optional_. Largest size of a texture that is supported by the graphics hardware. For example, `16384`. +_Optional_. Largest size of a texture that is supported by the graphics hardware. For example, `16384`. `graphics_shader_level` -: _Optional_. Approximate "shader capability" level of the graphics device. For example, `Shader Model 2.0, OpenGL ES 3.0, Metal / OpenGL ES 3.1, 27 (unknown)`. +_Optional_. Approximate "shader capability" level of the graphics device. For example, `Shader Model 2.0, OpenGL ES 3.0, Metal / OpenGL ES 3.1, 27 (unknown)`. `supports_draw_call_instancing` -: _Optional_. Is GPU draw call instancing supported? +_Optional_. Is GPU draw call instancing supported? `supports_ray_tracing` -: _Optional_. Is ray tracing available on the device? +_Optional_. Is ray tracing available on the device? `supports_compute_shaders` -: _Optional_. Are compute shaders available on the device? +_Optional_. Are compute shaders available on the device? `supports_geometry_shaders` -: _Optional_. Are geometry shaders available on the device? +_Optional_. Are geometry shaders available on the device? ### Example GPU Context @@ -502,7 +502,7 @@ The `type` and default key is `"state"`. `state` -: **Required**. Object with two keys: _Optional_ `type` for naming the state library (e.g.: Redux, MobX, Vuex) and **Required** `value` that holds the state object. +**Required**. Object with two keys: _Optional_ `type` for naming the state library (e.g.: Redux, MobX, Vuex) and **Required** `value` that holds the state object. ### Example State Context @@ -532,23 +532,23 @@ The `type` and default key is `"culture"`. `calendar` -: _Optional_. For example `GregorianCalendar`. Free form string. +_Optional_. For example `GregorianCalendar`. Free form string. `display_name` -: _Optional_. Human readable name of the culture. For example `English (United States)` +_Optional_. Human readable name of the culture. For example `English (United States)` `locale` -: _Optional_. The name identifier, usually following the RFC 4646. For example `en-US` or `pt-BR`. +_Optional_. The name identifier, usually following the RFC 4646. For example `en-US` or `pt-BR`. `is_24_hour_format` -: _Optional_. boolean, either `true` or `false`. +_Optional_. boolean, either `true` or `false`. `timezone` -: _Optional_. The timezone of the locale. For example, `Europe/Vienna`. +_Optional_. The timezone of the locale. For example, `Europe/Vienna`. ## Cloud Resource Context @@ -559,7 +559,7 @@ The `type` and default key is `"cloud_resource"`. `cloud.provider` -: _Optional_. Name of the cloud provider. +_Optional_. Name of the cloud provider. - List of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used: - `alibaba_cloud` - Alibaba Cloud @@ -572,37 +572,37 @@ The `type` and default key is `"cloud_resource"`. `cloud.account.id` -: _Optional_. The cloud account ID the resource is assigned to. +_Optional_. The cloud account ID the resource is assigned to. - Example: `111111111111` `cloud.region` -: _Optional_. The geographical region the resource is running. +_Optional_. The geographical region the resource is running. - Example: `us-central1` or `us-east-1` `cloud.availability_zone` -: _Optional_. Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running. +_Optional_. Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running. - Example: `us-east-1c` `cloud.platform` -: _Optional_. The cloud platform in use. The prefix of the service SHOULD match the one specified in `cloud.provider`. +_Optional_. The cloud platform in use. The prefix of the service SHOULD match the one specified in `cloud.provider`. - Example: `aws_ecs` `host.id` -: _Optional_. Unique host ID. +_Optional_. Unique host ID. - Example: `3635354529892309001` `host.type` -: _Optional_. Machine type of host. +_Optional_. Machine type of host. - Example: `t4g.medium` @@ -632,31 +632,31 @@ Additional information that allows Sentry to connect multiple transactions, span `trace_id` -: _Required_. The trace ID. Determines which `trace` the Span/Transaction belongs to. The value should be 16 random bytes encoded as a hex string (32 characters long). +_Required_. The trace ID. Determines which `trace` the Span/Transaction belongs to. The value should be 16 random bytes encoded as a hex string (32 characters long). - Example: `"8f431b7aa08441bbbd5a0100fd91f9fe"` `span_id` -: _Required_. The ID of the span. +_Required_. The ID of the span. - Example: `"bb8f278130535c3c"` `parent_span_id` -: _Optional_. The ID of the span enclosing this span. +_Optional_. The ID of the span enclosing this span. - Example: `null` or `"a8972eefa820e2ff"` `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](https://develop.sentry.dev/sdk/performance/span-operations/). - Example: `"http.server"` `status` -: _Optional_. Whether the trace failed or succeeded. Currently only used to indicate status of individual transactions. +_Optional_. Whether the trace failed or succeeded. Currently only used to indicate status of individual transactions. - Example: `"ok"` @@ -684,35 +684,35 @@ Additional information that allows Sentry to connect multiple transactions, span `exclusive_time` -: _Optional_. The amount of time in milliseconds spent in this transaction span, excluding its immediate child spans. +_Optional_. The amount of time in milliseconds spent in this transaction span, excluding its immediate child spans. - Example: `1.035` `client_sample_rate` -: _Optional_. The client-side sample rate. +_Optional_. The client-side sample rate. - Example: `0.1` `tags` -: _Optional_. A map or list of tags for this event. Each tag must be less than 200 characters. +_Optional_. A map or list of tags for this event. Each tag must be less than 200 characters. - Example: `{ "deviceMemory": "8 GB", "effectiveConnectionType": "4g", "routing.instrumentation": "react-router-v3" }` `dynamic_sampling_context` -: _Optional_. The [Dynamic Sampling Context](https://develop.sentry.dev/sdk/performance/dynamic-sampling-context/). +_Optional_. The [Dynamic Sampling Context](https://develop.sentry.dev/sdk/performance/dynamic-sampling-context/). - Example: `{ "trace_id": "12312012123120121231201212312012", "sample_rate": "1.0", "public_key": "93D0D1125146288EAEE2A9B3AF4F96CCBE3CB316" },` `origin` -: _Optional_. The origin of the trace indicates what created the trace. For more details, see trace origin. +_Optional_. The origin of the trace indicates what created the trace. For more details, see trace origin. `data` -: _Optional_. The map of custom provided data. Currently Sentry SDKs can set following fields: +_Optional_. The map of custom provided data. Currently Sentry SDKs can set following fields: | Field | Type | Description | | ---------------- | ----------------- | ------------------------------------------------------------ | @@ -772,7 +772,7 @@ envelope endpoint. `replay_id` -: **Required**. The replay_id associated with the event. +**Required**. The replay_id associated with the event. ### Example Replay Context @@ -796,7 +796,7 @@ This is mostly set on transactions in a web server environment where one transac `status_code` -: **Required.** The integer status code from the HTTP response associated with the event. +**Required.** The integer status code from the HTTP response associated with the event. - Example: `200` diff --git a/develop-docs/sdk/event-payloads/debugmeta.mdx b/develop-docs/sdk/event-payloads/debugmeta.mdx index b322d0cf98f5d..cdf8c43d76a9b 100644 --- a/develop-docs/sdk/event-payloads/debugmeta.mdx +++ b/develop-docs/sdk/event-payloads/debugmeta.mdx @@ -48,11 +48,11 @@ Attributes: `type` -: **Required**. Type of the debug image. Must be `"macho"`. +**Required**. Type of the debug image. Must be `"macho"`. `image_addr` -: **Required**. Memory address, at which the image is mounted in the virtual +**Required**. Memory address, at which the image is mounted in the virtual address space of the process. Should be a string in hex representation prefixed with `"0x"`. @@ -63,29 +63,29 @@ the image spans up to the next image, which might lead to invalid stack traces. `debug_id` -: **Required**. Identifier of the dynamic library or executable. It is the value +**Required**. Identifier of the dynamic library or executable. It is the value of the `LC_UUID` load command in the Mach header, formatted as UUID. `debug_file` -: _Optional_: Name or absolute path to the dSYM file containing debug +_Optional_: Name or absolute path to the dSYM file containing debug information for this image. This value might be required to retrieve debug files from certain symbol servers. `code_id` -: _Optional_. Identifier of the dynamic library or executable. It is the value +_Optional_. Identifier of the dynamic library or executable. It is the value of the `LC_UUID` load command in the Mach header, formatted as UUID. Can be empty for Mach images, as it is equivalent to the debug identifier. `code_file` -: _Optional_. The absolute path to the dynamic library or executable. This helps +_Optional_. The absolute path to the dynamic library or executable. This helps to locate the file if it is missing on Sentry. `image_vmaddr` -: _Optional_: Preferred load address of the image in virtual memory, as declared +_Optional_: Preferred load address of the image in virtual memory, as declared in the headers of the image. When loading an image, the operating system may still choose to place it at a different address. @@ -100,7 +100,7 @@ the preferred address space, and not relative address space. `arch` -: _Optional_: Architecture of the module. If missing, this will be backfilled by +_Optional_: Architecture of the module. If missing, this will be backfilled by Sentry. Example: @@ -127,23 +127,23 @@ Attributes: `type` -: **Required**. Type of the debug image. Must be `"elf"`. +**Required**. Type of the debug image. Must be `"elf"`. `image_addr` -: **Required**. Memory address, at which the image is mounted in the virtual +**Required**. Memory address, at which the image is mounted in the virtual address space of the process. Should be a string in hex representation prefixed with `"0x"`. `image_size` -: **Required**. The size of the image in virtual memory. If missing, Sentry will +**Required**. The size of the image in virtual memory. If missing, Sentry will assume that the image spans up to the next image, which might lead to invalid stack traces. `debug_id` -: **Required**. Debug identifier of the dynamic library or executable. If a code +**Required**. Debug identifier of the dynamic library or executable. If a code identifier is available, the debug identifier is the _little-endian UUID_ representation of the first 16-bytes of that identifier. Spaces are inserted for readability, note the byte order of the first fields: @@ -159,13 +159,13 @@ as a little-endian UUID (again swapping the byte order). `debug_file` -: _Optional_: Name or absolute path to the file containing stripped debug +_Optional_: Name or absolute path to the file containing stripped debug information for this image. This value might be required to retrieve debug files from certain symbol servers. `code_id` -: _Optional_. Identifier of the dynamic library or executable. If the program +_Optional_. Identifier of the dynamic library or executable. If the program was compiled with a relatively recent compiler, this should be the hex representation of the `NT_GNU_BUILD_ID` program header (type `PT_NOTE`), or the value of the `.note.gnu.build-id` note section (type `SHT_NOTE`). @@ -176,12 +176,12 @@ ELF images, in which case this field should be included if possible. `code_file` -: _Optional_. The absolute path to the dynamic library or executable. This helps +_Optional_. The absolute path to the dynamic library or executable. This helps to locate the file if it is missing on Sentry. `image_vmaddr` -: _Optional_: Preferred load address of the image in virtual memory, as declared +_Optional_: Preferred load address of the image in virtual memory, as declared in the headers of the image. When loading an image, the operating system may still choose to place it at a different address. @@ -196,7 +196,7 @@ space, and not relative address space. `arch` -: _Optional_: Architecture of the module. If missing, this will be backfilled by +_Optional_: Architecture of the module. If missing, this will be backfilled by Sentry. Example: @@ -221,23 +221,23 @@ debugging. Their structure is identical to other native images. `type` -: **Required**. Type of the debug image. Must be `"pe"`. +**Required**. Type of the debug image. Must be `"pe"`. `image_addr` -: **Required**. Memory address, at which the image is mounted in the virtual +**Required**. Memory address, at which the image is mounted in the virtual address space of the process. Should be a string in hex representation prefixed with `"0x"`. `image_size` -: **Required**. The actual size of the image in virtual memory. If missing, +**Required**. The actual size of the image in virtual memory. If missing, Sentry will assume that the image spans up to the next image, which might lead to invalid stack traces. `debug_id` -: **Required**. `signature` and `age` of the PDB file. Both values can be read +**Required**. `signature` and `age` of the PDB file. Both values can be read from the CodeView PDB70 debug information header in the PE. The value should be represented as _little-endian UUID_, with the age appended at the end. Note that the byte order of the UUID fields must be swapped (spaces inserted for @@ -251,13 +251,13 @@ debug_id: c0bcc3f1-9827-fe65-3058-404b2831d9e6-1 `debug_file` -: **Required**: Name of the PDB file containing debug information for this +**Required**: Name of the PDB file containing debug information for this image. This value is often required to retrieve debug files from specific symbol servers. `code_id` -: _Optional_. Identifier of the executable or DLL. It contains the values of the +_Optional_. Identifier of the executable or DLL. It contains the values of the `time_date_stamp` from the COFF header and `size_of_image` from the optional header formatted together into a hex string using `%08x%X` (note that the second value is not padded): @@ -273,13 +273,13 @@ binary crash reports, such as Minidumps. `code_file` -: _Optional_. The absolute path to the DLL or executable. This helps to locate +_Optional_. The absolute path to the DLL or executable. This helps to locate the file if it is missing on Sentry. The code file should be provided to allow server-side stack walking of binary crash reports, such as Minidumps. `image_vmaddr` -: _Optional_: Preferred load address of the image in virtual memory, as declared +_Optional_: Preferred load address of the image in virtual memory, as declared in the headers of the image. When loading an image, the operating system may still choose to place it at a different address. @@ -289,7 +289,7 @@ to the loader. `arch` -: _Optional_: Architecture of the module. If missing, this will be backfilled by +_Optional_: Architecture of the module. If missing, this will be backfilled by Sentry. Example: @@ -317,30 +317,30 @@ Attributes: `type` -: **Required**. Type of the debug image. Must be `"wasm"`. +**Required**. Type of the debug image. Must be `"wasm"`. `debug_id` -: **Required**. Identifier of the dynamic library or executable. It is the value +**Required**. Identifier of the dynamic library or executable. It is the value of the `build_id` custom section and must be formatted as UUID truncated to the leading 16 bytes. `debug_file` -: _Optional_. Name or absolute URL to the WASM file containing debug +_Optional_. Name or absolute URL to the WASM file containing debug information for this image. This value might be required to retrieve debug files from certain symbol servers. This should correspond to the externalized URL pulled from the `external_debug_info` custom section. `code_id` -: _Optional_. Identifier of the WASM file. It is the value of the +_Optional_. Identifier of the WASM file. It is the value of the `build_id` custom section formatted as HEX string. It can be omitted in case the section contains a UUID (16 bytes). `code_file` -: **Required**. The absolute URL to the wasm file. This helps +**Required**. The absolute URL to the wasm file. This helps to locate the file if it is missing on Sentry. Example: @@ -361,7 +361,7 @@ which has to be included in the list of images. `uuid` -: **Required**. The unique identifier assigned by the Java SDK. +**Required**. The unique identifier assigned by the Java SDK. Example: @@ -383,16 +383,16 @@ Attributes: `type` -: **Required**. Type of the debug image. Must be `"sourcemap"`. +**Required**. Type of the debug image. Must be `"sourcemap"`. `code_file` -: **Required**. Path/Url of the file that should be mapped. Corresponds to the +**Required**. Path/Url of the file that should be mapped. Corresponds to the `abs_path` property inside a stack frame. `debug_id` -: **Required**. Identifier of the file that will be used to resolve the source +**Required**. Identifier of the file that will be used to resolve the source file. ```json diff --git a/develop-docs/sdk/event-payloads/lockreason.mdx b/develop-docs/sdk/event-payloads/lockreason.mdx index 58768cd09b7e1..9017a550ab159 100644 --- a/develop-docs/sdk/event-payloads/lockreason.mdx +++ b/develop-docs/sdk/event-payloads/lockreason.mdx @@ -16,23 +16,23 @@ Lock reasons are always part of a [thread](/sdk/event-payloads/threads/). They c `type` -: **Required**. Type of lock on the thread with available options being blocked, waiting, sleeping and locked. +**Required**. Type of lock on the thread with available options being blocked, waiting, sleeping and locked. `address` -: _Optional_. Memory address of the monitor object. +_Optional_. Memory address of the monitor object. `package_name` -: _Optional_. Package name of the monitor object. +_Optional_. Package name of the monitor object. `class_name` -: _Optional_. Class name of the monitor object. +_Optional_. Class name of the monitor object. `thread_id` -: _Optional_. Thread ID that's holding the lock. +_Optional_. Thread ID that's holding the lock. ## Examples diff --git a/develop-docs/sdk/event-payloads/message.mdx b/develop-docs/sdk/event-payloads/message.mdx index 1bd5746fb4f0c..4759980d018ba 100644 --- a/develop-docs/sdk/event-payloads/message.mdx +++ b/develop-docs/sdk/event-payloads/message.mdx @@ -11,7 +11,7 @@ help to group similar messages into the same issue. `formatted` -: **Required**. The fully formatted message. If missing, Sentry will try to +**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 @@ -19,13 +19,13 @@ help to group similar messages into the same issue. `message` -: _Optional_. The raw message string (uninterpolated). +_Optional_. The raw message string (uninterpolated). It must not exceed 8192 characters. Longer messages will be truncated. `params` -: _Optional_: A list of formatting parameters, preferably strings. Non-strings +_Optional_: A list of formatting parameters, preferably strings. Non-strings will be coerced to strings. diff --git a/develop-docs/sdk/event-payloads/properties/contexts_trace.mdx b/develop-docs/sdk/event-payloads/properties/contexts_trace.mdx index 69cab7262377e..f07531b218d8c 100644 --- a/develop-docs/sdk/event-payloads/properties/contexts_trace.mdx +++ b/develop-docs/sdk/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/event-payloads/contexts/#trace-context). ```json { diff --git a/develop-docs/sdk/event-payloads/properties/description.mdx b/develop-docs/sdk/event-payloads/properties/description.mdx index c3a23cf502d89..d743a45cf7413 100644 --- a/develop-docs/sdk/event-payloads/properties/description.mdx +++ b/develop-docs/sdk/event-payloads/properties/description.mdx @@ -1,6 +1,6 @@ `description` -: _Optional_. Longer description of the span's operation, which uniquely identifies the span but is consistent across instances of the span. +_Optional_. Longer description of the span's operation, which uniquely identifies the span but is consistent across instances of the span. ```json { diff --git a/develop-docs/sdk/event-payloads/properties/event_id.mdx b/develop-docs/sdk/event-payloads/properties/event_id.mdx index dc3404ae344ed..b0ebcf63b755b 100644 --- a/develop-docs/sdk/event-payloads/properties/event_id.mdx +++ b/develop-docs/sdk/event-payloads/properties/event_id.mdx @@ -1,6 +1,6 @@ `event_id` -: _Required_. Hexadecimal string representing a uuid4 value. The length is exactly 32 +_Required_. Hexadecimal string representing a uuid4 value. The length is exactly 32 characters. Dashes are not allowed. Has to be lowercase. ```json diff --git a/develop-docs/sdk/event-payloads/properties/measurements.mdx b/develop-docs/sdk/event-payloads/properties/measurements.mdx index 57d0cfdeade48..b690a482499b8 100644 --- a/develop-docs/sdk/event-payloads/properties/measurements.mdx +++ b/develop-docs/sdk/event-payloads/properties/measurements.mdx @@ -1,6 +1,6 @@ `measurements` -: _Optional_. An object containing standard/custom measurements with keys signifying the name of the measurement. +_Optional_. An object containing standard/custom measurements with keys signifying the name of the measurement. - Standard measurement keys currently supported are from the following list taken from [here](https://github.com/getsentry/sentry/blob/a8c960a933d2ded5225841573d8fc426a482ca9c/static/app/utils/discover/fields.tsx#L654-L676). diff --git a/develop-docs/sdk/event-payloads/properties/op.mdx b/develop-docs/sdk/event-payloads/properties/op.mdx index 3fc0aca482838..77ae8662100ac 100644 --- a/develop-docs/sdk/event-payloads/properties/op.mdx +++ b/develop-docs/sdk/event-payloads/properties/op.mdx @@ -1,6 +1,6 @@ `op` -: _Recommended_. Short code identifying the type of operation the span is measuring. +_Recommended_. Short code identifying the type of operation the span is measuring. For more details, see Sentry's conventions around span operations. diff --git a/develop-docs/sdk/event-payloads/properties/parent_span_id.mdx b/develop-docs/sdk/event-payloads/properties/parent_span_id.mdx index e418c32cf7b76..e231470222ad0 100644 --- a/develop-docs/sdk/event-payloads/properties/parent_span_id.mdx +++ b/develop-docs/sdk/event-payloads/properties/parent_span_id.mdx @@ -1,6 +1,6 @@ `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. +_Optional_. If this Span should be rendered as a child of another Span, set this property to the id of the parent. ```json { diff --git a/develop-docs/sdk/event-payloads/properties/span_id.mdx b/develop-docs/sdk/event-payloads/properties/span_id.mdx index 53d5d730acdf2..1232e72c4831f 100644 --- a/develop-docs/sdk/event-payloads/properties/span_id.mdx +++ b/develop-docs/sdk/event-payloads/properties/span_id.mdx @@ -1,6 +1,6 @@ `span_id`: -: _Required_. A random hex string with a length of 16 characters. +_Required_. A random hex string with a length of 16 characters. ```json { diff --git a/develop-docs/sdk/event-payloads/properties/span_start_timestamp.mdx b/develop-docs/sdk/event-payloads/properties/span_start_timestamp.mdx index a9cbf9d310245..549a73eed98cb 100644 --- a/develop-docs/sdk/event-payloads/properties/span_start_timestamp.mdx +++ b/develop-docs/sdk/event-payloads/properties/span_start_timestamp.mdx @@ -1,6 +1,6 @@ `start_timestamp` -: _Required_. A timestamp representing when the measuring started. The +_Required_. A timestamp representing when the measuring started. 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 [Unix diff --git a/develop-docs/sdk/event-payloads/properties/span_timestamp.mdx b/develop-docs/sdk/event-payloads/properties/span_timestamp.mdx index 88b88ae0f9437..736bdd9c69ef2 100644 --- a/develop-docs/sdk/event-payloads/properties/span_timestamp.mdx +++ b/develop-docs/sdk/event-payloads/properties/span_timestamp.mdx @@ -1,6 +1,6 @@ `timestamp` -: _Required_. A timestamp representing when the measuring finished. The +_Required_. A timestamp representing when the measuring finished. 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 [Unix diff --git a/develop-docs/sdk/event-payloads/properties/spans.mdx b/develop-docs/sdk/event-payloads/properties/spans.mdx index ea83d55fc6ffb..94c2824966263 100644 --- a/develop-docs/sdk/event-payloads/properties/spans.mdx +++ b/develop-docs/sdk/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/event-payloads/span/). ```json { diff --git a/develop-docs/sdk/event-payloads/properties/status.mdx b/develop-docs/sdk/event-payloads/properties/status.mdx index 8647fadc3fdf0..04eec70771661 100644 --- a/develop-docs/sdk/event-payloads/properties/status.mdx +++ b/develop-docs/sdk/event-payloads/properties/status.mdx @@ -1,6 +1,6 @@ `status` -: _Optional_. Describes the `status` of the Span/Transaction. +_Optional_. Describes the `status` of the Span/Transaction. | State | Description | HTTP status code equivalent | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------- | diff --git a/develop-docs/sdk/event-payloads/properties/tags.mdx b/develop-docs/sdk/event-payloads/properties/tags.mdx index 9241d8db103e8..fad614063b029 100644 --- a/develop-docs/sdk/event-payloads/properties/tags.mdx +++ b/develop-docs/sdk/event-payloads/properties/tags.mdx @@ -1,6 +1,6 @@ `tags` -: _Optional_. A map or list of tags for this event. Each tag must be less than 200 characters. +_Optional_. A map or list of tags for this event. Each tag must be less than 200 characters. ```json { diff --git a/develop-docs/sdk/event-payloads/properties/trace_id.mdx b/develop-docs/sdk/event-payloads/properties/trace_id.mdx index 49f747da7f2ed..a9c1f2ec0eddf 100644 --- a/develop-docs/sdk/event-payloads/properties/trace_id.mdx +++ b/develop-docs/sdk/event-payloads/properties/trace_id.mdx @@ -1,6 +1,6 @@ `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). +_Required_. Determines which `trace` the Span belongs to. The value should be 16 random bytes encoded as a hex string (32 characters long). ```json { diff --git a/develop-docs/sdk/event-payloads/properties/transaction_info.mdx b/develop-docs/sdk/event-payloads/properties/transaction_info.mdx index 069f36ef2ba24..57de6655116db 100644 --- a/develop-docs/sdk/event-payloads/properties/transaction_info.mdx +++ b/develop-docs/sdk/event-payloads/properties/transaction_info.mdx @@ -1,6 +1,6 @@ `transaction_info` -: _Recommended_. Additional information about the name of the transaction. +_Recommended_. Additional information about the name of the transaction. ```json { @@ -12,7 +12,7 @@ `transaction_info.source` -: _Required_. This information is required by dynamic sampling. +_Required_. This information is required by dynamic sampling. Contains information about how the name of the transaction was determined. This will be used by the server to decide whether or not to scrub identifiers from the transaction name, or replace the entire name with a placeholder. The `source` should diff --git a/develop-docs/sdk/event-payloads/properties/type.mdx b/develop-docs/sdk/event-payloads/properties/type.mdx index 42d7785b392e5..7f8812a6b9b3d 100644 --- a/develop-docs/sdk/event-payloads/properties/type.mdx +++ b/develop-docs/sdk/event-payloads/properties/type.mdx @@ -1,6 +1,6 @@ `type` -: _Required_. A Transaction has to have this value set to `transaction`. +_Required_. A Transaction has to have this value set to `transaction`. ```json { diff --git a/develop-docs/sdk/event-payloads/request.mdx b/develop-docs/sdk/event-payloads/request.mdx index 31b098c8924d3..5d3537381c17d 100644 --- a/develop-docs/sdk/event-payloads/request.mdx +++ b/develop-docs/sdk/event-payloads/request.mdx @@ -44,16 +44,16 @@ Example of the same headers as list of tuples: `method` -: _Optional_. The HTTP method of the request. +_Optional_. The HTTP method of the request. `url` -: _Optional_. The URL of the request if available. The query string can be +_Optional_. The URL of the request if available. The query string can be declared either as part of the `url`, or separately in `query_string`. `query_string` -: _Optional_. The query string component of the URL. Can be given as unparsed +_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 @@ -61,7 +61,7 @@ Example of the same headers as list of tuples: `data` -: _Optional_. Submitted data in a format that makes the most sense. SDKs should +_Optional_. Submitted data in a format that makes the most sense. SDKs should discard large bodies by default. Can be given as string or structural data of any format. @@ -73,18 +73,18 @@ Example of the same headers as list of tuples: `cookies` -: _Optional_. The cookie values. Can be given unparsed as string, as dictionary, +_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 +_Optional_. A dictionary of submitted headers. If a header appears multiple times it, needs to be merged according to the HTTP standard for header merging. Header names are treated case-insensitively by Sentry. `env` -: _Optional_. A dictionary containing environment information passed from the +_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. diff --git a/develop-docs/sdk/event-payloads/sdk.mdx b/develop-docs/sdk/event-payloads/sdk.mdx index 8957abf377e70..c5a20d1491616 100644 --- a/develop-docs/sdk/event-payloads/sdk.mdx +++ b/develop-docs/sdk/event-payloads/sdk.mdx @@ -10,7 +10,7 @@ and transmit an event. `name` -: **Required**. The name of the SDK. The format is `entity.ecosystem[.flavor]` +**Required**. The name of the SDK. The format is `entity.ecosystem[.flavor]` where _entity_ identifies the developer of the SDK, _ecosystem_ refers to the programming language or platform where the SDK is to be used and the optional _flavor_ is used to identify standalone SDKs that are part of a major @@ -39,7 +39,7 @@ Android SDK `version` -: **Required**. The version of the SDK. It should have the [Semantic +**Required**. The version of the SDK. It should have the [Semantic Versioning](https://semver.org) format `MAJOR.MINOR.PATCH`, without any prefix (no `v` or anything else in front of the major version number). Examples: @@ -49,21 +49,21 @@ Versioning](https://semver.org) format `MAJOR.MINOR.PATCH`, without any prefix `integrations` -: _Optional_. A list of names identifying enabled integrations. The list should +_Optional_. A list of names identifying enabled integrations. The list should have all enabled integrations, including default integrations. Default integrations are included because different SDK releases may contain different default integrations. `features` -: _Optional_. A list of feature names identifying enabled SDK features. This list +_Optional_. A list of feature names identifying enabled SDK features. This list should contain all enabled SDK features. On some SDKs, enabling a feature in the options also adds an integration. We encourage tracking such features with either integrations or features but not both to reduce the payload size. `packages` -: _Optional_. A list of packages that were installed as part of this SDK or the +_Optional_. A list of packages that were installed as part of this SDK or the activated integrations. Each package consists of a `name` in the format `source:identifier` and `version`. If the source is a Git repository, the source should be `git`, the `identifier` should be a checkout link and the `version` should be a Git diff --git a/develop-docs/sdk/event-payloads/span.mdx b/develop-docs/sdk/event-payloads/span.mdx index 15cf247a38c29..186625abbf1c2 100644 --- a/develop-docs/sdk/event-payloads/span.mdx +++ b/develop-docs/sdk/event-payloads/span.mdx @@ -30,7 +30,7 @@ import "./properties/tags.mdx"; `data` -: _Optional_. Arbitrary data associated with this Span. +_Optional_. Arbitrary data associated with this Span. The semantic conventions for the `data` field are described in Sentry's Span Convention Documentation. @@ -47,7 +47,7 @@ The semantic conventions for the `data` field are described in trace origin. +_Optional_. The origin of the span indicates what created the span. For more details, see trace origin. ## Examples diff --git a/develop-docs/sdk/event-payloads/stacktrace.mdx b/develop-docs/sdk/event-payloads/stacktrace.mdx index e37956f84dec2..5e4e1596c5c12 100644 --- a/develop-docs/sdk/event-payloads/stacktrace.mdx +++ b/develop-docs/sdk/event-payloads/stacktrace.mdx @@ -22,13 +22,13 @@ follow this rule of thumb: `frames` -: **Required**. A non-empty list of stack frames (see below). The list is +**Required**. A non-empty list of stack frames (see below). The list is ordered from caller to callee, or oldest to youngest. The last frame is the one creating the exception. `registers` -: _Optional_. A map of register names and their values. The values should +_Optional_. A map of register names and their values. The values should contain the actual register values of the thread, thus mapping to the last frame in the list. diff --git a/develop-docs/sdk/event-payloads/threads.mdx b/develop-docs/sdk/event-payloads/threads.mdx index d3e0a7f63a6cc..7a1500d4f667b 100644 --- a/develop-docs/sdk/event-payloads/threads.mdx +++ b/develop-docs/sdk/event-payloads/threads.mdx @@ -20,41 +20,41 @@ exception and Sentry will connect the two. `id` -: **Required**. The ID of the thread. Typically a number or numeric string. +**Required**. The ID of the thread. Typically a number or numeric string. Needs to be unique among the threads. An exception can set the `thread_id` attribute to cross-reference this thread. `crashed` -: _Optional_. A flag indicating whether the thread was the cause for the event being sent, e.g. due to a crash. +_Optional_. A flag indicating whether the thread was the cause for the event being sent, e.g. due to a crash. Defaults to `false`. `current` -: _Optional_. A flag indicating whether the thread was in the foreground. A thread is in foreground when it's executing. +_Optional_. A flag indicating whether the thread was in the foreground. A thread is in foreground when it's executing. Defaults to `false`. `main` -: _Optional_. If applicable, a flag indicating whether the thread was responsible for rendering the user interface. +_Optional_. If applicable, a flag indicating whether the thread was responsible for rendering the user interface. On mobile platforms this is oftentimes referred to as the "main thread" or "ui thread". `name` -: _Optional_. The thread name. +_Optional_. The thread name. `state` -: _Optional_. State of the thread at the time of the event. +_Optional_. State of the thread at the time of the event. `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` -: _Optional_. A stack trace object corresponding to the [Stack Trace Interface](/sdk/event-payloads/stacktrace/). +_Optional_. A stack trace object corresponding to the [Stack Trace Interface](/sdk/event-payloads/stacktrace/). If this is an error event, the stack trace of the main exception should be declared in the [Exception Interface](/sdk/event-payloads/exception/) instead. diff --git a/develop-docs/sdk/overview.mdx b/develop-docs/sdk/overview.mdx index 55ca3987eb783..f508c37290046 100644 --- a/develop-docs/sdk/overview.mdx +++ b/develop-docs/sdk/overview.mdx @@ -183,18 +183,19 @@ it’s possible to send these values via the querystring: `sentry_key` -: **Required.** The public key which should be provided as part of the SDK +**Required.** The public key which should be provided as part of the SDK configuration. `sentry_version` -: **Required.** The protocol version. The current version of the protocol is +**Required.** The protocol version. The current version of the protocol is `7`. `sentry_client` -: **Recommended.** An arbitrary string that identifies your SDK, including its version. The - typical pattern for this is `client_name/client_version`.
+ +**Recommended.** An arbitrary string that identifies your SDK, including its version. The + typical pattern for this is `client_name/client_version`.
For example, the Python SDK might send this as `sentry.python/1.0`. `sentry_timestamp` diff --git a/develop-docs/sdk/performance/trace-origin.mdx b/develop-docs/sdk/performance/trace-origin.mdx index c5f57e8baca9b..67a03f306c8fc 100644 --- a/develop-docs/sdk/performance/trace-origin.mdx +++ b/develop-docs/sdk/performance/trace-origin.mdx @@ -14,20 +14,20 @@ to skip one part. For example, you may send parts one and two but aren't allowed `type` -: _Required_. Can be either `manual` or `auto`. `manual` indicates that the user created the trace or span, `auto` indicates +_Required_. Can be either `manual` or `auto`. `manual` indicates that the user created the trace or span, `auto` indicates that the SDK or some integration created it. `category` -: _Optional_. Is the category of the trace or span, and it must be a category of span operations. For example, `http`, `db`, `ui`, `navigation`, `file`, `browser`, `rpc`, etc. +_Optional_. Is the category of the trace or span, and it must be a category of span operations. For example, `http`, `db`, `ui`, `navigation`, `file`, `browser`, `rpc`, etc. `integration-name` -: _Optional_. Is the name of the integration of the SDK that created the trace or span. +_Optional_. Is the name of the integration of the SDK that created the trace or span. `integration-part` -: _Optional_. Is the part of the integration of the SDK that created the trace or span. This is only useful when one integration creates multiple traces or spans, and you'd like to differentiate. Therefore, most of the time, this will be omitted. +_Optional_. Is the part of the integration of the SDK that created the trace or span. This is only useful when one integration creates multiple traces or spans, and you'd like to differentiate. Therefore, most of the time, this will be omitted. All parts can only contain: diff --git a/develop-docs/sdk/sessions.mdx b/develop-docs/sdk/sessions.mdx index 82858248b9724..4c3e6dd36d23f 100644 --- a/develop-docs/sdk/sessions.mdx +++ b/develop-docs/sdk/sessions.mdx @@ -86,34 +86,34 @@ The following fields exist: `sid` -: _String, optional_. Session ID (unique and client generated). +_String, optional_. Session ID (unique and client generated). Clients are allowed to skip it if the initial session state is `exited`. `did` -: _String, optional_. The distinct ID. Should be a device or user ID. +_String, optional_. The distinct ID. Should be a device or user ID. The system automatically hashes this ID before storing it. `seq` -: _Number, optional_. A logical clock. Defaults to the current UNIX timestamp +_Number, optional_. A logical clock. Defaults to the current UNIX timestamp in milliseconds during ingestion. The value `0` is reserved in the sense that a session with `init` set to `true` will automatically have `seq` forced to `0`. `timestamp` -: _String, optional_. The timestamp of when the session change event came in. +_String, optional_. The timestamp of when the session change event came in. Must be an ISO DateTime string. If not sent, the server will assume the current UTC timestamp. In the data model, this is called `received`. `started` -: **String, required**. Timestamp when the session started. +**String, required**. Timestamp when the session started. Must be an ISO DateTime string. `init` -: _Boolean, optional, default is `false`_. +_Boolean, optional, default is `false`_. If this is set to `true` it means that this was the first event of the session. This lets the server optimize the session counts because no deduplication is needed (client is authoritative anyways). Internally when this flag is set @@ -121,13 +121,13 @@ needed (client is authoritative anyways). Internally when this flag is set `duration` -: _Number, optional_. An optional field that can transmit the session duration +_Number, optional_. An optional field that can transmit the session duration when the event was received. This can be client controlled so, for instance, inactive time can be subtracted (seconds as float). `status` -: _String, optional, default is `ok`_. The current status of the session. +_String, optional, default is `ok`_. The current status of the session. A session can only be in two states effectively: `ok` which means the session is alive or one of the terminal states. When a session is moved away from `ok` it must not be updated anymore. @@ -139,7 +139,7 @@ it must not be updated anymore. `errors` -: _Number, optional, default is `0`_. A running counter of errors encountered +_Number, optional, default is `0`_. A running counter of errors encountered while this session was ongoing. It's important that this counter is also incremented when a session goes to `crashed`. (eg: the crash itself is always an error as well). @@ -147,14 +147,14 @@ Ingest should force `errors` to 1 if not set or 0. `abnormal_mechanism` -: _String, optional, default is `none`_. The mechanism that caused the session to finish with +_String, optional, default is `none`_. The mechanism that caused the session to finish with an `abnormal` status. This meta property is useful to determine abnormal session rate for specific cases, for example, on platforms like Android this is used to calculate user-perceived ANR rate. `attrs` -: **Object, required** _all keys but `release` optional_. An object with the following attributes: +**Object, required** _all keys but `release` optional_. An object with the following attributes: - `release`: The sentry release ID (`release`), suggested format `my-project-name@1.0.0`. - `environment`: The sentry environment (`environment`). @@ -211,7 +211,7 @@ something like this: `aggregates` -: **Array, required**. An array of aggregates grouped by their `started` timestamp and distinct id (did). +**Array, required**. An array of aggregates grouped by their `started` timestamp and distinct id (did). - `started`: **Required**. Timestamp of the group, rounded down to the minute. Must be an ISO DateTime string. - `did`: _Optional_. The distinct user id of the group. @@ -222,7 +222,7 @@ something like this: `attrs` -: **Object, required**. See above. +**Object, required**. See above. ## Crashes vs Sessions