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.

2. Run the Broker
   Start the broker with sample data by navigating to the project directory and running:

   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):

   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:

   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:

   cd broker && make run WITH_SAMPLE_DATA=1

2. Navigate to API Documentation (Swagger UI).

Roadmap

• v1.0.0 (released)
• 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 😊