Skip to content

Commit 808deda

Browse files
committed
docs: add missing alerts, snapshot methods, and cross-links
- prometheus-monitoring: add 2 missing alert definitions (DBLabMetricsStale, DBLabSyncDown) - create-snapshot: add pool-based snapshot creation method alongside existing clone-based method - branching/index: add link to Coolify preview environments guide https://claude.ai/code/session_011sPDgBjzL2N2X6jiYyoTjQ
1 parent 833336a commit 808deda

3 files changed

Lines changed: 41 additions & 3 deletions

File tree

docs/database-lab/prometheus-monitoring.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,32 @@ dblab_sync_wal_lag_seconds
202202
description: "DBLab sync instance WAL replay is {{ $value | humanizeDuration }} behind"
203203
```
204204

205+
### Metrics collection stale alert
206+
207+
```yaml
208+
- alert: DBLabMetricsStale
209+
expr: time() - dblab_scrape_success_timestamp > 300
210+
for: 5m
211+
labels:
212+
severity: warning
213+
annotations:
214+
summary: "DBLab metrics collection is stale"
215+
description: "DBLab metrics have not been updated for more than 5 minutes"
216+
```
217+
218+
### Sync instance down alert (physical mode)
219+
220+
```yaml
221+
- alert: DBLabSyncDown
222+
expr: dblab_sync_status{status="down"} == 1 or dblab_sync_status{status="error"} == 1
223+
for: 5m
224+
labels:
225+
severity: critical
226+
annotations:
227+
summary: "DBLab sync instance is down"
228+
description: "DBLab sync instance is not healthy"
229+
```
230+
205231
## OpenTelemetry integration
206232

207233
DBLab metrics can be exported to OpenTelemetry-compatible backends using the OpenTelemetry Collector. This allows you to send metrics to Grafana Cloud, Datadog, New Relic, and other observability platforms.

docs/dblab-howtos/branching/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ slug: /dblab-howtos/branching
77
## Guides
88

99
- [How to create a database branch](/docs/dblab-howtos/branching/create-branch)
10-
- [How to delete a database branch](/docs/dblab-howtos/branching/delete-branch)
10+
- [How to delete a database branch](/docs/dblab-howtos/branching/delete-branch)
11+
- [Preview environments with DBLab and Coolify](/docs/dblab-howtos/branching/preview-environments-with-dblab-and-coolify)

docs/dblab-howtos/snapshots/create-snapshot.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,23 @@ Before you run any commands, install Database Lab CLI and initialize configurati
2727
- Command [`dblab snapshot`](/docs/reference-guides/dblab-client-cli-reference#command-snapshot)
2828
- Command [`dblab commit`](/docs/reference-guides/dblab-client-cli-reference#command-commit)
2929

30-
### Create a snapshot
31-
Create a snapshot using the `dblab commit` command and specify the clone ID and message (optional):
30+
### Create a snapshot from a clone
31+
Create a snapshot from an existing clone using the `dblab commit` command:
3232
```bash
3333
$ dblab commit --clone-id CLONE_ID --message "Snapshot message"
3434
```
3535

36+
### Create a snapshot from the current pool state
37+
You can also create a snapshot directly from the current state of a pool (without an existing clone):
38+
```bash
39+
$ dblab snapshot create
40+
```
41+
42+
To specify a particular pool:
43+
```bash
44+
$ dblab snapshot create --pool POOL_NAME
45+
```
46+
3647
Command `dblab snapshot list` shows all snapshots, including the one just created:
3748
```bash
3849
$ dblab snapshot list

0 commit comments

Comments
 (0)