Crates.io | service-probe |
lib.rs | service-probe |
version | 0.2.1 |
created_at | 2024-11-19 05:17:21.409635+00 |
updated_at | 2025-01-31 10:50:56.071322+00 |
description | Probe for querying service state through a minimal HTTP service |
homepage | |
repository | https://gitlab.opencode.de/opentalk/libs/service-probe |
max_upload_size | |
id | 1452930 |
size | 35,073 |
This crate provides an easy way to start a HTTP server that can be used for making the status of a service transparent to observers. 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
|