Skip to content

Commit 47dc7fe

Browse files
committed
docs: update readme
1 parent e5c62b5 commit 47dc7fe

File tree

1 file changed

+11
-19
lines changed

1 file changed

+11
-19
lines changed

README.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -98,25 +98,14 @@ Type-specific Fields:
9898

9999
## Metrics
100100

101-
### Prometheus Integration
102-
- Node metrics for hosts and groups
103-
- Edge metrics for relationships
104-
- Response time histograms
105-
- Success/failure counters
106-
- Host availability tracking
107-
108-
All metrics are exposed on `:9100/metrics` with the `checkmate_` prefix.
109-
110-
## Metrics
111-
112-
CheckMate exposes Prometheus metrics at `:9100/metrics`:
101+
CheckMate exposes Prometheus metrics at `:9100/metrics`
113102

114103
### Core Metrics
115-
- `checkmate_check_success`: Service availability (1 = up, 0 = down)
116-
- `checkmate_check_latency_milliseconds`: Response time in milliseconds
117-
- `checkmate_check_latency_milliseconds_histogram`: Response time distribution
118-
- `checkmate_hosts_up`: Number of hosts up in a group (per port/protocol)
119-
- `checkmate_hosts_total`: Total number of hosts in a group (per port/protocol)
104+
- `checkmate_host_check_status`: Service availability (1 = up, 0 = down)
105+
- `checkmate_host_check_latency_milliseconds`: Response time in milliseconds
106+
- `checkmate_check_latency_histogram_seconds`: Response time distribution
107+
- `checkmate_hosts_up`: Number of hosts up in a group
108+
- `checkmate_hosts_total`: Total number of hosts in a group
120109
- `checkmate_cert_expiry_days`: Days until certificate expiration
121110

122111
### Graph Visualization Metrics (In Development)
@@ -180,13 +169,16 @@ CheckMate provides Kubernetes-compatible health check endpoints:
180169

181170
All health check endpoints are served on port 9100 alongside metrics.
182171

183-
## Roadmap
172+
## Mini Roadmap
184173

185174
- [ ] Notification system expansion (Slack, Email)
186175
- [ ] Configurable notification thresholds
187176
- [ ] Database support for historical data
188-
- [ ] Docker container
189177
- [ ] Web UI for monitoring (MAYBE)
178+
179+
## Completed
180+
- [x] Env Variables for config
181+
- [x] Dockerfile for dev
190182
- [x] Additional protocol support (HTTPS, TLS verification)
191183
- [x] Kubernetes readiness/liveness probe support
192184
- [x] Multiple host monitoring

0 commit comments

Comments
 (0)