service-probe 0.4.0

Probe for querying service state through a minimal HTTP service
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# Service Probe

This crate provides an easy way to make the status of a service transparent
to observers by starting a HTTP server. The main use case is to communicate
information about the health status of a service in containerized environments.

The "main" service does not need to provide a HTTP server on its own, the probe
will spin up its own minimalistic HTTP server.

The following endpoints are provided (they can be used with or without trailing slash):

| Endpoints      | Response body   | HTTP Status Code          |
| -------------- | --------------- | ------------------------- |
| `/`, `/health` | `UP` or `READY` | `200`                     |
| `/ready`       | `READY`         | if ready `200` else `503` |