Monitoring Server

[piotrek6641]

What?

• Monitoring server package that allows checking health of a process such as STH/ manager
• ModuleLoader to load additional modules on demand. Module should be installed manually, for example with:
  npm i @scramjet/monitoring-server -g

Usage:

• Install @scramjet/monitoring-server package.

• Start STH with a flag --healtz-port 3030

• make a GET request to /healthz endpoint (example curl http://localhost:3030/healtz)

• Will return ok with a status 200 if everything is working well, 500 otherwise.

• Available flags:

  --healtz-port <healtz-port>              Starts monitoring sever on a selected port
  --healtz-host <healtz-host>              Starts monitoring sever on a specified interface e.g ["0.0.0.0"]. Requires --healtz-port
  --healtz-path <healtz-path>              Exposes monitoring endpoint on specified path. Requires --healtz-port

Clickup Task:
https://app.clickup.com/t/24308805/VDM-1350

Review checks:

These aspects need to be checked by the reviewer:

• Verify and confirm operation (please post a screenshot)
• All STH tests pass
• All Scramjet Cloud Platform tests pass
• Documentation is updated or no changes

[alicja-gruzdz]

thanks, @piotrek6641 🙌

Could you please also perform a quick memory profiling to verify how much the mem consumption increased after adding another server? I know it's lightweight, but let's measure it.

[alicja-gruzdz]

excellent

[piotrek6641]

Memory usage

Without montioring server:

With monitoring server:

Calling endpoint:

[alicja-gruzdz]

Verify ✔️

[alicja-gruzdz]

Ready to merge.