Skip to content

Commit e39f980

Browse files
committed
feat: Add docs for tagging and saved searches
1 parent a214d55 commit e39f980

File tree

6 files changed

+60
-8
lines changed

6 files changed

+60
-8
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import Image from '@theme/IdealImage';
2+
import clickstackTagsSearch from '@site/static/images/use-cases/observability/clickstack-tags-search.png';
3+
import clickstackTagsDashboard from '@site/static/images/use-cases/observability/clickstack-tags-dashboard.png';
4+
5+
You can add tags to dashboards and saved searches to help organize them. Tags provide a flexible way to categorize and filter based on your needs.
6+
7+
#### How tags work
8+
9+
- **Organization**: Tags appear in the left sidebar, where dashboards and saved searches are grouped by their assigned tags
10+
- **Multiple tags**: You can add one or more tags to a single item for better categorization
11+
- **Auto-creation**: If you assign a tag that doesn't exist yet, it will be automatically created
12+
- **Easy management**: You can add or remove tags at any time to adjust your organization structure
13+
14+
This makes it easy to find related items and maintain an organized workspace as your collection grows.
15+
16+
<div style={{display: 'flex', justifyContent: 'flex-start', marginTop: '-20px'}}>
17+
<div style={{maxWidth: '600px'}}>
18+
<Image img={clickstackTagsSearch} alt="Tags in saved search" size="md" border />
19+
</div>
20+
</div>
21+
22+
You can also select multiple tags to filter and view items across different categories:
23+
24+
<div style={{display: 'flex', justifyContent: 'flex-start', marginTop: '-20px'}}>
25+
<div style={{maxWidth: '600px'}}>
26+
<Image img={clickstackTagsDashboard} alt="Multiple tags selected in dashboard" size="md" border />
27+
</div>
28+
</div>

docs/use-cases/observability/clickstack/dashboards.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ import dashboard_edit from '@site/static/images/use-cases/observability/hyperdx-
2525
import dashboard_clickhouse from '@site/static/images/use-cases/observability/hyperdx-dashboard-clickhouse.png';
2626
import dashboard_services from '@site/static/images/use-cases/observability/hyperdx-dashboard-services.png';
2727
import dashboard_kubernetes from '@site/static/images/use-cases/observability/hyperdx-dashboard-kubernetes.png';
28+
import Tagging from '@site/docs/_snippets/_clickstack_tagging.mdx';
2829

2930
ClickStack supports visualizing events, with built-in support for charting in HyperDX. These charts can be added to dashboards for sharing with other users.
3031

@@ -151,18 +152,20 @@ The dashboard will be auto-saved. To set the dashboard name, select the title an
151152

152153
</VerticalStepper>
153154

154-
## Dashboards - editing visualizations {#dashboards-editing-visualizations}
155+
## Dashboards - Editing visualizations {#dashboards-editing-visualizations}
155156

156157
To remove, edit, or duplicate a visualization, hover over it and use the corresponding action buttons.
157158

158159
<Image img={dashboard_edit} alt="Dashboard edit" size="lg"/>
159160

160-
## Dashboard listing and search {#dashboard-listing-search}
161+
## Dashboard - Listing and search {#dashboard-listing-search}
161162

162163
Dashboards are accessible from the left-hand menu, with built-in search to quickly locate specific dashboards.
163-
164164
<Image img={dashboard_search} alt="Dashboard search" size="sm"/>
165165

166+
## Dashboards - Tagging {#tagging}
167+
<Tagging />
168+
166169
## Presets {#presets}
167170

168171
HyperDX is deployed with out-of-the-box dashboards.

docs/use-cases/observability/clickstack/search.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,17 @@ keywords: ['clickstack', 'search', 'logs', 'observability', 'full-text search']
1111

1212
import Image from '@theme/IdealImage';
1313
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';
1416

1517
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.
1618

1719
This same search syntax is used for filtering events with Dashboards and Charts
1820
as well.
1921

20-
## Natural language search syntax {#natural-language-syntax}
22+
## Search Features {#search-features}
23+
24+
### Natural language search syntax {#natural-language-syntax}
2125

2226
- Searches are not case sensitive
2327
- Searches match by whole word by default (ex. `Error` will match `Error here`
@@ -33,7 +37,7 @@ as well.
3337

3438
<Image img={hyperdx_27} alt="Search" size="md"/>
3539

36-
### Column/property search {#column-search}
40+
#### Column/property search {#column-search}
3741

3842
- You can search columns and JSON/map properties by using `column:value` (ex. `level:Error`,
3943
`service:app`)
@@ -42,7 +46,7 @@ as well.
4246
- You can search for the existence of a property by using `property:*` (ex.
4347
`duration:*`)
4448

45-
## Time input {#time-input}
49+
### Time input {#time-input}
4650

4751
- Time input accepts natural language inputs (ex. `1 hour ago`, `yesterday`,
4852
`last week`)
@@ -52,14 +56,31 @@ as well.
5256
easy debugging of time queries.
5357
- You can highlight a histogram bar to zoom into a specific time range as well.
5458

55-
## SQL search syntax {#sql-syntax}
59+
### SQL search syntax {#sql-syntax}
5660

5761
You can optionally toggle search inputs to be in SQL mode. This will accept any valid
5862
SQL WHERE clause for searching. This is useful for complex queries that cannot be
5963
expressed in Lucene syntax.
6064

61-
## Select statement {#select-statement}
65+
### Select statement {#select-statement}
6266

6367
To specify the columns to display in the search results, you can use the `SELECT`
6468
input. This is a SQL SELECT expression for the columns to select in the search page.
6569
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+
<Image img={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).
84+
85+
### Tagging {#tagging}
86+
<Tagging />
101 KB
Loading
18 KB
Loading
21.6 KB
Loading

0 commit comments

Comments
 (0)