louislam / uptime-kuma

A fancy self-hosted monitoring tool

https://uptime.kuma.pet

MIT License

60.16k stars 5.38k forks source link

Feat: Add new monitor type - SIP Options Reply Ping #5362

Open edman80 opened 2 days ago

edman80 commented 2 days ago

⚠️⚠️⚠️ Since we do not accept all types of pull requests and do not want to waste your time. Please be sure that you have read pull request rules: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma

Tick the checkbox if you understand [x]:

[x] I have read and understand the pull request rules.

Description

Add SIP Options Ping monitor type using sipsak.

Type of change

Please delete any options that are not relevant.

New feature (non-breaking change which adds functionality)
This change requires a documentation update

Checklist

[x ] My code follows the style guidelines of this project
[x ] I ran ESLint and other linters for modified files
[x ] I have performed a self-review of my own code and tested it
[x ] I have commented my code, particularly in hard-to-understand areas (including JSDoc for methods)
[x ] My changes generates no new warnings
[ ] My code needed automated testing. I have added them (this is optional task)

Screenshots (if any)

Please do not use any external image service. Instead, just paste in or drag and drop the image here, and it will be uploaded automatically.

edman80 commented 2 days ago

It is worth mentioning that this monitor type relies on the sipsak binary being available in the server's PATH. I understand that something similar was done with the Tailscale ping notification type - so I followed suit with some things such as adding a visual warning in the frontend and hiding the option if Kuma is running in docker.