Sarama 源码笔记 02:Consumer

[TOC]
consumer 的结构体很简单,里面主要是 partitionConsumer 和 brokerConsumer 两个表:

type consumer struct {
    conf            *Config
    children        map[string]map[int32]*partitionConsumer
    brokerConsumers map[*Broker]*brokerConsumer
    client          Client
    lock            sync.Mutex
}

从上篇笔记中记得 ConsumePartition() 是消费的入口,看代码大约是初始化一个 partitionConsumer,并启动 partitionConsumer 的 dispatcher 和 responseFeeder 两个 goroutine,将 brokerConsumer 的引用交给 partitionConsumer。

注释中提到除非调用 AsyncClose() 或者 Close() 方法,ConsumePartition() 启动的消费过程会永不停止,遇到错误,就不停重试,如果开启 Consumer.Return.Errors,则可以将收到的错误交给 Errors 这个 channel 允许用户处理。

brokerConsumer 是什么呢?当 Consumer 需要从 Broker 订阅多个 Topic 时,会使用单独的一个连接来消费数据,再将数据按 partition 分给不同的 partitionConsumer。Consumer、partitionConsumer、brokerConsumer 乃至 broker 之间大致上似乎是这样的关系:

image.png

整理一下 partitionConsumer 与 brokerConsumer 之间的交互还是有点复杂的,大概是:

  1. partitionConsumer 通过 broker.input 这个 chan 加入 brokerConsumer 的订阅;
  2. 加入订阅后,brokerConsumer 每次 fetchNewMessages 得到一批消息,会发给每个 partitionConsumer 的 feeder chan;
  3. 每个 partitionConsumer 解析 feeder chan 的数据得到 对应的消息列表,同时设置自身的 responseResult,设置 brokers.acks 这个 WaitGoup 执行 Done(),表示处理完毕该批次;
  4. brokerConsumer 等待每个 partitonConsumer 处理完毕该批次,处理所有 partitionConsumer 的 responseResult 后循环 fetchNewMessages;
image.png

这里的交互还是比较 go 特色的,直觉上 java 原版客户端该不会做这么麻烦的交互。

brokerConsumer 的 input chan 有点像服务端的 accept,会有多个 partitionConsumer 动态加入、解除对 brokerConsumer 的订阅。

brokerConsumer 会负责发起 FetchRequest 的主循环,每轮迭代拉取一批消息,发送给每个 partitionConsumer 再转给用户的 messages chan。通过 acks 这个 WaitGroup 来协调每个 partitionConsumer 对这一批次的消息的处理节奏。

如果用户消费 messages chan 有超时,parseResponse 会返回 errTimeout,brokerConsumer 会依据 errTimeout 而暂停 fetchRequest

partitionConsumer

partitonConsumer 会启动 dispatcher 和 responseFeeder 两个 goroutine,其中 dispatcher goroutine 用于跟踪 broker 的变化,偏元信息性质的控制侧,而 responseFeeder 用于跟踪消息的到来,偏数据侧。

func (child *partitionConsumer) dispatcher() {
    for range child.trigger {
        select {
        case <-child.dying:
            close(child.trigger)
        case <-time.After(child.computeBackoff()):
            if child.broker != nil {
                child.consumer.unrefBrokerConsumer(child.broker)
                child.broker = nil
            }

            Logger.Printf("consumer/%s/%d finding new broker\n", child.topic, child.partition)
            if err := child.dispatch(); err != nil {
                child.sendError(err)
                child.trigger <- none{}
            }
        }
    }

    if child.broker != nil {
        child.consumer.unrefBrokerConsumer(child.broker)
    }
    child.consumer.removeChild(child)
    close(child.feeder)
}

// ...

  func (child *partitionConsumer) dispatch() error {
      if err := child.consumer.client.RefreshMetadata(child.topic); err != nil {
          return err
      }

      var leader *Broker
      var err error
      if leader, err = child.consumer.client.Leader(child.topic, child.partition); err != nil {
          return err
      }

      child.broker = child.consumer.refBrokerConsumer(leader)

      child.broker.input <- child

      return nil
  }

dispatcher 这个 goroutine 用于发现 broker 的变化。它会侦听 dispatcher.trigger 这个 channel 的通知,来发现 Partition 的 Leader 变化。而 trigger 这个 channel 的更新来自 brokerConsumer 对象。

最后 child.broker.input child 这一句,相当于使 partitionConsumer 加入 brokerConsumer 的订阅。

不过这里不是很明白 dispatcher 这个 goroutine 里为啥没有对 partitionConsumer 对象上锁。

func (child *partitionConsumer) responseFeeder() {
    var msgs []*ConsumerMessage
    expiryTicker := time.NewTicker(child.conf.Consumer.MaxProcessingTime)
    firstAttempt := true

feederLoop:
    for response := range child.feeder {
        msgs, child.responseResult = child.parseResponse(response)

        if child.responseResult == nil {
            atomic.StoreInt32(&child.retries, 0)
        }

        for i, msg := range msgs {
        messageSelect:
            select {
            case <-child.dying:
                child.broker.acks.Done()
                continue feederLoop
            case child.messages <- msg:
                firstAttempt = true
            case <-expiryTicker.C:
                if !firstAttempt {
                    child.responseResult = errTimedOut
                    child.broker.acks.Done()
                remainingLoop:
                    for _, msg = range msgs[i:] {
                        select {
                        case child.messages <- msg:
                        case <-child.dying:
                            break remainingLoop
                        }
                    }
                    child.broker.input <- child
                    continue feederLoop
                } else {
                    // current message has not been sent, return to select
                    // statement
                    firstAttempt = false
                    goto messageSelect
                }
            }
        }

        child.broker.acks.Done()
    }

    expiryTicker.Stop()
    close(child.messages)
    close(child.errors)
}

child.feed 这个 channel 也是来自 brokerConsumer。大约是处理来自 brokerConsumer 的消息,转发给 messages chan。

值得留意有一个配置项目 child.conf.Consumer.MaxProcessingTime,默认值为 100ms,看注释它的意思是如果朝 messages chan 写入超过 100ms 仍未成功,则停止再向 Broker 发送 fetch 请求。这一流程的实现有一些细节:

  1. 通过 firstAttempt 变量判断是否第一次超时,只有当第二次超时才跑暂停 Broker 发送 fetch 请求的流程
  2. 设置 child.responseResult 为 errTimeout,以通知 brokerConsumer 暂停。
  3. 将当前批次的消息列表消化掉,如果中途 partitionConsumer 退出,则停止消化当前批次的消息;
  4. child.broker.input child,将 partitionConsumer 重新加入 brokerConsumer 的订阅;

brokerConsumer

brokerConsumer 的结构体如下:

type brokerConsumer struct {
      consumer         *consumer
      broker           *Broker
      input            chan *partitionConsumer
      newSubscriptions chan []*partitionConsumer
      subscriptions    map[*partitionConsumer]none
      wait             chan none
      acks             sync.WaitGroup
      refs             int
  }

初始化 brokerConsumer 时会产生两个 goroutine:

bc.subscriptionManager:侦听 input chan,获取加入订阅的 partitionConsumer;
bc.subscriptionConsumer:循环发起 FetchRequest,向 broker 拉取一批消息,协调发给 partitionConsumer;
subscriptionConsumer 相当于 FetchRequest 的主循环流程:

//subscriptionConsumer ensures we will get nil right away if no new subscriptions is available
  func (bc *brokerConsumer) subscriptionConsumer() {
      <-bc.wait // wait for our first piece of work

      for newSubscriptions := range bc.newSubscriptions {
          bc.updateSubscriptions(newSubscriptions)

          if len(bc.subscriptions) == 0 {
              // We're about to be shut down or we're about to receive more subscriptions.
              // Either way, the signal just hasn't propagated to our goroutine yet.
              <-bc.wait
              continue
          }

          response, err := bc.fetchNewMessages()

          if err != nil {
              Logger.Printf("consumer/broker/%d disconnecting due to error processing FetchRequest: %s\n", bc.broker.ID(), err)
              bc.abort(err)
              return
          }

          bc.acks.Add(len(bc.subscriptions))
          for child := range bc.subscriptions {
              child.feeder <- response
          }
          bc.acks.Wait()
          bc.handleResponses()
      }
  }

而 subscriptionManager 用于管理订阅的加入,并通过 bc.newSubscriptions 来通知给 subscriptionConsumer。

// The subscriptionManager constantly accepts new subscriptions on `input` (even when the main subscriptionConsumer
  // goroutine is in the middle of a network request) and batches it up. The main worker goroutine picks
  // up a batch of new subscriptions between every network request by reading from `newSubscriptions`, so we give
  // it nil if no new subscriptions are available. We also write to `wait` only when new subscriptions is available,
  // so the main goroutine can block waiting for work if it has none.
  func (bc *brokerConsumer) subscriptionManager() {
      var buffer []*partitionConsumer

      for {
          if len(buffer) > 0 {
              select {
              case event, ok := <-bc.input:
                  if !ok {
                      goto done
                  }
                  buffer = append(buffer, event)
              case bc.newSubscriptions <- buffer:
                  buffer = nil
              case bc.wait <- none{}:
              }
          } else {
              select {
              case event, ok := <-bc.input:
                  if !ok {
                      goto done
                  }
                  buffer = append(buffer, event)
              case bc.newSubscriptions <- nil:
              }
          }
      }

  done:
      close(bc.wait)
      if len(buffer) > 0 {
          bc.newSubscriptions <- buffer
      }
      close(bc.newSubscriptions)
  }

总结

  1. consumer 与 broker 算是个多对多的关系,如果有多个 partition 位于一个 broker,那么通过单个 brokerConsumer 与之统一交互。
  2. 因此 partitionConsumer 与 brokerConsumer 属于一个订阅的关系,partitonConsumer 关注的点是将自己加入订阅并处理订阅的内容,由 brokerConsumer 驱动 FetchRequest 循环;
  3. brokerConsumer 使用一个 WaitGroup 来协调多个 partitionConsumer 的执行节奏与结果。
  4. 里面这些 goroutine 好像都没怎么上锁,不是很明白会不会有线程安全问题。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,544评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,430评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,764评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,193评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,216评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,182评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,063评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,917评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,329评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,543评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,722评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,425评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,019评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,671评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,825评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,729评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,614评论 2 353

推荐阅读更多精彩内容