From 4838eab2444f2bf6f0769546268673b39c5591ee Mon Sep 17 00:00:00 2001 From: Alex Jillard Date: Fri, 7 Jun 2024 16:18:46 -0400 Subject: [PATCH 1/8] adds searchable span properties --- .../search/searchable-properties/index.mdx | 1 + .../search/searchable-properties/spans.mdx | 190 ++++++++++++++++++ 2 files changed, 191 insertions(+) create mode 100644 docs/concepts/search/searchable-properties/spans.mdx diff --git a/docs/concepts/search/searchable-properties/index.mdx b/docs/concepts/search/searchable-properties/index.mdx index 70b2e4d4ffb5e..c8303c80e78bb 100644 --- a/docs/concepts/search/searchable-properties/index.mdx +++ b/docs/concepts/search/searchable-properties/index.mdx @@ -12,6 +12,7 @@ Sentry's searchable properties fall into one of five categories: - [Issue properties](/product/sentry-basics/search/searchable-properties/issues/) - [Event properties](/product/sentry-basics/search/searchable-properties/events/) +- [Span properties](/concepts/search/searchable-properties/spans/) - [Session Replay properties](/product/sentry-basics/search/searchable-properties/session-replay/) - [User Feedback properties](/product/sentry-basics/search/searchable-properties/user-feedback/) - [Release properties](/product/sentry-basics/search/searchable-properties/releases/) diff --git a/docs/concepts/search/searchable-properties/spans.mdx b/docs/concepts/search/searchable-properties/spans.mdx new file mode 100644 index 0000000000000..5ab89bf56bf7c --- /dev/null +++ b/docs/concepts/search/searchable-properties/spans.mdx @@ -0,0 +1,190 @@ +--- +title: Span Properties +description: "Learn more about searchable span properties." +sidebar_order: 21 +--- + +Spans are the underlying data element captured in Sentry SDKs to build a trace. + +You can search by span properties in the following [sentry.io](https://sentry.io) pages: + +- Traces - when searching for a trace containing spans with matching properties + +When searching on span properties within the **Traces** page, the search will return any trace that contains _one or more spans_ matching the supplied span properties filter. + +## Searchable Properties + +Below is a list of keys and tokens that can be used in the span search. + + + +### `action` + +The type of span action. + +- **Type:** string + +### `browser.name` + +The name of the browser that generated the span. + +- **Type:** string + +### `cache.hit` + +Whether a cache read has hit or missed the queried cache key. Values are `'true'` or `'false'`. + +- **Type:** string + +### `description` + +Parameterized and scrubbed description of the span. + +- **Type:** string + +### `device.class` + +Device class is a synthesized field calculated based off device info found in context such as model (for iOS devices), and device specs like processor_frequency (for Android devices). + +- **Type:** string + +### `environment` + +Refers to your code deployment naming convention. For example, `development`, `testing`, `staging` and so on. [Learn more](/product/sentry-basics/environments/). In some pages of [sentry.io](https://sentry.io/), you filter on environment using a dropdown. + +- **Type:** string + +### `file_extension` + +The file extension of a resource span. + +- **Type:** string + +### `http.decoded_response_content_length` + +The [decoded body size](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming/decodedBodySize) of the resource. + +- **Type:** string + +### `http.response_content_length` + +The [encoded body size](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming/encodedBodySize) of the resource. + +- **Type:** string + +### `http.response_transfer_size` + +The [total transfer size](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming/transferSize) of the resource. + +- **Type:** string + +### `messaging.destination.name` + +The queue name or topic from which the message is consumed from or published to. + +- **Type:** string + +### `messaging.message.id` + +The unique ID of a message from the queue or messaging system. + +- **Type:** string + +### `op` + +Span operation + +- **Type:** string + +### `os.name` + +Name of the operating system + +- **Type:** string + +### `platform` + +Name of the platform. This is only a metrics property for [valid platforms](https://github.com/getsentry/relay/blob/9d0d2dc54233d46043a369e1dacf7db900953c14/relay-general/src/protocol/constants.rs#L1-L21), defaulting to `other`. + +- **Type:** string + +### `release` + +A release is a version of your code deployed to an environment. You can create a token with an exact match of the version of a release, or `release:latest` to pick the most recent release. + +- **Type:** string + +### `resource.render_blocking_status` + +The [render blocking status](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming/renderBlockingStatus) of the resource. + +- **Type:** string + +### `sdk.name` + +Name of the Sentry SDK that sent the event. + +- **Type:** string + +### `sdk.version` + +Version of the Sentry SDK that sent the event. + +- **Type:** string + +### `status_code` + +The HTTP response status code. + +- **Type:** string + +### `system` + +Database system (e.g., `postresql` or `mysql`). + +- **Type:** string + +### `trace.status` + +The success or failure status of a span's trace. + +- **Type:** string + +### `transaction` + +Name of the containing transaction. + +- **Type:** string + + +### `transaction.method` + +HTTP method of the containing transaction. + +- **Type:** string + +### `transaction.op` + +Operation of the containing transaction. + +- **Type:** string + +### `user.email` + +An alternative, or addition, to the username. Sentry is aware of email addresses and can therefore display things such as Gravatars and unlock messaging capabilities. + +- **Type:** string + +### `user.id` + +Application-specific internal identifier for the user. + +- **Type:** string + +### `user.username` + +Username, which is typically a better label than the user.id. + +- **Type:** string + + From b012427e8fe4bb7465a2805d2bd9013e39baea7f Mon Sep 17 00:00:00 2001 From: Alex Jillard Date: Mon, 10 Jun 2024 16:19:26 -0400 Subject: [PATCH 2/8] Applying suggestions from PR Review Minor copy edits and punctuation Co-authored-by: Liza Mock --- .../search/searchable-properties/spans.mdx | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/concepts/search/searchable-properties/spans.mdx b/docs/concepts/search/searchable-properties/spans.mdx index 5ab89bf56bf7c..cdceb2235c9b3 100644 --- a/docs/concepts/search/searchable-properties/spans.mdx +++ b/docs/concepts/search/searchable-properties/spans.mdx @@ -4,17 +4,17 @@ description: "Learn more about searchable span properties." sidebar_order: 21 --- -Spans are the underlying data element captured in Sentry SDKs to build a trace. +Spans are the underlying data element captured in Sentry SDKs that together make up a trace. -You can search by span properties in the following [sentry.io](https://sentry.io) pages: +You can search by span properties in the following [Sentry](https://sentry.io) pages: - Traces - when searching for a trace containing spans with matching properties -When searching on span properties within the **Traces** page, the search will return any trace that contains _one or more spans_ matching the supplied span properties filter. +When you search for span properties within the **Traces** page, the search will return any trace that contains _one or more spans_ that match your span properties filter. ## Searchable Properties -Below is a list of keys and tokens that can be used in the span search. +Below is a list of keys and tokens that can be used in the span search: @@ -44,13 +44,13 @@ Parameterized and scrubbed description of the span. ### `device.class` -Device class is a synthesized field calculated based off device info found in context such as model (for iOS devices), and device specs like processor_frequency (for Android devices). +Device class is a synthesized field that's calculated by using device info found in context such as model (for iOS devices), and device specs like processor_frequency (for Android devices). - **Type:** string ### `environment` -Refers to your code deployment naming convention. For example, `development`, `testing`, `staging` and so on. [Learn more](/product/sentry-basics/environments/). In some pages of [sentry.io](https://sentry.io/), you filter on environment using a dropdown. +Refers to your code deployment naming convention. For example, `development`, `testing`, `staging` and so on. [Learn more](/product/sentry-basics/environments/). In some pages of [Sentry](https://sentry.io/), you filter on environment using a dropdown. - **Type:** string @@ -92,13 +92,13 @@ The unique ID of a message from the queue or messaging system. ### `op` -Span operation +Span operation. - **Type:** string ### `os.name` -Name of the operating system +Name of the operating system. - **Type:** string @@ -110,7 +110,7 @@ Name of the platform. This is only a metrics property for [valid platforms](http ### `release` -A release is a version of your code deployed to an environment. You can create a token with an exact match of the version of a release, or `release:latest` to pick the most recent release. +A release is a version of your code deployed to an environment. You can create a token that matches a release exactly, or pick the most recent release by using `release:latest`. - **Type:** string @@ -146,7 +146,7 @@ Database system (e.g., `postresql` or `mysql`). ### `trace.status` -The success or failure status of a span's trace. +The span trace's success or failure status. - **Type:** string @@ -171,7 +171,7 @@ Operation of the containing transaction. ### `user.email` -An alternative, or addition, to the username. Sentry is aware of email addresses and can therefore display things such as Gravatars and unlock messaging capabilities. +An alternative or addition to the username. Sentry is aware of email addresses and can therefore display things such as Gravatars and unlock messaging capabilities. - **Type:** string @@ -183,7 +183,7 @@ Application-specific internal identifier for the user. ### `user.username` -Username, which is typically a better label than the user.id. +Username, which is typically a better label than user.id. - **Type:** string From 6aafcd41687d34f86a062dc8f39677bbfb4d43db Mon Sep 17 00:00:00 2001 From: Alex Jillard Date: Mon, 10 Jun 2024 16:57:26 -0400 Subject: [PATCH 3/8] replaced github link to platform list with inline list of platforms --- docs/concepts/search/searchable-properties/events.mdx | 3 ++- docs/concepts/search/searchable-properties/spans.mdx | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/concepts/search/searchable-properties/events.mdx b/docs/concepts/search/searchable-properties/events.mdx index 237784af56442..6d66dc4b90029 100644 --- a/docs/concepts/search/searchable-properties/events.mdx +++ b/docs/concepts/search/searchable-properties/events.mdx @@ -480,7 +480,8 @@ Returns results with an approximate percentile of the field to the level. The le ### `platform` -Name of the platform. This is only a metrics property for [valid platforms](https://github.com/getsentry/relay/blob/9d0d2dc54233d46043a369e1dacf7db900953c14/relay-general/src/protocol/constants.rs#L1-L21), defaulting to `other`. +Name of the platform. This defaults to `other` and is only a property for platforms from this list: +`as3`, `c`, `cfml`, `cocoa`, `csharp`, `elixir`, `go`, `groovy`, `haskell`, `java`, `javascript`, `native`, `node`, `objc`, `other`, `perl`, `php`, `python`, `ruby` - **Type:** string diff --git a/docs/concepts/search/searchable-properties/spans.mdx b/docs/concepts/search/searchable-properties/spans.mdx index cdceb2235c9b3..26cd905ae83df 100644 --- a/docs/concepts/search/searchable-properties/spans.mdx +++ b/docs/concepts/search/searchable-properties/spans.mdx @@ -104,7 +104,8 @@ Name of the operating system. ### `platform` -Name of the platform. This is only a metrics property for [valid platforms](https://github.com/getsentry/relay/blob/9d0d2dc54233d46043a369e1dacf7db900953c14/relay-general/src/protocol/constants.rs#L1-L21), defaulting to `other`. +Name of the platform. This defaults to `other` and is only a property for platforms from this list: +`as3`, `c`, `cfml`, `cocoa`, `csharp`, `elixir`, `go`, `groovy`, `haskell`, `java`, `javascript`, `native`, `node`, `objc`, `other`, `perl`, `php`, `python`, `ruby` - **Type:** string From 5100201cab3ec2d5b72e4da941c4441f0ae13368 Mon Sep 17 00:00:00 2001 From: Alex Jillard Date: Mon, 10 Jun 2024 17:32:26 -0400 Subject: [PATCH 4/8] adding suggestions from code review Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- docs/concepts/search/searchable-properties/spans.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/search/searchable-properties/spans.mdx b/docs/concepts/search/searchable-properties/spans.mdx index 26cd905ae83df..0927eda51a97a 100644 --- a/docs/concepts/search/searchable-properties/spans.mdx +++ b/docs/concepts/search/searchable-properties/spans.mdx @@ -80,7 +80,7 @@ The [total transfer size](https://developer.mozilla.org/en-US/docs/Web/API/Perfo ### `messaging.destination.name` -The queue name or topic from which the message is consumed from or published to. +The queue name or topic that the message is written or published to. The consumer also reads from this queue. - **Type:** string From deda18660f288b406326f60a9d44623d1ecd46d0 Mon Sep 17 00:00:00 2001 From: Stephanie Anderson Date: Tue, 11 Jun 2024 14:13:16 +0200 Subject: [PATCH 5/8] Update docs/concepts/search/searchable-properties/spans.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- docs/concepts/search/searchable-properties/spans.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/search/searchable-properties/spans.mdx b/docs/concepts/search/searchable-properties/spans.mdx index 0927eda51a97a..82cdd9a58a904 100644 --- a/docs/concepts/search/searchable-properties/spans.mdx +++ b/docs/concepts/search/searchable-properties/spans.mdx @@ -141,7 +141,7 @@ The HTTP response status code. ### `system` -Database system (e.g., `postresql` or `mysql`). +Database system (e.g., `postgresql` or `mysql`). - **Type:** string From a032115824ebe694b2ab3465a6f64b60b2ebdf5f Mon Sep 17 00:00:00 2001 From: Stephanie Anderson Date: Tue, 11 Jun 2024 14:13:23 +0200 Subject: [PATCH 6/8] Update docs/concepts/search/searchable-properties/spans.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- docs/concepts/search/searchable-properties/spans.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/search/searchable-properties/spans.mdx b/docs/concepts/search/searchable-properties/spans.mdx index 82cdd9a58a904..24c606139d80a 100644 --- a/docs/concepts/search/searchable-properties/spans.mdx +++ b/docs/concepts/search/searchable-properties/spans.mdx @@ -44,7 +44,7 @@ Parameterized and scrubbed description of the span. ### `device.class` -Device class is a synthesized field that's calculated by using device info found in context such as model (for iOS devices), and device specs like processor_frequency (for Android devices). +Device class is a synthesized field that's calculated by using device info found in context such as model (for iOS devices), and device specs like `processor_frequency` (for Android devices). - **Type:** string From 4485a242e7591e231cf0e3acf2d4f18e67340458 Mon Sep 17 00:00:00 2001 From: Stephanie Anderson Date: Tue, 11 Jun 2024 14:13:30 +0200 Subject: [PATCH 7/8] Update docs/concepts/search/searchable-properties/spans.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- docs/concepts/search/searchable-properties/spans.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/search/searchable-properties/spans.mdx b/docs/concepts/search/searchable-properties/spans.mdx index 24c606139d80a..1b7b202c6aa1f 100644 --- a/docs/concepts/search/searchable-properties/spans.mdx +++ b/docs/concepts/search/searchable-properties/spans.mdx @@ -8,7 +8,7 @@ Spans are the underlying data element captured in Sentry SDKs that together make You can search by span properties in the following [Sentry](https://sentry.io) pages: -- Traces - when searching for a trace containing spans with matching properties +- [Traces](/product/explore/traces/) - when searching for a trace containing spans with matching properties When you search for span properties within the **Traces** page, the search will return any trace that contains _one or more spans_ that match your span properties filter. From 7529c798a94e460cce5f0e06a17c907c858dc314 Mon Sep 17 00:00:00 2001 From: Stephanie Anderson Date: Tue, 11 Jun 2024 14:13:38 +0200 Subject: [PATCH 8/8] Update docs/concepts/search/searchable-properties/spans.mdx Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com> --- docs/concepts/search/searchable-properties/spans.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/search/searchable-properties/spans.mdx b/docs/concepts/search/searchable-properties/spans.mdx index 1b7b202c6aa1f..e4f6415cc468a 100644 --- a/docs/concepts/search/searchable-properties/spans.mdx +++ b/docs/concepts/search/searchable-properties/spans.mdx @@ -184,7 +184,7 @@ Application-specific internal identifier for the user. ### `user.username` -Username, which is typically a better label than user.id. +Username, which is typically a better label than `user.id`. - **Type:** string