feature: webhooks

[shwstppr]

Description

Feature spec: https://cwiki.apache.org/confluence/display/CLOUDSTACK/Webhooks

Webhooks allow external services to be notified when certain events happen.

To implement and make Webhook work as an event bus, changes have been made to publish messages on multiple active message buses.
Fixes #6778

Documentation PR: apache/cloudstack-documentation#385

Types of changes

• Breaking change (fix or feature that would cause existing functionality to change)
• New feature (non-breaking change which adds functionality)
• Bug fix (non-breaking change which fixes an issue)
• Enhancement (improves an existing feature and functionality)
• Cleanup (Code refactoring and cleanup, that may add test cases)
• build/CI

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

• Major
• Minor

Bug Severity

• BLOCKER
• Critical
• Major
• Minor
• Trivial

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

[codecov]

Codecov Report

Attention: Patch coverage is 58.53324% with 605 lines in your changes are missing coverage. Please review.

Project coverage is 31.34%. Comparing base (a0b642c) to head (b054e0c).
Report is 1 commits behind head on main.

Files	Patch %	Lines
.../cloudstack/mom/webhook/WebhookApiServiceImpl.java	62.42%	80 Missing and 41 partials ⚠️
ui/src/views/tools/CreateWebhook.vue	0.00%	82 Missing ⚠️
ui/src/components/view/WebhookDeliveriesTab.vue	0.00%	69 Missing ⚠️
ui/src/components/view/TestWebhookDeliveryView.vue	0.00%	52 Missing ⚠️
...che/cloudstack/mom/webhook/WebhookServiceImpl.java	69.86%	37 Missing and 7 partials ⚠️
.../cloudstack/mom/webhook/WebhookDeliveryThread.java	74.80%	23 Missing and 9 partials ⚠️
...rg/apache/cloudstack/mom/webhook/vo/WebhookVO.java	49.18%	31 Missing ⚠️
ui/src/config/section/tools.js	0.00%	30 Missing ⚠️
ui/src/views/tools/TestWebhookDelivery.vue	0.00%	22 Missing ⚠️
ui/src/components/view/SearchView.vue	5.26%	18 Missing ⚠️
... and 19 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #8674      +/-   ##
============================================
+ Coverage     30.91%   31.34%   +0.43%     
- Complexity    33734    34355     +621     
============================================
  Files          5404     5432      +28     
  Lines        380289   381645    +1356     
  Branches      55489    55655     +166     
============================================
+ Hits         117550   119634    +2084     
+ Misses       247104   246194     -910     
- Partials      15635    15817     +182     

Flag	Coverage Δ
simulator-marvin-tests	25.20% <68.63%> (+0.66%)	⬆️
uitests	4.31% <1.38%> (-0.03%)	⬇️
unit-tests	16.89% <18.97%> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

[yadvr]

@blueorangutan package

[blueorangutan]

@rohityadavcloud a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

[blueorangutan]

Packaging result [SF]: ✖️ el7 ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 9818

[DaanHoogland]

@blueorangutan package

[blueorangutan]

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

[blueorangutan]

Packaging result [SF]: ✖️ el7 ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 9820

[shwstppr]

@blueorangutan package

[blueorangutan]

@shwstppr a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

[blueorangutan]

Packaging result [SF]: ✔️ el7 ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 9822

[shwstppr]

@blueorangutan test

[blueorangutan]

@shwstppr a [SL] Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

[blueorangutan]

[SF] Trillian Build Failed (tid-10391)

[shwstppr]

@blueorangutan test

[blueorangutan]

@shwstppr a [SL] Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

[blueorangutan]

[SF] Trillian test result (tid-10394)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 44993 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr8674-t10394-kvm-centos7.zip
Smoke tests completed. 134 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

[btzq]

@shwstppr this is a great feature for us.
Does this include Healthcheck Fails for Virtual Routers?

[shwstppr]

@btzq I'm not sure if ACS currently publishes a separate event for router healthcheck fails but it does publish an event with type ROUTER.HEALTH.CHECKS which can be used in the webhook.

An example description of such event,

Router r-9-VM / 9974ef30-b2fe-4c05-a2e3-57d3cfaf0b4b has failing checks: gateways_check.py

[btzq]

@shwstppr under events, i only could find this:

But it seems to be under (Level = INFO) (Type = Health Check)

[btzq]

@shwstppr I think thats pretty good for us, we just need to have an alert when there is a failing health check.

Right now, we have to login in ACS every few minutes and check the UI. We dont have RabbitMQ/Kafka installed.

[shwstppr]

@btzq that Type showing as Health check is a UI thing. If you check the API response it will have proper type,

    "listeventsresponse": {
        "count": 1,
        "event": [
            {
                "id": "36c995da-7b14-4083-9164-c486c7796b8c",
                "username": "system",
                "type": "ROUTER.HEALTH.CHECKS",
                "level": "INFO",
                "description": "Router r-9-VM / 9974ef30-b2fe-4c05-a2e3-57d3cfaf0b4b has failing checks: gateways_check.py",
                "account": "system",
                "domainid": "62a64961-4b15-11ef-953b-1e0054000142",
                "domain": "ROOT",
                "resourceid": "9974ef30-b2fe-4c05-a2e3-57d3cfaf0b4b",
                "resourcetype": "DomainRouter",
                "resourcename": "r-9-VM",
                "created": "2024-08-28T05:13:46+0000",
                "state": "Completed"
            }
        ]
    }

Maybe test creating a Global webhook and try there

[btzq]

I see, Thank you @shwstppr excited to test this!