Skip to content

Commit b404701

Browse files
committed
docs(readme): update storage and migration status
1 parent 34a6833 commit b404701

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,22 @@ What exists today:
3030
- DNS checks
3131
- TLS certificate checks
3232
- gRPC health checks via `grpc.health.v1.Health/Check`
33+
- PostgreSQL-backed raw check execution storage
34+
- persisted current check state
35+
- migration CLI via `cmd/migrate`
3336

3437
What does not exist yet in a finished form:
3538

36-
- persistent state storage
37-
- finalized status aggregation rules
39+
- finalized service-level aggregation
40+
- query/read API for current and historical state
3841
- public/internal status page generation
3942
- production-ready logging and observability
4043
- stable external interfaces
4144

4245
## Running
4346

4447
The application expects configuration to be provided through `CONFIG_DIR`.
48+
PostgreSQL is also required for execution and state storage.
4549

4650
Expected layout:
4751

@@ -53,6 +57,12 @@ Example configuration files are available in:
5357
- `examples/services.yaml`
5458
- `examples/checks/api-checks.yaml`
5559

60+
Before starting the app, apply migrations:
61+
62+
```bash
63+
go run ./cmd/migrate up
64+
```
65+
5666
Run with:
5767

5868
```bash
@@ -64,7 +74,7 @@ CONFIG_DIR=./examples go run ./cmd/pulse
6474
A few implementation details are intentionally narrow at this stage:
6575

6676
- gRPC support currently targets only the standard health check API: `grpc.health.v1.Health/Check`
67-
- result writing is still backed by a temporary fake writer
77+
- raw execution history and current check state are stored in PostgreSQL
6878
- internal architecture is still evolving
6979

7080
## Important

0 commit comments

Comments
 (0)