Skip to content

Commit eaf00d0

Browse files
committed
simple alerts
1 parent 6e4aeb9 commit eaf00d0

File tree

4 files changed

+50
-4
lines changed

4 files changed

+50
-4
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
slug: /use-cases/observability/clickstack/alerts
3+
title: 'Search with ClickStack'
4+
sidebar_label: 'Alerts'
5+
pagination_prev: null
6+
pagination_next: null
7+
description: 'Alerts with ClickStack'
8+
---
9+
10+
import Image from '@theme/IdealImage';
11+
import search_alert from '@site/static/images/use-cases/observability/search_alert.png';
12+
13+
14+
## Search alerts {#search-alerts}
15+
16+
Aftering entering a [search](/use-cases/observability/clickstack/search), you can create an alert to be
17+
notified when the number of events (logs or spans) matching the search exceeds or falls below a threshold.
18+
19+
### Creating an Alert {#creating-an-alert}
20+
21+
You can create an alert by clicking the `Alerts` button on the top right of the `Search` page.
22+
23+
From here, you can name the alert, as well as set the threshold, duration, and notification method for the alert (Slack, Email, PagerDuty or Slack Webhook).
24+
25+
The `grouped by` value allows the search to be subject to an aggregation e.g. `ServiceName`, thus allowing potential multiple alerts to be triggered off the same search.
26+
27+
<Image img={search_alert} alt="Search alerts" size="lg"/>
28+
29+
### Common Alert Scenarios {#common-alert-scenarios}
30+
31+
Here are a few common alert scenarios that you can use HyperDX for:
32+
33+
**Errors:** We first recommend setting up alerts for the default
34+
`All Error Events` and `HTTP Status >= 400` saved searches to be notified when
35+
excess error occurs.
36+
37+
**Slow Operations:** You can set up a search for slow operations (ex.
38+
`duration:>5000`) and then alert when there are too many slow operations
39+
occuring.
40+
41+
**User Events:** You can also set up alerts for customer-facing teams to be
42+
notified when new users sign up, or a critical user action is performed.

docs/use-cases/observability/clickstack/example-datasets/remote-demo-data.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ import edit_connection from '@site/static/images/use-cases/observability/edit_co
4343

4444
This getting started guide uses a dataset available on the demo server that users can access when first deploying HyperDX. The dataset is hosted on the public ClickHouse instance at [sql.clickhouse.com](https://sql.clickhouse.com).
4545

46-
It contains approximately 36 hours of data captured from the ClickHouse version of the official OpenTelemetry (OTel) demo. The data is replayed nightly with timestamps adjusted to the current time window, allowing users to explore system behavior using HyperDX's integrated logs, traces, and metrics.
46+
It contains approximately 40 hours of data captured from the ClickHouse version of the official OpenTelemetry (OTel) demo. The data is replayed nightly with timestamps adjusted to the current time window, allowing users to explore system behavior using HyperDX's integrated logs, traces, and metrics.
4747

4848
:::note Data variations
4949
Because the dataset is replayed from midnight each day, the exact visualizations may vary depending on when you explore the demo.
@@ -75,7 +75,9 @@ Further details on the demo can be found in the [official OpenTelemetry document
7575

7676
### Connect to the demo server {#connect-to-the-demo-server}
7777

78-
**This step can be skipped if you clicked `Connect to Demo Server` when deploying in Local Mode.**
78+
:::note Local-Only mode
79+
This step can be skipped if you clicked `Connect to Demo Server` when deploying in Local Mode. If using this mode, sources will be prefixed with `Demo_` e.g. `Demo_Logs`
80+
:::
7981

8082
Navigate to `Team Settings` and click `Edit` for the `Local Connection`:
8183

@@ -92,7 +94,9 @@ Rename the connection to `Demo` and complete the subsequent form with the follow
9294

9395
### Modify the sources {#modify-sources}
9496

95-
**This step can be skipped if you clicked `Connect to Demo Server` when deploying in Local Mode.**
97+
:::note Local-Only mode
98+
This step can be skipped if you clicked `Connect to Demo Server` when deploying in Local Mode. If using this mode, sources will be prefixed with `Demo_` e.g. `Demo_Logs`
99+
:::
96100

97101
Scroll up to `Sources` and modify each of the sources - `Logs`, `Traces`, `Metrics`, and `Sessions` - to use the `otel_v2` database.
98102

sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1619,8 +1619,8 @@ const sidebars = {
16191619
},
16201620
"use-cases/observability/clickstack/config",
16211621
"use-cases/observability/clickstack/search",
1622+
"use-cases/observability/clickstack/alerts",
16221623
"use-cases/observability/clickstack/production",
1623-
16241624
]
16251625
},
16261626
],
757 KB
Loading

0 commit comments

Comments
 (0)