diff --git a/docs/concepts/search/index.mdx b/docs/concepts/search/index.mdx index e2a7da75074e4..c997a23220042 100644 --- a/docs/concepts/search/index.mdx +++ b/docs/concepts/search/index.mdx @@ -12,7 +12,10 @@ Search is available on several features throughout [sentry.io](https://sentry.io ## Query Syntax -You'll only need to use query syntax if you're using a Sentry [API](/api/). You'll get pre-populated suggestions once you start typing in your search terms when using the search bar anywhere in [Sentry.io](https://sentry.sentry.io/). + You'll only need to use query syntax if you're using a Sentry [API](/api/). + You'll get pre-populated suggestions once you start typing in your search + terms when using the search bar anywhere in + [Sentry.io](https://sentry.sentry.io/). Search queries are constructed using a `key:value` pattern, with an optional raw search at the end. Each `key:value` pair is a `token` and the optional raw search is itself a single `token`. The `key:value` pair `tokens` are treated as issue or event properties. The optional raw search is treated as a single `token` and searches event titles/messages. @@ -115,9 +118,9 @@ is:unresolved !user.email:example@customer.com In the example above, the search query returns all Issues that are unresolved _and_ have not affected the user with the email address `example@customer.com`. -#### Wildcards +#### Wildcard Character -Search supports the wildcard operator `*` as a placeholder for specific characters and strings. +Search supports the wildcard character `*` as a placeholder for specific characters and strings. ``` browser:"Safari 11*" @@ -125,7 +128,7 @@ browser:"Safari 11*" In the example above, the search query will match on `browser` values like `"Safari 11.0.2"`, `"Safari 11.0.3"`, etc. -You may also combine operators like so: +You may also combine the wildcard character `*` with other operators like so: ``` !message:"*Timeout" @@ -133,6 +136,30 @@ You may also combine operators like so: In the above example, the search query returns results which do not have message values like `ConnectionTimeout`, `ReadTimeout`, etc. +#### Wildcard Operators + + + When using these operators, the base wildcard character `*` will be treated as + a literal character and not as a wildcard. + + +Sentry's API supports the use of the following wildcard operators when making requests to the API. + +For ease of use, we recommend using the wildcard `*` character instead of these operators when manually querying the API. + +``` +# Note: the characters wrapping the operators are `\uf00d`. + +# contains, and does not contain +browser:Containschrome, !browser:Containsfire + +# starts with, and does not start with +browser:StartsWithchrome, !browser:StartsWithchrome + +# ends with, and does not end with +browser:EndsWithchrome, !browser:EndsWithfire +``` + ## Page Filters Page filters allow you to narrow down the results shown on a page by selecting specific projects, environments, and date ranges. After you've set your filters, they'll persist as you navigate across pages in Sentry.