feat: add `RabbitMQ` monitor #5199

Suven-p · 2024-10-15T02:35:35Z

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

Fixes #5066
This PR makes the following assumptions:

Monitoring plugin is enabled. This is an optional plugin and it doesn't directly test the functionality of RabbitMQ like other monitors like Kafka and MQTT. However since RabbitMQ supports multiple protocols like AMQP, MQTT and STORM it might be better to have separate monitor for each protocol if the requirement is to monitor the functionality of queues.
If multiple nodes are provided, it is assumed that they are in a single cluster (without verification although it is possible to do so) and connection to a single node is sufficient to mark the monitor as UP. According to the docs,

All data/state required for the operation of a RabbitMQ broker is replicated across all nodes. An exception to this are message queues, which by default reside on one node, though they are visible and reachable from all nodes. To replicate queues across nodes in a cluster, use a queue type that supports replication.

Not sure if this is the best approach though:
It uses the alarms endpoint for connectivity rather than the /api/overview or /api/healthchecks/node/ endpoint as suggested in the feature request. This is because when alarm limits are reached, RabbitMQ will block connections that publish messages. /api/healthchecks/node/ has been depreciated so it is ruled out as well.

Type of change

New feature (non-breaking change which adds functionality)

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 (if any)

Suven-p · 2024-10-15T02:36:11Z

It also does not include validation for nodes input parameter. If the entered URL is not valid, axios throws an error. I am still looking for a way to add validation to Vue MultiSelect without adding an external library.

…p/uptime-kuma into 5066_add_rabbitmq_support

CommanderStorm

Overall, this looks reasonable. I have commented on a few aspects, but

Could you add a testcontainer via @testcontainers/rabbitmq?
Adding testcases prevents regressions for said monitoring type.

An (admitedly not quite happy with the implemntation) example can be found here:
https://github.com/louislam/uptime-kuma/pull/4451/files

server/monitor-types/rabbitmq.js

src/pages/EditMonitor.vue

server/monitor-types/rabbitmq.js

src/lang/en.json

CommanderStorm · 2024-10-17T14:41:14Z

Could you note the assumptions in the frontend?
Especially that users need to activate the monitoring plugin should be non-obvious..

PR makes the following assumptions:

Monitoring plugin is enabled. This is an optional plugin and it doesn't directly test the functionality of RabbitMQ like other monitors like Kafka and MQTT. However since RabbitMQ supports multiple protocols like AMQP, MQTT and STORM it might be better to have separate monitor for each protocol if the requirement is to monitor the functionality of queues.

If multiple nodes are provided, it is assumed that they are in a single cluster (without verification although it is possible to do so) and connection to a single node is sufficient to mark the monitor as UP. According to the docs,

All data/state required for the operation of a RabbitMQ broker is replicated across all nodes. An exception to this are message queues, which by default reside on one node, though they are visible and reachable from all nodes. To replicate queues across nodes in a cluster, use a queue type that supports replication.

Suven-p · 2024-10-19T12:45:47Z

Could you note the assumptions in the frontend? Especially that users need to activate the monitoring plugin should be non-obvious..

added it to the type string

test/backend-test/test-rabbitmq.js

CommanderStorm

Looks pretty good.
I have left two minor comments about frontend localisation, but otherwise would merge this as is. Great job 👍🏻

test/backend-test/test-rabbitmq.js

src/lang/en.json

src/pages/EditMonitor.vue

server/monitor-types/rabbitmq.js

Co-authored-by: Frank Elsinga <[email protected]>

CommanderStorm

Thanks for the new monitoring type! 🎉

I have left a few last changes below that make translating a bit more pleasant ^^

Note

This PR is part of the v2.0 merge window => see #4500 for the bugs that need to be addressed before we can ship this release ^^

_{All changes in this PR are small and uncontroversial ⇒ merging with junior maintainer approval}

src/pages/EditMonitor.vue

src/lang/en.json

src/pages/EditMonitor.vue

src/lang/en.json

louislam · 2024-10-26T11:53:33Z

test/backend-test/test-rabbitmq.js

+const { UP, DOWN, PENDING } = require("../../src/util");
+
+describe("RabbitMQ Single Node", {
+    skip: !!process.env.CI && (process.platform !== "linux" || process.arch !== "x64"),


It seems that this test blocked local testing on my Windows machine. It is also not able to run on a self-hosted X64 debian actions runner. What is the prerequisite to run this actually?

This is the platform support for running docker containers in GHA without additional steps.
=> This is not about the actual test case, but rather it's environment

What is the prerequisite to run this actually?

It assumes that docker is running on the system. AFAIK by default it searches for a unix socket at unix:///var/run/docker.sock in linux or a named pipe at npipe:////./pipe/docker_engine in windows.
On the debian machine, is the test skipped or does it throw an error?

Could not find a working container runtime strategy.

Full log:
https://github.com/louislam/uptime-kuma/actions/runs/11531916870/job/32103162510

Actually, I just realize the mqtt test has the same issue.

It assumes that docker is running on the system.

My actions runner on Debian indeed don't have Docker. Maybe that is the reason.

Add Rabbitmq monitor

2879b53

Suven-p added 5 commits October 15, 2024 08:21

Merge branch 'master' into 5066_add_rabbitmq_support

eeb614e

Add translation string

4c47d2f

Add description and validation for nodes input field

1c02023

Merge branch '5066_add_rabbitmq_support' of https://github.com/Suven-…

74da7e5

…p/uptime-kuma into 5066_add_rabbitmq_support

Update messages

4fa640b

Suven-p marked this pull request as ready for review October 16, 2024 01:36

Replace input type password with HiddenInput

44cd675

CommanderStorm requested changes Oct 17, 2024

View reviewed changes

github-actions bot added the needs:resolve-merge-conflict label Oct 18, 2024

Suven-p added 2 commits October 18, 2024 07:29

Make requested changes

009b004

Merge branch 'master' into 5066_add_rabbitmq_support

fd3dbff

github-actions bot removed the needs:resolve-merge-conflict label Oct 18, 2024

Change monitor type to specify management plugin

21a2d3c

CommanderStorm added pr:please address review comments this PR needs a bit more work to be mergable area:monitor Everything related to monitors labels Oct 18, 2024

Suven-p added 3 commits October 19, 2024 17:45

Bugfix: Correct validation for rabbitmq nodes

0ba3773

Add test containers

685043e

Add translation for RabbitMQ monitor type

7961ebb

Suven-p added 4 commits October 20, 2024 09:35

Fix linting error

bf32550

Bugfix: Add support for base url with path

73ee628

Save message for 503 status code

444661e

Fix relative path in test

6380df9

github-advanced-security bot found potential problems Oct 20, 2024

View reviewed changes

test/backend-test/test-rabbitmq.js Dismissed Show dismissed Hide dismissed

test/backend-test/test-rabbitmq.js Dismissed Show dismissed Hide dismissed

Suven-p requested a review from CommanderStorm October 20, 2024 05:22

CommanderStorm reviewed Oct 20, 2024

View reviewed changes

test/backend-test/test-rabbitmq.js Show resolved Hide resolved

src/lang/en.json Outdated Show resolved Hide resolved

src/pages/EditMonitor.vue Outdated Show resolved Hide resolved

server/monitor-types/rabbitmq.js Outdated Show resolved Hide resolved

Removed unnessesary comment

fc68042

Suven-p and others added 3 commits October 20, 2024 17:51

Update src/lang/en.json

7ce46d6

Co-authored-by: Frank Elsinga <[email protected]>

Add helptext

2a2b840

Remove helptext from monitor type

85f5552

CommanderStorm approved these changes Oct 20, 2024

View reviewed changes

src/pages/EditMonitor.vue Outdated Show resolved Hide resolved

src/lang/en.json Outdated Show resolved Hide resolved

src/pages/EditMonitor.vue Outdated Show resolved Hide resolved

src/lang/en.json Outdated Show resolved Hide resolved

Apply suggestions from code review

d1ad668

CommanderStorm removed the pr:please address review comments this PR needs a bit more work to be mergable label Oct 20, 2024

CommanderStorm changed the title ~~feat: Add Rabbitmq monitor~~ feat: add RabbitMQ monitor Oct 20, 2024

Merge branch 'master' into 5066_add_rabbitmq_support

9f23b5c

CommanderStorm merged commit c01494e into louislam:master Oct 20, 2024
18 checks passed

Suven-p deleted the 5066_add_rabbitmq_support branch October 20, 2024 14:05

CommanderStorm mentioned this pull request Oct 20, 2024

feat: add docker service availability monitoring #5215

Draft

7 tasks

louislam reviewed Oct 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `RabbitMQ` monitor #5199

feat: add `RabbitMQ` monitor #5199

Suven-p commented Oct 15, 2024 •

edited by CommanderStorm

Loading

Suven-p commented Oct 15, 2024 •

edited

Loading

CommanderStorm left a comment

CommanderStorm commented Oct 17, 2024

Suven-p commented Oct 19, 2024

CommanderStorm left a comment

CommanderStorm left a comment

louislam Oct 26, 2024

CommanderStorm Oct 26, 2024 •

edited

Loading

Suven-p Oct 26, 2024

louislam Oct 26, 2024 •

edited

Loading

feat: add RabbitMQ monitor #5199

feat: add RabbitMQ monitor #5199

Conversation

Suven-p commented Oct 15, 2024 • edited by CommanderStorm Loading

Description

Type of change

Checklist

Screenshots (if any)

Suven-p commented Oct 15, 2024 • edited Loading

CommanderStorm left a comment

Choose a reason for hiding this comment

CommanderStorm commented Oct 17, 2024

Suven-p commented Oct 19, 2024

CommanderStorm left a comment

Choose a reason for hiding this comment

CommanderStorm left a comment

Choose a reason for hiding this comment

louislam Oct 26, 2024

Choose a reason for hiding this comment

CommanderStorm Oct 26, 2024 • edited Loading

Choose a reason for hiding this comment

Suven-p Oct 26, 2024

Choose a reason for hiding this comment

louislam Oct 26, 2024 • edited Loading

Choose a reason for hiding this comment

feat: add `RabbitMQ` monitor #5199

feat: add `RabbitMQ` monitor #5199

Suven-p commented Oct 15, 2024 •

edited by CommanderStorm

Loading

Suven-p commented Oct 15, 2024 •

edited

Loading

CommanderStorm Oct 26, 2024 •

edited

Loading

louislam Oct 26, 2024 •

edited

Loading