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: docs/use-cases/observability/clickstack/dashboards.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,7 @@ import dashboard_edit from '@site/static/images/use-cases/observability/hyperdx-
25
25
import dashboard_clickhouse from '@site/static/images/use-cases/observability/hyperdx-dashboard-clickhouse.png';
26
26
import dashboard_services from '@site/static/images/use-cases/observability/hyperdx-dashboard-services.png';
27
27
import dashboard_kubernetes from '@site/static/images/use-cases/observability/hyperdx-dashboard-kubernetes.png';
28
+
import Tagging from '@site/docs/_snippets/_clickstack_tagging.mdx';
28
29
29
30
ClickStack supports visualizing events, with built-in support for charting in HyperDX. These charts can be added to dashboards for sharing with other users.
30
31
@@ -151,18 +152,20 @@ The dashboard will be auto-saved. To set the dashboard name, select the title an
import hyperdx_27 from '@site/static/images/use-cases/observability/hyperdx-27.png';
14
+
import saved_search from '@site/static/images/use-cases/observability/clickstack-saved-search.png';
15
+
import Tagging from '@site/docs/_snippets/_clickstack_tagging.mdx';
14
16
15
17
ClickStack allows you to do a full-text search on your events (logs and traces). You can get started searching by just typing keywords that match your events. For example, if your log contains "Error", you can find it by just typing in "Error" in the search bar.
16
18
17
19
This same search syntax is used for filtering events with Dashboards and Charts
18
20
as well.
19
21
20
-
## Natural language search syntax {#natural-language-syntax}
22
+
## Search Features {#search-features}
23
+
24
+
### Natural language search syntax {#natural-language-syntax}
21
25
22
26
- Searches are not case sensitive
23
27
- Searches match by whole word by default (ex. `Error` will match `Error here`
@@ -33,7 +37,7 @@ as well.
33
37
34
38
<Imageimg={hyperdx_27}alt="Search"size="md"/>
35
39
36
-
### Column/property search {#column-search}
40
+
####Column/property search {#column-search}
37
41
38
42
- You can search columns and JSON/map properties by using `column:value` (ex. `level:Error`,
39
43
`service:app`)
@@ -42,7 +46,7 @@ as well.
42
46
- You can search for the existence of a property by using `property:*` (ex.
43
47
`duration:*`)
44
48
45
-
## Time input {#time-input}
49
+
###Time input {#time-input}
46
50
47
51
- Time input accepts natural language inputs (ex. `1 hour ago`, `yesterday`,
48
52
`last week`)
@@ -52,14 +56,31 @@ as well.
52
56
easy debugging of time queries.
53
57
- You can highlight a histogram bar to zoom into a specific time range as well.
54
58
55
-
## SQL search syntax {#sql-syntax}
59
+
###SQL search syntax {#sql-syntax}
56
60
57
61
You can optionally toggle search inputs to be in SQL mode. This will accept any valid
58
62
SQL WHERE clause for searching. This is useful for complex queries that cannot be
59
63
expressed in Lucene syntax.
60
64
61
-
## Select statement {#select-statement}
65
+
###Select statement {#select-statement}
62
66
63
67
To specify the columns to display in the search results, you can use the `SELECT`
64
68
input. This is a SQL SELECT expression for the columns to select in the search page.
65
69
Aliases are not supported at this time (ex. you can not use `column as "alias"`).
70
+
71
+
## Saved searches {#saved-searches}
72
+
73
+
You can save your searches for quick access later. Once saved, your searches will appear in the left sidebar, making it easy to revisit frequently used search queries without having to reconstruct them.
74
+
75
+
To save a search, simply configure your search query and click the save button. You can give your saved search a descriptive name to help identify it later.
76
+
77
+
<Imageimg={saved_search}alt="Saving a Search"size="md" />
78
+
79
+
### Adding alerts to saved searches {#alerts-on-saved-searches}
80
+
81
+
Saved searches can be monitored with alerts to notify you when certain conditions are met. You can set up alerts to trigger when the number of events matching your saved search exceeds or falls below a specified threshold.
82
+
83
+
For more information on setting up and configuring alerts, see the [Alerts documentation](/use-cases/observability/clickstack/alerts).
0 commit comments