Updated Legacy Package Versions and Restructured File Layout

Author: Furkan-Gulsen

.env-example

@@ -0,0 +1,8 @@
+defaultBindAddr=:8080
+defaultMetricsBindAddr=:8081
+defaultGrafanaURL=http://grafana:3000
+defaultGrafanaCredentials=admin:secret
+defaultAMQPURI=amqp://guest:guest@rabbitmq:5672/
+defaultAMQPQueue=deployments
+defaultKafkaBrokers=kafka:9092
+defaultKafkaTopic=events

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Furkan Gulsen
+Copyright (c) 2019 Three Dots Labs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1 +1,52 @@
-# Event Drivent Architecture with Golang
+# Event Driven Architecture with Golang (Example)
+
+This is an example Event-Driven application written in Go, using [Watermill](https://github.com/ThreeDotsLabs/watermill).
+
+The projects aims to integrate incoming GitHub webhooks with Grafana and Slack, essentially adding annotations and
+sending messages when a new commit is pushed. There are also simulated deployment messages sent over RabbitMQ to
+demonstrate working with multiple event streams.
+
+![](https://threedots.tech/media/event-driven-applications/diagram.png)
+
+An example result can look like this:
+
+![](https://threedots.tech/media/event-driven-applications/grafana.png)
+
+![](https://threedots.tech/media/event-driven-applications/slack.png)
+
+## Running
+
+If you'd like to integrate the example with your Slack workspace, copy `.env-example` to `.env` and fill in the
+webhook URL in `SLACK_WEBHOOK_URL` variable.
+
+In addition to the application, the docker-compose environment consists of:
+
+- **Kafka** and **ZooKeeper**
+- **RabbitMQ**
+- **Grafana**
+- **Prometheus**
+
+The whole environment can be run with:
+
+```bash
+docker-compose up
+```
+
+You can now configure your GitHub repository to send webhooks to the application (you need to expose port `8080` to the
+external network first).
+
+Alternatively, you can run `./scripts/send-stub-webhook.sh` to send some stub webhooks.
+
+Visit [localhost:3000/d/webhooks](http://localhost:3000/d/webhooks) to see annotations added in Grafana. Use
+`admin:secret` as credentials.
+
+## Metrics
+
+You can access the Watermill dashboard at [localhost:3000/d/watermill](http://localhost:3000/d/watermill). See what
+changes when you send more webhooks over time.
+
+![](https://threedots.tech/media/event-driven-applications/metrics.png)
+
+## What's next?
+
+See [Watermill's documentation](https://watermill.io/) to learn more.

myapp/Dockerfile renamed to app/Dockerfile

@@ -3,8 +3,8 @@ package main
 import (
 "context"
 
-"github.com/Furkan-Gulsen/Event-Driven-Architecture-with-Golang/config"
-"github.com/Furkan-Gulsen/Event-Driven-Architecture-with-Golang/internal"
+"github.com/ThreeDotsLabs/event-driven-example/config"
+"github.com/ThreeDotsLabs/event-driven-example/internal"
 "github.com/ThreeDotsLabs/watermill"
 "github.com/ThreeDotsLabs/watermill/components/metrics"
 "github.com/ThreeDotsLabs/watermill/message"

myapp/cmd/app/main.go renamed to app/cmd/app/main.go

@@ -31,6 +31,8 @@ type Config struct {
 
 KafkaBrokers []string
 KafkaTopic string
+
+SlackWebhookURL string
 }
 
 func LoadConfig() Config {
@@ -46,6 +48,8 @@ func LoadConfig() Config {
 
 GrafanaURL: getEnv("GRAFANA_URL", defaultGrafanaURL),
 GrafanaCredentials: getEnv("GRAFANA_CREDENTIALS", defaultGrafanaCredentials),
+
+SlackWebhookURL: getEnv("SLACK_WEBHOOK_URL", ""),
 }
 }
 

myapp/config/config.go renamed to app/config/config.go

@@ -1,4 +1,4 @@
-module github.com/Furkan-Gulsen/Event-Driven-Architecture-with-Golang
+module github.com/ThreeDotsLabs/event-driven-example
 
 go 1.21
 

myapp/go.mod renamed to app/go.mod

@@ -5,8 +5,8 @@ import (
 "math/rand"
 "time"
 
-"github.com/Furkan-Gulsen/Event-Driven-Architecture-with-Golang/config"
-"github.com/Furkan-Gulsen/Event-Driven-Architecture-with-Golang/pkg"
+"github.com/ThreeDotsLabs/event-driven-example/config"
+"github.com/ThreeDotsLabs/event-driven-example/pkg"
 "github.com/ThreeDotsLabs/watermill"
 "github.com/ThreeDotsLabs/watermill-amqp/pkg/amqp"
 "github.com/ThreeDotsLabs/watermill-http/pkg/http"
@@ -140,6 +140,26 @@ func (r *Router) SetupRouter() error {
 pkg.GrafanaHandler,
 )
 
+if r.Config.SlackWebhookURL != "" {
+slackPublisher, err := http.NewPublisher(
+http.PublisherConfig{
+MarshalMessageFunc: pkg.SlackMarshaller,
+}, r.Logger)
+if err != nil {
+return err
+}
+
+r.Router.AddHandler(
+"kafka-to-slack",
+r.Config.KafkaTopic,
+kafkaSubscriber,
+r.Config.SlackWebhookURL,
+slackPublisher,
+pkg.SlackHandler,
+)
+}
+
+// * DeploySimulator is a handler that simulates a deployment to a given environment.
 stagingDelay := time.Second * time.Duration(rand.Intn(60)+30)
 productionDelay := stagingDelay + time.Second*time.Duration(rand.Intn(120)+60)