You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/collections/_documentation/workflow/search.md
+21-12Lines changed: 21 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
---
2
2
title: Search
3
3
sidebar_order: 3
4
+
example_tag_name: page_locale
5
+
example_tag_value: de-at
4
6
---
5
7
6
8
Search is available on several major Sentry views: Issues, Events, and Releases.
@@ -14,10 +16,11 @@ Discover is Sentry's powerful query builder for aggregating raw event data and h
14
16
level="info"
15
17
%}
16
18
17
-
18
19
## Syntax
19
20
20
-
Queries are constructed using a `key:value` pattern, with an optional raw search at the end. Each `key:value` pair is a `token`, except the optional raw search. The optional raw search is itself a `token`. For example:
21
+
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 `token`. The Sentry SDKs treat the `key:value` pair `token` as a search on an issue or event property. The SDKs treat the optional raw search `token` as a message separated by whitespace, which is used to search on event titles/messages.
22
+
23
+
For example:
21
24
22
25
```
23
26
is:resolved user.username:"Jane Doe" server:web-8 example error
@@ -30,11 +33,10 @@ In the example above, there are three keys (`is:`, `user.username:`, `server:`),
30
33
-`server:web-8`
31
34
-`example error`
32
35
33
-
The tokens `is:resolved` and `user.username:"Jane Doe"` are standard search tokens because both use reserved keywords. See [Issue Properties](#issue-properties) and [Events Properties](#events-properties) for appropriate keyword usage. The token `server:web-8` is pointing to a custom tag sent by the Sentry SDK.
36
+
The tokens `is:resolved` and `user.username:"Jane Doe"` are standard search tokens because both use reserved keywords. See [Issue Properties](#issue-properties) and [Event Properties](#event-properties) for appropriate keyword usage. The token `server:web-8` is pointing to a custom tag sent by the Sentry SDK. See [Custom Tags](#custom-tags) for more information on how to set tags.
34
37
35
38
The token `example error` is utilizing the optional raw search and is passed as part of the issue search query (which uses a CONTAINS match similar to SQL). When using the optional raw search, you can provide _one_ string, and the query uses that entire string.
In the example above, the search query returns all Issues that are unresolved _and_ have not affected the user with the email address `[email protected]`.
51
53
52
-
53
54
#### Wildcards
54
55
55
56
Search supports the wildcard operator `*` as a placeholder for specific characters and strings.
@@ -60,12 +61,11 @@ browser:"Safari 11*"
60
61
61
62
In the example above, the search query will match on `browser` values like `"Safari 11.0.2"`, `"Safari 11.0.3"`, etc.
62
63
63
-
64
64
## Search Properties
65
65
66
66
In the examples above, we've highlighted a couple of example properties you can search on: `is`, `user`, `server`, `browser`, etc. Below is a canonical list of all available search terms.
67
67
68
-
### Issue Properties {#issue-properties}
68
+
### Issue Properties
69
69
70
70
Issues are an aggregate of one or more events. Searchable properties include workflow status, assignment, aggregate counts, and age.
71
71
@@ -148,8 +148,7 @@ Below is a list of Issue-level tokens reserved and known to Sentry:
148
148
149
149
`lastSeen:-2d`
150
150
151
-
152
-
### Events Properties {#events-properties}
151
+
### Event Properties
153
152
154
153
Events are the underlying event data captured using Sentry SDKs (read: errors and exceptions).
155
154
@@ -218,12 +217,22 @@ Below is a list of Event-level tokens reserved and known to Sentry:
218
217
219
218
: Restrict results to events with a matching stack property.
220
219
221
-
222
220
### Custom Tags
223
221
224
-
Additionally, you can use any tag you’ve specified as a token.
222
+
Additionally, you can use any tag you’ve specified as a token. Tags are various key/value pairs that get assigned to an event, and you can use them later as a breakdown or quick access to finding related events.
223
+
224
+
Most SDKs generally support configuring tags by configuring the scope:
225
+
226
+
{% include components/platform_content.html content_dir='set-tag' %}
227
+
228
+
Several common uses for tags include:
229
+
230
+
- The hostname of the server
231
+
- The version of your platform (for example, iOS 5.0)
232
+
- The user’s language
233
+
234
+
For more information, see [full documentation on Tagging Events]({%- link _documentation/enriching-error-data/context.md -%}#tagging-events).
225
235
226
-
227
236
## Saving Searches
228
237
229
238
You can save a search by performing the search, clicking the dropdown arrow next to the Current Search, and then "Save Current Search".
0 commit comments