Skip to content

Reading Backtraces

Jump to bottom
Evan Huus edited this page Mar 26, 2015 · 9 revisions

Sarama uses a number of goroutines internally, so when golang dumps a stack trace (hopefully not because Sarama itself has crashed) this page provides a quick guide of what is safe to ignore.

Common

  • [select]: github.com/Shopify/sarama.(*client).backgroundMetadataUpdater is the background goroutine that wakes up every so often (controlled by Metadata.RefreshFrequency) and calls RefreshMetadata(). This can usually be ignored.

  • [chan receive]: github.com/Shopify/sarama.(*Broker).responseReceiver indicates a broker connection that is open, but not currently sending or receiving. These can usually be ignored, unless there are more of them than you have brokers.

Producer

  • [chan receive]: github.com/Shopify/sarama.(*asyncProducer).topicDispatcher is the producer's main goroutine waiting for the next message from the user
  • [chan receive]: github.com/Shopify/sarama.(*asyncProducer).partitionDispatcher is a producer goroutine (one per topic being produced to) for partitioning messages
  • [chan receive]: github.com/Shopify/sarama.(*asyncProducer).leaderDispatcher is a producer goroutine (one per partition) for associating messages with the correct broker
  • [select]: github.com/Shopify/sarama.(*asyncProducer).messageAggregator is a producer goroutine (one per broker) for collecting messages and constructing produce requests
  • [chan receive]: github.com/Shopify/sarama.(*asyncProducer).flusher is a producer goroutine (one per broker) for actually sending produce requests to the broker
  • [chan receive]: github.com/Shopify/sarama.(*asyncProducer).retryHandler is a single producer goroutine which only wakes up to handle message retries

Consumer

  • [chan receive]: github.com/Shopify/sarama.(*partitionConsumer).dispatcher is a consumer goroutine (one per partition being consumed) which handles associating partitions with their brokers and is usually quiet
  • [select]: github.com/Shopify/sarama.(*brokerConsumer).subscriptionManager is a consumer goroutine (one per broker) which manages subscriptions for consuming from individual partitions and is usually quiet
  • [chan receive]: github.com/Shopify/sarama.(*brokerConsumer).subscriptionConsumer is a consumer goroutine (one per broker) which actually sends fetch requests and handles the responses
Clone this wiki locally