Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/virtocommerce/vc-module-event-bus

The module enables you to be notified of new messages or changes via a Message Queue of your choice, for example, Azure Event Grid
https://github.com/virtocommerce/vc-module-event-bus

azure azureeventgrid eventbus events reactive-programming

Last synced: 3 months ago
JSON representation

The module enables you to be notified of new messages or changes via a Message Queue of your choice, for example, Azure Event Grid

Host: GitHub
URL: https://github.com/virtocommerce/vc-module-event-bus
Owner: VirtoCommerce
License: other
Created: 2021-01-25T12:58:14.000Z (about 4 years ago)
Default Branch: dev
Last Pushed: 2024-03-15T08:03:18.000Z (11 months ago)
Last Synced: 2024-03-16T08:37:39.678Z (11 months ago)
Topics: azure, azureeventgrid, eventbus, events, reactive-programming
Language: C#
Homepage:
Size: 356 KB
Stars: 4
Watchers: 15
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # Virto Commerce Event Bus Module

[![CI status](https://github.com/VirtoCommerce/vc-module-event-bus/workflows/Module%20CI/badge.svg?branch=dev)](https://github.com/VirtoCommerce/vc-module-event-bus/actions?query=workflow%3A"Module+CI") [![Quality gate](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-module-event-bus&metric=alert_status&branch=dev)](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-module-event-bus) [![Reliability rating](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-module-event-bus&metric=reliability_rating&branch=dev)](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-module-event-bus) [![Security rating](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-module-event-bus&metric=security_rating&branch=dev)](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-module-event-bus) [![Sqale rating](https://sonarcloud.io/api/project_badges/measure?project=VirtoCommerce_vc-module-event-bus&metric=sqale_rating&branch=dev)](https://sonarcloud.io/dashboard?id=VirtoCommerce_vc-module-event-bus)

This module enables you to be notified of new Virto Commerce events or changes via the message queue of your choice.

The module is used to trigger an asynchronous background process in response to an event on the Virto Commerce platform.

![Event Bus Schema Overview](docs/media/event-bus-overview.PNG)

As a payload, a Virto Commerce event delivers one of the predefined messages or any change to a resource. This enables event-driven reactive programming, which uses a publish-subscribe model. Publishers emit events but have no expectation about which events are handled. Subscribers decide which events they want to handle.

The event description is based on *CloudEvents: "specification for describing event data in a common way*.

## Key Features

* Notification on new events from any module

* Supporting multiple destination providers

* Supporting custom destination providers (contact us if you need a new destination)

* Configurable via API as well as through application configuration (`appsettings.json`, environment variables, etc.)

* Additional event filtering with the `JsonPath` expression

* Preprocessing event data with Liquid template enables fine-tuning the payload for the destination provider

* High performance

* Predefined destination provider:  [Azure Event Grid](https://azure.microsoft.com/en-us/services/event-grid) with [CloudEvents](https://cloudevents.io/)-based data format

## Documentation

* [Module Documentation](https://virtocommerce.com/docs/latest/modules/event-bus/)

* [View on GitHub](docs/index.md)

## References

* Deployment: https://virtocommerce.com/docs/latest/developer-guide/deploy-module-from-source-code/

* Installation: https://www.virtocommerce.com/docs/latest/user-guide/modules/

* Home: https://virtocommerce.com

* Community: https://www.virtocommerce.org

* [Download Latest Release](https://github.com/VirtoCommerce/vc-module-event-bus/releases/latest)

## License

Copyright (c) Virto Solutions LTD.  All rights reserved.

This software is licensed under the Virto Commerce Open Software License (the "License"); you

may not use this file except in compliance with the License. You may

obtain a copy of the License at http://virtocommerce.com/opensourcelicense.

Unless required by the applicable law or agreed to in written form, the software

distributed under the License is provided on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

implied.