service-probe

Crates.ioservice-probe
lib.rsservice-probe
version0.2.1
created_at2024-11-19 05:17:21.409635+00
updated_at2025-01-31 10:50:56.071322+00
descriptionProbe for querying service state through a minimal HTTP service
homepage
repositoryhttps://gitlab.opencode.de/opentalk/libs/service-probe
max_upload_size
id1452930
size35,073
OpenTalk Bot (OpenTalk-Bot)

documentation

README

Service Probe

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|

Commit count: 0

cargo fmt