Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.43 KB

README.md

File metadata and controls

63 lines (43 loc) · 1.43 KB
Raw

RoccaForte

Event Aggregation And Notification.

Big Picture

                        --------------------
 Event ---> (HTTP) ---> |                  |
 Event ---> (Queue) --> |    RoccaForte    |----> Aggregated notification
 Event ---> (Other) --> |    (Incoming)    |
                        |                  |
                        --------------------

Features

Aggregation

Events that are of the same type are aggregated by the time received, so that only one notification in, for example, every 5 minutes, no matter how many events of the same type are received during that time frame.

Notification

Notifications bundle multiple events, and carry only enough information for the clients to query back to RoccaForte what exactly the events were.

Destination

Destination is anywhere we can deliver our notifications to. The most basic type of the destination is an HTTP endpoint, but could be anything, really.

Components

rf-in

Handles incoming events. Aggregates events, and stores them

rf-controller

Given delivery rules, enqueues notification tasks.

rf-out

Receives notification tasks from queue, and delivers notifications to destinations.

Client

import(
  "github.com/lestrrat/roccaforte/event"
  "github.com/lestrrat/roccaforte/client/http"
)

func main() {
  cl := http.New("http://roccaforte:8080/enqueue")
  ev := event.New()
  if err := cl.Enqueue(ev); err != nil {
    ...
  }
}