Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Datadog type monitor #4616

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

seluard
Copy link

@seluard seluard commented Mar 24, 2024

⚠️⚠️⚠️ 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]:

  • I have read and understand the pull request rules.

Description

Hello @louislam !

Some context:
We use DataDog to monitor our stack/services, and it does not offer status page product, we take a look at the open sources projects that could fit. We found uptime-kuma 💘 the one we like the most and could fit better.

We even work already into a POC, but we need to work around with a way to get DataDog monitor states into uptime-kuma, creating push monitors and an extra service that should be the one that gather datadog and make the request to the push monitor endpoint.

Instead of having this kind of workaround, I thought that could be fun and worth to contribute to the project! (Alert! : I'm not a developer, so please bear with me and my small code changes).

With this feature, anyone that is using DataDog will be able to relay on uptime-kuma out of the box to create first class status pages 😎 .

New DataDog type monitor

This feature will allow to sync DataDog monitor state with uptime-kuma monitor.

As this is just initial base code changes, there are some things still need to be added:

  • Tests
  • Translation in place
  • BUG: The creation works, but I missed something cause updating the monitor fields that I added is not working (Again bear with me 😞 )
  • Documentation about this new monitor type
  • Go through the checklist properly
  • datadog-api-cli dependency or use just http to keep uptime-kuma dependencies lean and clean.

Type of change

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

Checklist

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

Screenshots

Screenshot 2024-03-24 at 20 00 25

@CommanderStorm CommanderStorm added area:monitor Everything related to monitors type:new proposing to add a new monitor labels Apr 3, 2024
@CommanderStorm CommanderStorm added the needs:review this PR needs a review by maintainers or other community members label May 19, 2024
@github-actions github-actions bot added needs:resolve-merge-conflict A merge-conflict needs to be addressed before reviewing makes sense again and removed needs:resolve-merge-conflict A merge-conflict needs to be addressed before reviewing makes sense again labels May 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:monitor Everything related to monitors needs:resolve-merge-conflict A merge-conflict needs to be addressed before reviewing makes sense again needs:review this PR needs a review by maintainers or other community members type:new proposing to add a new monitor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants