Skip to content

Commit f4e78bb

Browse files
Copilotsagpatil
andcommitted
Rename /ready endpoint to /health per feedback
Co-authored-by: sagpatil <[email protected]>
1 parent 5903542 commit f4e78bb

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -130,12 +130,12 @@ _Note: In local mode a local friendbot is running. In testnet and futurenet mode
130130
131131
### Readiness Endpoint
132132
133-
The quickstart image provides a `/ready` endpoint that indicates when all services are fully ready for use. This endpoint reports HTTP 200 when the image is ready and HTTP 503 when services are still starting up or experiencing issues.
133+
The quickstart image provides a `/health` endpoint that indicates when all services are fully ready for use. This endpoint reports HTTP 200 when the image is ready and HTTP 503 when services are still starting up or experiencing issues.
134134
135135
Example usage:
136136
137137
```bash
138-
$ curl http://localhost:8000/ready
138+
$ curl http://localhost:8000/health
139139
```
140140

141141
Example response when ready:
@@ -157,7 +157,7 @@ Example response when ready:
157157

158158
The endpoint automatically detects which services are running and only reports "ready" when all detected services are functioning properly. This eliminates the need to write custom scripts to test multiple service endpoints individually.
159159

160-
_Note: The `/ready` endpoint provides overall readiness status, while Horizon's existing `/health` endpoint provides Horizon-specific health information._
160+
_Note: The `/health` endpoint provides comprehensive readiness status for all detected services, replacing Horizon's built-in `/health` endpoint with expanded functionality._
161161

162162
### Soroban Development
163163

@@ -281,7 +281,7 @@ The image exposes one main port through which services provide their APIs:
281281

282282
| Port | Service | Description |
283283
| ---- | -------------------------------------- | -------------- |
284-
| 8000 | horizon, stellar-rpc, friendbot, ready | main http port |
284+
| 8000 | horizon, stellar-rpc, friendbot, health | main http port |
285285

286286
The image also exposes a few other ports that most developers do not need, but area available:
287287

@@ -290,7 +290,7 @@ The image also exposes a few other ports that most developers do not need, but a
290290
| 5432 | postgresql | database access port |
291291
| 6060 | horizon | admin port |
292292
| 6061 | stellar-rpc | admin port |
293-
| 8004 | readiness service | internal port |
293+
| 8004 | health service | internal port |
294294
| 11625 | stellar-core | peer node port |
295295
| 11626 | stellar-core | main http port |
296296
| 11725 | stellar-core (horizon) | peer node port |

common/nginx/etc/conf.d/ready.conf renamed to common/nginx/etc/conf.d/health.conf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
location /ready {
2-
rewrite /ready / break;
1+
location /health {
2+
rewrite /health / break;
33
proxy_set_header Host $http_host;
44
proxy_pass http://127.0.0.1:8004;
55
proxy_redirect off;

common/readiness/bin/readiness-service.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
class HealthCheckHandler(BaseHTTPRequestHandler):
2020
def do_GET(self):
21-
if self.path == '/' or self.path == '/ready':
21+
if self.path == '/' or self.path == '/health':
2222
self.handle_readiness_check()
2323
else:
2424
self.send_error(404)

tests/test_ready_endpoint.go renamed to tests/test_health_endpoint.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ func main() {
2727
os.Exit(-1)
2828
}
2929

30-
resp, err := http.Get("http://localhost:8000/ready")
30+
resp, err := http.Get("http://localhost:8000/health")
3131
if err != nil {
3232
logLine(err)
3333
continue

0 commit comments

Comments
 (0)