messaging

Documentation

Index

• type Client
  • func NewKafkaClient(kc *KafkaConfig, zLogger *zap.Logger, logger bark.Logger, ...) Client
• type ClusterConfig
• type Consumer
• type KafkaConfig
  • func (k *KafkaConfig) Validate()
• type Message
• type Producer
  • func NewKafkaProducer(topic string, producer sarama.SyncProducer, logger bark.Logger) Producer
• type TopicConfig
• type TopicList

Types

type Client

type Client interface {
	NewConsumer(currentCluster, sourceCluster, consumerName string, concurrency int) (Consumer, error)
	NewProducer(sourceCluster string) (Producer, error)
}

Client is the interface used to abstract out interaction with messaging system for replication

func NewKafkaClient

func NewKafkaClient(kc *KafkaConfig, zLogger *zap.Logger, logger bark.Logger, metricScope tally.Scope) Client

NewKafkaClient is used to create an instance of KafkaClient

type ClusterConfig

type ClusterConfig struct {
	Brokers []string `yaml:"brokers"`
}

ClusterConfig describes the configuration for a single Kafka cluster

type Consumer

type Consumer interface {
	// Start starts the consumer
	Start() error
	// Stop stops the consumer
	Stop()
	// Messages return the message channel for this consumer
	Messages() <-chan Message
}

Consumer is the unified interface for both internal and external kafka clients

type KafkaConfig

type KafkaConfig struct {
	Clusters       map[string]ClusterConfig `yaml:"clusters"`
	Topics         map[string]TopicConfig   `yaml:"topics"`
	ClusterToTopic map[string]TopicList     `yaml:"cadence-cluster-topics"`
}

KafkaConfig describes the configuration needed to connect to all kafka clusters

func (*KafkaConfig) Validate

func (k *KafkaConfig) Validate()

Validate will validate config

type Message

type Message interface {
	// Value is a mutable reference to the message's value
	Value() []byte
	// Partition is the ID of the partition from which the message was read.
	Partition() int32
	// Offset is the message's offset.
	Offset() int64
	// Ack marks the message as successfully processed.
	Ack() error
	// Nack marks the message processing as failed and the message will be retried or sent to DLQ.
	Nack() error
}

Message is the unified interface for a Kafka message

type Producer

type Producer interface {
	Publish(msg *replicator.ReplicationTask) error
	PublishBatch(msgs []*replicator.ReplicationTask) error
	Close() error
}

Producer is the interface used to send replication tasks to other clusters through replicator

func NewKafkaProducer

func NewKafkaProducer(topic string, producer sarama.SyncProducer, logger bark.Logger) Producer

NewKafkaProducer is used to create the Kafka based producer implementation

type TopicConfig

type TopicConfig struct {
	Cluster string `yaml:"cluster"`
}

TopicConfig describes the mapping from topic to Kafka cluster

type TopicList

type TopicList struct {
	Topic      string `yaml:"topic"`
	RetryTopic string `yaml:"retry-topic"`
	DLQTopic   string `yaml:"dlq-topic"`
}

TopicList describes the topic names for each cluster