Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/melyouz/risala
(WiP) gRPC based Message Broker written in Go for self learning purpose
https://github.com/melyouz/risala
broker go golang grpc message queue
Last synced: about 2 months ago
JSON representation
(WiP) gRPC based Message Broker written in Go for self learning purpose
- Host: GitHub
- URL: https://github.com/melyouz/risala
- Owner: melyouz
- License: mit
- Created: 2024-09-15T09:43:17.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-11-22T20:29:48.000Z (2 months ago)
- Last Synced: 2024-11-24T05:11:57.472Z (2 months ago)
- Topics: broker, go, golang, grpc, message, queue
- Language: Go
- Homepage:
- Size: 155 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Roadmap: roadmap.svg
Awesome Lists containing this project
README
# Risala
gRPC based Message Broker written in Go for self learning purpose.
## Running Locally
Follow these steps to run the project on your local machine:
1. **Install Go v1.23**
Ensure that Go v1.23 is installed. You can download it from [go.dev](https://go.dev/).
2. **Run the Broker**
Start the broker with sample data by navigating to the project directory and running:
```bash
cd broker && make run WITH_SAMPLE_DATA=1
```
3. **Run the Producer**
Navigate to the project directory and run the following command to start the producer (adjust EVENTS_COUNT to control the number of generated events):
```bash
cd producer && make run EVENTS_COUNT=1000
```
4. **Run the consumer**
Navigate to the project directory and run the following command to start the consumer:
```bash
cd consumer && make run
```
> Note: You can run multiple instances of Producers and Consumers.
> UI: Currently, there is no available UI.
## API Documentation
1. **Run the Broker**
Start the broker with sample data by navigating to the project directory and running:
```bash
cd broker && make run WITH_SAMPLE_DATA=1
```
2. Navigate to [API Documentation](http://localhost:8000/api/v1/docs/index.html) (Swagger UI).
## Roadmap
* v1.0.0 ([released](https://github.com/melyouz/risala/releases/tag/v1.0.0))
* v1.1.0
+ Broker
* Publish messages (gRPC).
* Consume messages (gRPC).
* Acknowledge messages (gRPC).
* Negatively acknowledge messages (gRPC).
+ Producer
* Publish messages (gRPC).
+ Consumer
* Consume messages (gRPC).
* Acknowledge messages (gRPC).
* Negatively acknowledge messages (gRPC).
* Further versions (TBD)
+ Broker
* Retry mechanism.
* Persistence layer (TBD).
* More exchange types
* Fanout: Route messages to all bound in queues (existing from MVP).
* Direct: Route messages to bound in queues matching exact routing key (e.g. event.product.create.v1).
* Topic: Route messages to bound in queues matching wildcard routing key (e.g. #, event.product.#,
event.product.*.v1, ...).
* More queue types
* Transient: Temporary in memory queue (existing from MVP).
* Durable: Persisted queue.
* More binding types:
* To queue (existing from MVP).
* To exchange: Route messages to another exchange.
* Tracing (e.g. Zipkin).
* Logging (e.g. Vector + Grafana Loki, Datadog, ...).
+ Consumer
* Tracing.
* Logging.
+ Producer
* Tracing.
* Logging.
## Suggestions
Any suggestion/recommendation? Just let me know! I appreciate it in advance 😊