Skip to content
SpO₂ is oxygen saturation and is used in medical person monitoring.
Rust HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
misc
public Add the url in a title attribute Sep 27, 2019
src
.gitignore
Cargo.lock
Cargo.toml
LICENSE
README.md Update Readme Sep 27, 2019
enable-ssl.md

README.md

SpO₂

SpO₂ is oxygen saturation and is used in medical person monitoring.

This project uses sled to permanently save the health checked URLs. It provides a websocket API that returns the changing status of the health checked URLs.

SpO₂ doesn't support SSL out of the box, if you need you can setup an Nginx server as we do.

SpO2 dashboard screenshot

Usage

You must have installed Rust on your computer first.

# to try it in debug mode
cargo run

# or in release mode
cargo run --release

# you can also change the listen addrs with env variables
export HTTP_LISTEN_ADDR='127.0.0.1:8000'
export WS_LISTEN_ADDR='127.0.0.1:8001'
cargo run --release

# with the previous settings the HTTP and the WebSocket server will be
# available on http://127.0.0.1:8000/ and ws://127.0.0.1:8001/ respectively

# to enable the slack notifier you must set the corresponding env variable
export SLACK_HOOK_URL='Your Slack Webhook URL'
cargo run --release

Add or Update a new URL to health check

Calling this route is "kind of" idenpotent, it means that it will not run another health checker on this URL but the custom json data will be updated.

curl -i -X PUT 'http://127.0.0.1:8000/?url=http%3A%2F%2Flocalhost%2Fhealth' -d '"your custom json data"'

# Note that 'http%3A%2F%2Flocalhost%2Fhealth' is the url to health check
# but it is url encoded and correspond to 'http://localhost/health'

Remove an health checked URL

Calling this route will remove the URL from the health check pool and return you the custom json data associated with it.

curl -i -X DELETE 'http://127.0.0.1:8000/?url=http%3A%2F%2Flocalhost%2Fhealth'

Get an health checked URL data

Will return the associated data of an already health checked URL.

curl -i -X GET 'http://127.0.0.1:8000/?url=http%3A%2F%2Flocalhost%2Fhealth'

Get all the health checked URLs

Will return the list of all the health checked URLs aloang with the data associated with them.

curl -i -X GET 'http://127.0.0.1:8000/all'
You can’t perform that action at this time.