Getting started

Watermill up and running.

What is Watermill?

Watermill is a Golang library for working efficiently with message streams. It is intended for building event-drivenapplications. It can be used for event sourcing, RPC over messages, sagas, and whatever else comes to your mind.You can use conventional pub/sub implementations like Kafka or RabbitMQ, but also HTTP or MySQL binlog, if that fits your use case.

It comes with a set of Pub/Sub implementations and can be easily extended by your own.

Watermill also ships with standard middlewares like instrumentation, poison queue, throttling, correlation,and other tools used by every message-driven application.

Why use Watermill?

With more projects adopting the microservices pattern over recent years, we realized that synchronous communicationis not always the right choice. Asynchronous methods started to grow as a new standard way to communicate.

But while there’s a lot of existing tooling for synchronous integration patterns (e.g. HTTP), correctly setting upa message-oriented project can be a challenge. There’s a lot of different message queues and streaming systems,each with different features and client library API.

Watermill aims to be the standard messaging library for Go, hiding all that complexity behind an API that is easy tounderstand. It provides all you might need for building an application based on events or other asynchronous patterns.After looking at the examples, you should be able to quickly integrate Watermill with your project.

Install

  1. go get -u github.com/ThreeDotsLabs/watermill

One Minute Background

The basic idea behind event-driven applications stays always the same: listen for incoming messages and react to them.Watermill supports this behavior for multiple publishers and subscribers.

The core part of Watermill is the Message. It is as important as http.Requestis for the http package. Most Watermill features use this struct in some way.

Even though PubSub libraries come with complex features, for Watermill it’s enough to implement two interfaces to startworking with them: the Publisher and Subscriber.

  1. type Publisher interface {
  2.     Publish(topic string, messages ...*Message) error
  3.     Close() error
  4. }
  6. type Subscriber interface {
  7.     Subscribe(ctx context.Context, topic string) (<-chan *Message, error)
  8.     Close() error
  9. }

Subscribing for Messages

Let’s start with subscribing. Subscribe expects a topic name and returns a channel of incoming messages.What topic exactly means depends on the PubSub implementation.

  1. messages, err := subscriber.Subscribe(ctx, "example.topic")
  2. if err != nil {
  3.     panic(err)
  4. }
  6. for msg := range messages {
  7.     fmt.Printf("received message: %s, payload: %s\n", msg.UUID, string(msg.Payload))
  8.     msg.Ack()
  9. }

See detailed examples below for supported PubSubs.

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/go-channel/main.go

  1. // ...
  2. package main
  4. import (
  5.     "context"
  6.     "log"
  7.     "time"
  9.     "github.com/ThreeDotsLabs/watermill"
  10.     "github.com/ThreeDotsLabs/watermill/message"
  11.     "github.com/ThreeDotsLabs/watermill/pubsub/gochannel"
  12. )
  14. func main() {
  15.     pubSub := gochannel.NewGoChannel(
  16.         gochannel.Config{},
  17.         watermill.NewStdLogger(false, false),
  18.     )
  20.     messages, err := pubSub.Subscribe(context.Background(), "example.topic")
  21.     if err != nil {
  22.         panic(err)
  23.     }
  25.     go process(messages)
  26. // ...

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/go-channel/main.go

  1. // ...
  2. func process(messages <-chan *message.Message) {
  3.     for msg := range messages {
  4.         log.Printf("received message: %s, payload: %s", msg.UUID, string(msg.Payload))
  6.         // we need to Acknowledge that we received and processed the message,
  7.        // otherwise, it will be resent over and over again.
  8.        msg.Ack()
  9.     }
  10. }

Running in Docker

The easiest way to run Watermill locally with Kafka is using Docker.

Full source: _examples/pubsubs/kafka/docker-compose.yml

  1. version: '3'
  2. services:
  3.   server:
  4.     image: golang:1.11
  5.     restart: unless-stopped
  6.     depends_on:
  7.       - kafka
  8.     volumes:
  9.       - .:/app
  10.       - $GOPATH/pkg/mod:/go/pkg/mod
  11.     working_dir: /app
  12.     command: go run main.go
  14.   zookeeper:
  15.     image: confluentinc/cp-zookeeper:latest
  16.     restart: unless-stopped
  17.     logging:
  18.       driver: none
  19.     environment:
  20.       ZOOKEEPER_CLIENT_PORT: 2181
  22.   kafka:
  23.     image: confluentinc/cp-kafka:latest
  24.     restart: unless-stopped
  25.     depends_on:
  26.       - zookeeper
  27.     logging:
  28.       driver: none
  29.     environment:
  30.       KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
  31.       KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:9092
  32.       KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
  33.       KAFKA_AUTO_CREATE_TOPICS_ENABLE: "true"

The source should go to main.go.

To run, execute docker-compose up command.

A more detailed explanation of how it is working (and how to add live code reload) can be found in Go Docker dev environment article.

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/kafka/main.go

  1. // ...
  2. package main
  4. import (
  5.     "context"
  6.     "log"
  7.     "time"
  9.     "github.com/Shopify/sarama"
  11.     "github.com/ThreeDotsLabs/watermill"
  12.     "github.com/ThreeDotsLabs/watermill-kafka/v2/pkg/kafka"
  13.     "github.com/ThreeDotsLabs/watermill/message"
  14. )
  16. func main() {
  17.     saramaSubscriberConfig := kafka.DefaultSaramaSubscriberConfig()
  18.     // equivalent of auto.offset.reset: earliest
  19.    saramaSubscriberConfig.Consumer.Offsets.Initial = sarama.OffsetOldest
  21.     subscriber, err := kafka.NewSubscriber(
  22.         kafka.SubscriberConfig{
  23.             Brokers:               []string{"kafka:9092"},
  24.             Unmarshaler:           kafka.DefaultMarshaler{},
  25.             OverwriteSaramaConfig: saramaSubscriberConfig,
  26.             ConsumerGroup:         "test_consumer_group",
  27.         },
  28.         watermill.NewStdLogger(false, false),
  29.     )
  30.     if err != nil {
  31.         panic(err)
  32.     }
  34.     messages, err := subscriber.Subscribe(context.Background(), "example.topic")
  35.     if err != nil {
  36.         panic(err)
  37.     }
  39.     go process(messages)
  40. // ...

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/kafka/main.go

  1. // ...
  2. func process(messages <-chan *message.Message) {
  3.     for msg := range messages {
  4.         log.Printf("received message: %s, payload: %s", msg.UUID, string(msg.Payload))
  6.         // we need to Acknowledge that we received and processed the message,
  7.        // otherwise, it will be resent over and over again.
  8.        msg.Ack()
  9.     }
  10. }

Running in Docker

The easiest way to run Watermill locally with NATS is using Docker.

Full source: _examples/pubsubs/nats-streaming/docker-compose.yml

  1. version: '3'
  2. services:
  3.   server:
  4.     image: golang:1.11
  5.     restart: unless-stopped
  6.     depends_on:
  7.       - nats-streaming
  8.     volumes:
  9.       - .:/app
  10.       - $GOPATH/pkg/mod:/go/pkg/mod
  11.     working_dir: /app
  12.     command: go run main.go
  14.   nats-streaming:
  15.     image: nats-streaming:0.11.2
  16.     restart: unless-stopped

The source should go to main.go.

To run execute docker-compose up command.

A more detailed explanation of how it is working (and how to add live code reload) can be found in Go Docker dev environment article.

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/nats-streaming/main.go

  1. // ...
  2. package main
  4. import (
  5.     "context"
  6.     "log"
  7.     "time"
  9.     stan "github.com/nats-io/stan.go"
  11.     "github.com/ThreeDotsLabs/watermill"
  12.     "github.com/ThreeDotsLabs/watermill-nats/pkg/nats"
  13.     "github.com/ThreeDotsLabs/watermill/message"
  14. )
  16. func main() {
  17.     subscriber, err := nats.NewStreamingSubscriber(
  18.         nats.StreamingSubscriberConfig{
  19.             ClusterID:        "test-cluster",
  20.             ClientID:         "example-subscriber",
  21.             QueueGroup:       "example",
  22.             DurableName:      "my-durable",
  23.             SubscribersCount: 4, // how many goroutines should consume messages
  24.            CloseTimeout:     time.Minute,
  25.             AckWaitTimeout:   time.Second * 30,
  26.             StanOptions: []stan.Option{
  27.                 stan.NatsURL("nats://nats-streaming:4222"),
  28.             },
  29.             Unmarshaler: nats.GobMarshaler{},
  30.         },
  31.         watermill.NewStdLogger(false, false),
  32.     )
  33.     if err != nil {
  34.         panic(err)
  35.     }
  37.     messages, err := subscriber.Subscribe(context.Background(), "example.topic")
  38.     if err != nil {
  39.         panic(err)
  40.     }
  42.     go process(messages)
  43. // ...

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/nats-streaming/main.go

  1. // ...
  2. func process(messages <-chan *message.Message) {
  3.     for msg := range messages {
  4.         log.Printf("received message: %s, payload: %s", msg.UUID, string(msg.Payload))
  6.         // we need to Acknowledge that we received and processed the message,
  7.        // otherwise, it will be resent over and over again.
  8.        msg.Ack()
  9.     }
  10. }

Running in Docker

You can run Google Cloud Pub/Sub emulator locally for development.

Full source: _examples/pubsubs/googlecloud/docker-compose.yml

  1. version: '3'
  2. services:
  3.   server:
  4.     image: golang:1.11
  5.     restart: unless-stopped
  6.     depends_on:
  7.       - googlecloud
  8.     volumes:
  9.       - .:/app
  10.       - $GOPATH/pkg/mod:/go/pkg/mod
  11.     environment:
  12.       # use local emulator instead of google cloud engine
  13.       PUBSUB_EMULATOR_HOST: "googlecloud:8085"
  14.     working_dir: /app
  15.     command: go run main.go
  17.   googlecloud:
  18.     image: google/cloud-sdk:228.0.0
  19.     entrypoint: gcloud --quiet beta emulators pubsub start --host-port=googlecloud:8085 --verbosity=debug --log-http
  20.     restart: unless-stopped

The source should go to main.go.

To run, execute docker-compose up.

A more detailed explanation of how it is working (and how to add live code reload) can be found in Go Docker dev environment article.

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/googlecloud/main.go

  1. // ...
  2. package main
  4. import (
  5.     "context"
  6.     "log"
  7.     "time"
  9.     "github.com/ThreeDotsLabs/watermill"
  10.     "github.com/ThreeDotsLabs/watermill-googlecloud/pkg/googlecloud"
  11.     "github.com/ThreeDotsLabs/watermill/message"
  12. )
  14. func main() {
  15.     logger := watermill.NewStdLogger(false, false)
  16.     subscriber, err := googlecloud.NewSubscriber(
  17.         googlecloud.SubscriberConfig{
  18.             // custom function to generate Subscription Name,
  19.            // there are also predefined TopicSubscriptionName and TopicSubscriptionNameWithSuffix available.
  20.            GenerateSubscriptionName: func(topic string) string {
  21.                 return "test-sub_" + topic
  22.             },
  23.             ProjectID: "test-project",
  24.         },
  25.         logger,
  26.     )
  27.     if err != nil {
  28.         panic(err)
  29.     }
  31.     // Subscribe will create the subscription. Only messages that are sent after the subscription is created may be received.
  32.    messages, err := subscriber.Subscribe(context.Background(), "example.topic")
  33.     if err != nil {
  34.         panic(err)
  35.     }
  37.     go process(messages)
  38. // ...

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/googlecloud/main.go

  1. // ...
  2. func process(messages <-chan *message.Message) {
  3.     for msg := range messages {
  4.         log.Printf("received message: %s, payload: %s", msg.UUID, string(msg.Payload))
  6.         // we need to Acknowledge that we received and processed the message,
  7.        // otherwise, it will be resent over and over again.
  8.        msg.Ack()
  9.     }
  10. }

Running in Docker

Full source: _examples/pubsubs/amqp/docker-compose.yml

  1. version: '3'
  2. services:
  3.   server:
  4.     image: golang:1.11
  5.     restart: unless-stopped
  6.     depends_on:
  7.       - rabbitmq
  8.     volumes:
  9.       - .:/app
  10.       - $GOPATH/pkg/mod:/go/pkg/mod
  11.     working_dir: /app
  12.     command: go run main.go
  14.   rabbitmq:
  15.     image: rabbitmq:3.7
  16.     restart: unless-stopped

The source should go to main.go.

To run, execute docker-compose up.

A more detailed explanation of how it is working (and how to add live code reload) can be found in Go Docker dev environment article.

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/amqp/main.go

  1. // ...
  2. package main
  4. import (
  5.     "context"
  6.     "log"
  7.     "time"
  9.     "github.com/ThreeDotsLabs/watermill"
  10.     "github.com/ThreeDotsLabs/watermill-amqp/pkg/amqp"
  11.     "github.com/ThreeDotsLabs/watermill/message"
  12. )
  14. var amqpURI = "amqp://guest:guest@rabbitmq:5672/"
  16. func main() {
  17.     amqpConfig := amqp.NewDurableQueueConfig(amqpURI)
  19.     subscriber, err := amqp.NewSubscriber(
  20.         // This config is based on this example: https://www.rabbitmq.com/tutorials/tutorial-two-go.html
  21.        // It works as a simple queue.
  22.        //
  23.        // If you want to implement a Pub/Sub style service instead, check
  24.        // https://watermill.io/docs/pub-sub-implementations/#amqp-consumer-groups
  25.        amqpConfig,
  26.         watermill.NewStdLogger(false, false),
  27.     )
  28.     if err != nil {
  29.         panic(err)
  30.     }
  32.     messages, err := subscriber.Subscribe(context.Background(), "example.topic")
  33.     if err != nil {
  34.         panic(err)
  35.     }
  37.     go process(messages)
  38. // ...

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/amqp/main.go

  1. // ...
  2. func process(messages <-chan *message.Message) {
  3.     for msg := range messages {
  4.         log.Printf("received message: %s, payload: %s", msg.UUID, string(msg.Payload))
  6.         // we need to Acknowledge that we received and processed the message,
  7.        // otherwise, it will be resent over and over again.
  8.        msg.Ack()
  9.     }
  10. }

Running in Docker

Full source: _examples/pubsubs/sql/docker-compose.yml

  1. version: '3'
  2. services:
  3.   server:
  4.     image: golang:1.12
  5.     restart: unless-stopped
  6.     depends_on:
  7.       - mysql
  8.     volumes:
  9.       - .:/app
  10.       - $GOPATH/pkg/mod:/go/pkg/mod
  11.     working_dir: /app
  12.     command: go run main.go
  14.   mysql:
  15.     image: mysql:8.0
  16.     restart: unless-stopped
  17.     ports:
  18.       - 3306:3306
  19.     environment:
  20.       MYSQL_DATABASE: watermill
  21.       MYSQL_ALLOW_EMPTY_PASSWORD: "yes"

The source should go to main.go.

To run, execute docker-compose up.

A more detailed explanation of how it is working (and how to add live code reload) can be found in Go Docker dev environment article.

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/sql/main.go

  1. // ...
  2. package main
  4. import (
  5.     "context"
  6.     stdSQL "database/sql"
  7.     "log"
  8.     "time"
  10.     driver "github.com/go-sql-driver/mysql"
  12.     "github.com/ThreeDotsLabs/watermill"
  13.     "github.com/ThreeDotsLabs/watermill-sql/pkg/sql"
  14.     "github.com/ThreeDotsLabs/watermill/message"
  15. )
  17. func main() {
  18.     db := createDB()
  19.     logger := watermill.NewStdLogger(false, false)
  21.     subscriber, err := sql.NewSubscriber(
  22.         db,
  23.         sql.SubscriberConfig{
  24.             SchemaAdapter:    sql.DefaultSchema{},
  25.             OffsetsAdapter:   sql.DefaultMySQLOffsetsAdapter{},
  26.             InitializeSchema: true,
  27.         },
  28.         logger,
  29.     )
  30.     if err != nil {
  31.         panic(err)
  32.     }
  34.     messages, err := subscriber.Subscribe(context.Background(), "example_topic")
  35.     if err != nil {
  36.         panic(err)
  37.     }
  39.     go process(messages)
  40. // ...

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/sql/main.go

  1. // ...
  2. func process(messages <-chan *message.Message) {
  3.     for msg := range messages {
  4.         log.Printf("received message: %s, payload: %s", msg.UUID, string(msg.Payload))
  6.         // we need to Acknowledge that we received and processed the message,
  7.        // otherwise, it will be resent over and over again.
  8.        msg.Ack()
  9.     }
  10. }

Creating Messages

Watermill doesn’t enforce any message format. NewMessage expects a slice of bytes as the payload. You can usestrings, JSON, protobuf, Avro, gob, or anything else that serializes to []byte.

The message UUID is optional, but recommended, as it helps with debugging.

  1. msg := message.NewMessage(watermill.NewUUID(), []byte("Hello, world!"))

Publishing Messages

Publish expects a topic and one or more Messages to be published.

  1. err := publisher.Publish("example.topic", msg)
  2. if err != nil {
  3.     panic(err)
  4. }

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/go-channel/main.go

  1. // ...
  2.    go process(messages)
  4.     publishMessages(pubSub)
  5. }
  7. func publishMessages(publisher message.Publisher) {
  8.     for {
  9.         msg := message.NewMessage(watermill.NewUUID(), []byte("Hello, world!"))
  11.         if err := publisher.Publish("example.topic", msg); err != nil {
  12.             panic(err)
  13.         }
  15.         time.Sleep(time.Second)
  16. // ...

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/kafka/main.go

  1. // ...
  2.    go process(messages)
  4.     publisher, err := kafka.NewPublisher(
  5.         kafka.PublisherConfig{
  6.             Brokers:   []string{"kafka:9092"},
  7.             Marshaler: kafka.DefaultMarshaler{},
  8.         },
  9.         watermill.NewStdLogger(false, false),
  10.     )
  11.     if err != nil {
  12.         panic(err)
  13.     }
  15.     publishMessages(publisher)
  16. }
  18. func publishMessages(publisher message.Publisher) {
  19.     for {
  20.         msg := message.NewMessage(watermill.NewUUID(), []byte("Hello, world!"))
  22.         if err := publisher.Publish("example.topic", msg); err != nil {
  23.             panic(err)
  24.         }
  26.         time.Sleep(time.Second)
  27. // ...

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/nats-streaming/main.go

  1. // ...
  2.    go process(messages)
  4.     publisher, err := nats.NewStreamingPublisher(
  5.         nats.StreamingPublisherConfig{
  6.             ClusterID: "test-cluster",
  7.             ClientID:  "example-publisher",
  8.             StanOptions: []stan.Option{
  9.                 stan.NatsURL("nats://nats-streaming:4222"),
  10.             },
  11.             Marshaler: nats.GobMarshaler{},
  12.         },
  13.         watermill.NewStdLogger(false, false),
  14.     )
  15.     if err != nil {
  16.         panic(err)
  17.     }
  19.     publishMessages(publisher)
  20. }
  22. func publishMessages(publisher message.Publisher) {
  23.     for {
  24.         msg := message.NewMessage(watermill.NewUUID(), []byte("Hello, world!"))
  26.         if err := publisher.Publish("example.topic", msg); err != nil {
  27.             panic(err)
  28.         }
  30.         time.Sleep(time.Second)
  31. // ...

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/googlecloud/main.go

  1. // ...
  2.    go process(messages)
  4.     publisher, err := googlecloud.NewPublisher(googlecloud.PublisherConfig{
  5.         ProjectID: "test-project",
  6.     }, logger)
  7.     if err != nil {
  8.         panic(err)
  9.     }
  11.     publishMessages(publisher)
  12. }
  14. func publishMessages(publisher message.Publisher) {
  15.     for {
  16.         msg := message.NewMessage(watermill.NewUUID(), []byte("Hello, world!"))
  18.         if err := publisher.Publish("example.topic", msg); err != nil {
  19.             panic(err)
  20.         }
  22.         time.Sleep(time.Second)
  23. // ...

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/amqp/main.go

  1. // ...
  2.    go process(messages)
  4.     publisher, err := amqp.NewPublisher(amqpConfig, watermill.NewStdLogger(false, false))
  5.     if err != nil {
  6.         panic(err)
  7.     }
  9.     publishMessages(publisher)
  10. }
  12. func publishMessages(publisher message.Publisher) {
  13.     for {
  14.         msg := message.NewMessage(watermill.NewUUID(), []byte("Hello, world!"))
  16.         if err := publisher.Publish("example.topic", msg); err != nil {
  17.             panic(err)
  18.         }
  20.         time.Sleep(time.Second)
  21. // ...

Full source: github.com/ThreeDotsLabs/watermill/_examples/pubsubs/sql/main.go

  1. // ...
  2.    go process(messages)
  4.     publisher, err := sql.NewPublisher(
  5.         db,
  6.         sql.PublisherConfig{
  7.             SchemaAdapter: sql.DefaultSchema{},
  8.         },
  9.         logger,
  10.     )
  11.     if err != nil {
  12.         panic(err)
  13.     }
  15.     publishMessages(publisher)
  16. }
  18. func createDB() *stdSQL.DB {
  19.     conf := driver.NewConfig()
  20.     conf.Net = "tcp"
  21.     conf.User = "root"
  22.     conf.Addr = "mysql"
  23.     conf.DBName = "watermill"
  25.     db, err := stdSQL.Open("mysql", conf.FormatDSN())
  26.     if err != nil {
  27.         panic(err)
  28.     }
  30.     err = db.Ping()
  31.     if err != nil {
  32.         panic(err)
  33.     }
  35.     return db
  36. }
  38. func publishMessages(publisher message.Publisher) {
  39.     for {
  40.         msg := message.NewMessage(watermill.NewUUID(), []byte(`{"message": "Hello, world!"}`))
  42.         if err := publisher.Publish("example_topic", msg); err != nil {
  43.             panic(err)
  44.         }
  46.         time.Sleep(time.Second)
  47. // ...

Using Message Router

Publishers and subscribers are rather low-level parts of Watermill.In most cases, you’d usually want to use a high-level interface and features like correlation, metrics, poison queue, retrying, throttling, etc..

You might want to send an Ack only if the message was processed successfully.In other cases, you’ll Ack immediately and then worry about processing.Sometimes, you want to perform some action based on the incoming message, and publish another message in response.

To handle these requirements, there is a component named Router.

Example application of Message Router

The flow of the example application looks like this:

  • A message is produced on topic incoming_messages_topic every second.
  • struct_handler handler listens on incoming_messages_topic. When a message is received, the UUID is printed and a new message is produced on outgoing_messages_topic.
  • print_incoming_messages handler listens on incoming_messages_topic and prints the messages’ UUID, payload and metadata.
  • print_outgoing_messages handler listens on outgoing_messages_topic and prints the messages’ UUID, payload and metadata. Correlation ID should be the same as in the message on incoming_messages_topic.

Router configuration

Start with configuring the router, adding plugins and middlewares.Then set up handlers that the router will use. Each handler will independently handle messages.

Full source: github.com/ThreeDotsLabs/watermill/_examples/basic/3-router/main.go

  1. // ...
  2. package main
  4. import (
  5.     "context"
  6.     "fmt"
  7.     "log"
  8.     "time"
  10.     "github.com/ThreeDotsLabs/watermill"
  11.     "github.com/ThreeDotsLabs/watermill/message"
  12.     "github.com/ThreeDotsLabs/watermill/message/router/middleware"
  13.     "github.com/ThreeDotsLabs/watermill/message/router/plugin"
  14.     "github.com/ThreeDotsLabs/watermill/pubsub/gochannel"
  15. )
  17. var (
  18.     // For this example, we're using just a simple logger implementation,
  19.    // You probably want to ship your own implementation of `watermill.LoggerAdapter`.
  20.    logger = watermill.NewStdLogger(false, false)
  21. )
  23. func main() {
  24.     router, err := message.NewRouter(message.RouterConfig{}, logger)
  25.     if err != nil {
  26.         panic(err)
  27.     }
  29.     // SignalsHandler will gracefully shutdown Router when SIGTERM is received.
  30.    // You can also close the router by just calling `r.Close()`.
  31.    router.AddPlugin(plugin.SignalsHandler)
  33.     router.AddMiddleware(
  34.         // CorrelationID will copy the correlation id from the incoming message's metadata to the produced messages
  35.        middleware.CorrelationID,
  37.         // The handler function is retried if it returns an error.
  38.        // After MaxRetries, the message is Nacked and it's up to the PubSub to resend it.
  39.        middleware.Retry{
  40.             MaxRetries:      3,
  41.             InitialInterval: time.Millisecond * 100,
  42.             Logger:          logger,
  43.         }.Middleware,
  45.         // Recoverer handles panics from handlers.
  46.        // In this case, it passes them as errors to the Retry middleware.
  47.        middleware.Recoverer,
  48.     )
  50.     // For simplicity, we are using the gochannel Pub/Sub here,
  51.    // You can replace it with any Pub/Sub implementation, it will work the same.
  52.    pubSub := gochannel.NewGoChannel(gochannel.Config{}, logger)
  54.     // Producing some incoming messages in background
  55.    go publishMessages(pubSub)
  57.     router.AddHandler(
  58.         "struct_handler",          // handler name, must be unique
  59.        "incoming_messages_topic", // topic from which we will read events
  60.        pubSub,
  61.         "outgoing_messages_topic", // topic to which we will publish events
  62.        pubSub,
  63.         structHandler{}.Handler,
  64.     )
  66.     // just for debug, we are printing all messages received on `incoming_messages_topic`
  67.    router.AddNoPublisherHandler(
  68.         "print_incoming_messages",
  69.         "incoming_messages_topic",
  70.         pubSub,
  71.         printMessages,
  72.     )
  74.     // just for debug, we are printing all events sent to `outgoing_messages_topic`
  75.    router.AddNoPublisherHandler(
  76.         "print_outgoing_messages",
  77.         "outgoing_messages_topic",
  78.         pubSub,
  79.         printMessages,
  80.     )
  82.     // Now that all handlers are registered, we're running the Router.
  83.    // Run is blocking while the router is running.
  84.    ctx := context.Background()
  85.     if err := router.Run(ctx); err != nil {
  86.         panic(err)
  87.     }
  88. }
  90. // ...

Incoming messages

The struct_handler consumes messages from incoming_messages_topic, so we are simulating incoming traffic by calling publishMessages() in the background.Notice that we’ve added the SetCorrelationID middleware. A Correlation ID will be added to all messages produced by the router (it will be stored in metadata).

Full source: github.com/ThreeDotsLabs/watermill/_examples/basic/3-router/main.go

  1. // ...
  2. func publishMessages(publisher message.Publisher) {
  3.     for {
  4.         msg := message.NewMessage(watermill.NewUUID(), []byte("Hello, world!"))
  5.         middleware.SetCorrelationID(watermill.NewUUID(), msg)
  7.         log.Printf("sending message %s, correlation id: %s\n", msg.UUID, middleware.MessageCorrelationID(msg))
  9.         if err := publisher.Publish("incoming_messages_topic", msg); err != nil {
  10.             panic(err)
  11.         }
  13.         time.Sleep(time.Second)
  14.     }
  15. }
  16. // ...

Handlers

You may have noticed that there are two types of handler functions:

  • function func(msg message.Message) ([]message.Message, error)
  • method func (c structHandler) Handler(msg message.Message) ([]message.Message, error)If your handler is a function without any dependencies, it’s fine to use the first one.The second option is useful when your handler requires some dependencies like database handle, a logger, etc.

Full source: github.com/ThreeDotsLabs/watermill/_examples/basic/3-router/main.go

  1. // ...
  2. func printMessages(msg *message.Message) error {
  3.     fmt.Printf(
  4.         "\n> Received message: %s\n> %s\n> metadata: %v\n\n",
  5.         msg.UUID, string(msg.Payload), msg.Metadata,
  6.     )
  7.     return nil
  8. }
  10. type structHandler struct {
  11.     // we can add some dependencies here
  12. }
  14. func (s structHandler) Handler(msg *message.Message) ([]*message.Message, error) {
  15.     log.Println("structHandler received message", msg.UUID)
  17.     msg = message.NewMessage(watermill.NewUUID(), []byte("message produced by structHandler"))
  18.     return message.Messages{msg}, nil
  19. }

Done!

You can run this example by go run main.go.

You’ve just created your first application with Watermill. You can find the full source in /_examples/basic/3-router/main.go.

Logging

To see Watermill’s logs, you have to pass any logger that implements the LoggerAdapter.For experimental development, you can use NewStdLogger.

Testing

Watermill provides a set of test scenariosthat any Pub/Sub implementation can use. Each test suite needs to declare what features it supports and how to construct a new Pub/Sub.These scenarios check both basic usage and more uncommon use cases. Stress tests are also included.

Deployment

Watermill is not a framework. We don’t enforce any type of deployment and it’s totally up to you.

What’s next?

For more detailed documentation check documentation topics.

Examples

Check out the examples that will show you how to start using Watermill.

The recommended entry point is Your first Watermill application.It contains the entire environment in docker-compose.yml, including Golang and Kafka, which you can run with one command.

After that, you can see the Realtime feed example.It uses more middlewares and contains two handlers. There is also a separate application for publishing messages.

For a different subscriber implementation, namely HTTP, refer to the receiving-webhooks example. It is a very simple application that saves webhooks to Kafka.

Full list of examples can be found in the project’s README.

Support

If anything is not clear, feel free to use any of our support channels, we will be glad to help.