Aleph.im Monitoring Proxy

A collection of HTTP endpoints to monitor more complex resources.

HTTP status codes are used to indicate the status of the monitored resource, the body is for informational purposes only.

The service exposes a Swagger UI at /docs and a Redoc UI at /redoc. Use it to explore the available endpoints.

Use with a tool such as Uptime Kuma.

Deployment

hatch run deployment:aleph program upload src monitoring_proxy:app

Update an existing deployment:

hatch run deployment:aleph program update $ITEM_HASH src

Development

pip install hatch
cd src
hatch run uvicorn monitoring_proxy:app --reload

Testing

Test the code quality using mypy, black, isort and ruff:

hatch run linting:all

Reformat the code using black, isort and ruff:

hatch run linting:fmt

Run the tests:

hatch run testing:cov .

Export the coverage in HTML:

hatch run testing:coverage html