Skip to content

Commit 02128a4

Browse files
committed
docs: added flow health feature
1 parent 96c0621 commit 02128a4

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ code0-flow is a Rust library developed by Code0 for managing flows within the Fl
77

88
## Features
99

10-
- `flow_store` insert, delete & query Flows in the FlowStore
1110
- `flow_definition` update the Adapter & Runtime definitions
12-
- `flow_queue` send a Flow into the queue to be executed.
11+
- `flow_config` base configuration for each service
12+
- `flow_health` provide health checks including NATS connectivity for readiness probes
1313

1414
## FlowStore
1515

@@ -71,3 +71,20 @@ let update_client = code0_flow::flow_definition::FlowUpdateService::from_url(aqu
7171
// Response --> true if successfull
7272
update_client.send().await;
7373
```
74+
75+
## FlowHealth
76+
77+
```rust
78+
use code0_flow::flow_health::HealthService;
79+
use tonic_health::pb::health_server::HealthServer;
80+
81+
// Create health service with NATS URL
82+
let health_service = HealthService::new("nats://localhost:4222".to_string());
83+
84+
// Use with tonic gRPC server
85+
let health_server = HealthServer::new(health_service);
86+
87+
// The service provides:
88+
// - "liveness" check: Always returns Serving (application is running)
89+
// - "readiness" check: Returns Serving only if NATS connection is healthy
90+
```

0 commit comments

Comments
 (0)