Repository navigation
Commit d3a5a57
authored
[HDX-3044] Add optional note field to alerts (#2210)
## Summary
Adds an optional freeform note/reason field to alerts, allowing on-call responders to document why an alert exists, threshold decision history, and links to runbooks. The note field supports markdown formatting.
Additionally, this PR brings the saved-search alert UX in line with dashboards by adding visual indicators for firing alerts:
- Alert tabs in the saved-search alert modal show a red bell firing indicator alongside the webhook channel icon, using the shared `AlertStatusIcon` component (same pattern as dashboard tiles and app nav)
- The Alerts button on the search page shows a red bell icon when at least one alert in the saved search is firing
**Changes across the codebase:**
- **Backend**: Added `note` field to Mongoose model, Zod validation schemas (shared `alertNoteSchema` in common-utils + API), controller mapping, internal API response formatting, external API type + transformer, and OpenAPI docs
- **Frontend (note field)**: Extracted shared `AlertNoteField` component with empty→null onChange transform. Notes are displayed on the `/alerts` page in a collapsible section (hidden by default) with markdown rendering gated behind the expanded state. Custom `<a>` and `<img>` overrides for link security and referrer privacy.
- **Frontend (alert status indicators)**: Alert tabs in the saved-search modal show `AlertStatusIcon` alongside the webhook channel icon. The Alerts button on the search page shows `AlertStatusIcon` when alerts are configured.
- **E2E tests**: Two Playwright tests covering note creation from both saved-search and dashboard tile flows, with markdown rendering and link attribute verification
- **Unit/integration tests**: External API transformer tests for note null/undefined/string handling. Internal API round-trip test for note create, update, and clear.
### Screenshots or video
https://github.com/user-attachments/assets/144b86c6-ef0a-4186-be88-49bf415a408c
### How to test locally or on Vercel
1. Create a saved search, open the alerts modal, fill in the note field with markdown (e.g. `Threshold set to **1**. See [runbook](https://example.com).`), and create the alert
2. Navigate to `/alerts` — the alert row should show a "Note" toggle
3. Click the toggle to expand — verify markdown renders correctly (bold, links open in new tab)
4. Repeat from a dashboard tile alert editor
5. Trigger an alert (or set state to ALERT in the DB) — verify the saved-search alert modal tab shows a red bell icon next to the webhook icon, and the Alerts button on the search page shows a red bell icon
### References
- Linear Issue: https://linear.app/clickhouse/issue/HDX-3044/add-an-optional-reasonnote-field-to-alerts
- Related PRs: None1 parent b0905dd commit d3a5a57
22 files changed
Lines changed: 449 additions & 10 deletions
File tree
- .changeset
- packages
- api
- src
- controllers
- models
- routers
- api
- __tests__
- external-api
- __tests__
- v2
- utils
- __tests__
- app
- src
- components
- DBEditTimeChartForm
- utils
- tests/e2e
- components
- features
- page-objects
- common-utils/src
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
276 | 276 | | |
277 | 277 | | |
278 | 278 | | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
279 | 287 | | |
280 | 288 | | |
281 | 289 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
143 | 143 | | |
144 | 144 | | |
145 | 145 | | |
146 | | - | |
147 | | - | |
| 146 | + | |
148 | 147 | | |
149 | | - | |
150 | | - | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
151 | 151 | | |
152 | 152 | | |
153 | 153 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
69 | 72 | | |
70 | 73 | | |
71 | 74 | | |
| |||
161 | 164 | | |
162 | 165 | | |
163 | 166 | | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
164 | 171 | | |
165 | 172 | | |
166 | 173 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
127 | 127 | | |
128 | 128 | | |
129 | 129 | | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
130 | 193 | | |
131 | 194 | | |
132 | 195 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
80 | 80 | | |
81 | 81 | | |
82 | 82 | | |
| 83 | + | |
83 | 84 | | |
84 | 85 | | |
85 | 86 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
222 | 222 | | |
223 | 223 | | |
224 | 224 | | |
| 225 | + | |
225 | 226 | | |
226 | 227 | | |
227 | 228 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
179 | 179 | | |
180 | 180 | | |
181 | 181 | | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
182 | 189 | | |
183 | 190 | | |
184 | 191 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
48 | 74 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
231 | 231 | | |
232 | 232 | | |
233 | 233 | | |
| 234 | + | |
234 | 235 | | |
235 | 236 | | |
236 | 237 | | |
| |||
329 | 330 | | |
330 | 331 | | |
331 | 332 | | |
| 333 | + | |
332 | 334 | | |
333 | 335 | | |
334 | 336 | | |
| |||
0 commit comments