config.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581
  1. package sarama
  2. import (
  3. "compress/gzip"
  4. "crypto/tls"
  5. "fmt"
  6. "io/ioutil"
  7. "net"
  8. "regexp"
  9. "time"
  10. "github.com/rcrowley/go-metrics"
  11. )
  12. const defaultClientID = "sarama"
  13. var validID = regexp.MustCompile(`\A[A-Za-z0-9._-]+\z`)
  14. // Config is used to pass multiple configuration options to Sarama's constructors.
  15. type Config struct {
  16. // Admin is the namespace for ClusterAdmin properties used by the administrative Kafka client.
  17. Admin struct {
  18. // The maximum duration the administrative Kafka client will wait for ClusterAdmin operations,
  19. // including topics, brokers, configurations and ACLs (defaults to 3 seconds).
  20. Timeout time.Duration
  21. }
  22. // Net is the namespace for network-level properties used by the Broker, and
  23. // shared by the Client/Producer/Consumer.
  24. Net struct {
  25. // How many outstanding requests a connection is allowed to have before
  26. // sending on it blocks (default 5).
  27. MaxOpenRequests int
  28. // All three of the below configurations are similar to the
  29. // `socket.timeout.ms` setting in JVM kafka. All of them default
  30. // to 30 seconds.
  31. DialTimeout time.Duration // How long to wait for the initial connection.
  32. ReadTimeout time.Duration // How long to wait for a response.
  33. WriteTimeout time.Duration // How long to wait for a transmit.
  34. TLS struct {
  35. // Whether or not to use TLS when connecting to the broker
  36. // (defaults to false).
  37. Enable bool
  38. // The TLS configuration to use for secure connections if
  39. // enabled (defaults to nil).
  40. Config *tls.Config
  41. }
  42. // SASL based authentication with broker. While there are multiple SASL authentication methods
  43. // the current implementation is limited to plaintext (SASL/PLAIN) authentication
  44. SASL struct {
  45. // Whether or not to use SASL authentication when connecting to the broker
  46. // (defaults to false).
  47. Enable bool
  48. // Whether or not to send the Kafka SASL handshake first if enabled
  49. // (defaults to true). You should only set this to false if you're using
  50. // a non-Kafka SASL proxy.
  51. Handshake bool
  52. //username and password for SASL/PLAIN authentication
  53. User string
  54. Password string
  55. }
  56. // KeepAlive specifies the keep-alive period for an active network connection.
  57. // If zero, keep-alives are disabled. (default is 0: disabled).
  58. KeepAlive time.Duration
  59. // LocalAddr is the local address to use when dialing an
  60. // address. The address must be of a compatible type for the
  61. // network being dialed.
  62. // If nil, a local address is automatically chosen.
  63. LocalAddr net.Addr
  64. }
  65. // Metadata is the namespace for metadata management properties used by the
  66. // Client, and shared by the Producer/Consumer.
  67. Metadata struct {
  68. Retry struct {
  69. // The total number of times to retry a metadata request when the
  70. // cluster is in the middle of a leader election (default 3).
  71. Max int
  72. // How long to wait for leader election to occur before retrying
  73. // (default 250ms). Similar to the JVM's `retry.backoff.ms`.
  74. Backoff time.Duration
  75. }
  76. // How frequently to refresh the cluster metadata in the background.
  77. // Defaults to 10 minutes. Set to 0 to disable. Similar to
  78. // `topic.metadata.refresh.interval.ms` in the JVM version.
  79. RefreshFrequency time.Duration
  80. // Whether to maintain a full set of metadata for all topics, or just
  81. // the minimal set that has been necessary so far. The full set is simpler
  82. // and usually more convenient, but can take up a substantial amount of
  83. // memory if you have many topics and partitions. Defaults to true.
  84. Full bool
  85. }
  86. // Producer is the namespace for configuration related to producing messages,
  87. // used by the Producer.
  88. Producer struct {
  89. // The maximum permitted size of a message (defaults to 1000000). Should be
  90. // set equal to or smaller than the broker's `message.max.bytes`.
  91. MaxMessageBytes int
  92. // The level of acknowledgement reliability needed from the broker (defaults
  93. // to WaitForLocal). Equivalent to the `request.required.acks` setting of the
  94. // JVM producer.
  95. RequiredAcks RequiredAcks
  96. // The maximum duration the broker will wait the receipt of the number of
  97. // RequiredAcks (defaults to 10 seconds). This is only relevant when
  98. // RequiredAcks is set to WaitForAll or a number > 1. Only supports
  99. // millisecond resolution, nanoseconds will be truncated. Equivalent to
  100. // the JVM producer's `request.timeout.ms` setting.
  101. Timeout time.Duration
  102. // The type of compression to use on messages (defaults to no compression).
  103. // Similar to `compression.codec` setting of the JVM producer.
  104. Compression CompressionCodec
  105. // The level of compression to use on messages. The meaning depends
  106. // on the actual compression type used and defaults to default compression
  107. // level for the codec.
  108. CompressionLevel int
  109. // Generates partitioners for choosing the partition to send messages to
  110. // (defaults to hashing the message key). Similar to the `partitioner.class`
  111. // setting for the JVM producer.
  112. Partitioner PartitionerConstructor
  113. // If enabled, the producer will ensure that exactly one copy of each message is
  114. // written.
  115. Idempotent bool
  116. // Return specifies what channels will be populated. If they are set to true,
  117. // you must read from the respective channels to prevent deadlock. If,
  118. // however, this config is used to create a `SyncProducer`, both must be set
  119. // to true and you shall not read from the channels since the producer does
  120. // this internally.
  121. Return struct {
  122. // If enabled, successfully delivered messages will be returned on the
  123. // Successes channel (default disabled).
  124. Successes bool
  125. // If enabled, messages that failed to deliver will be returned on the
  126. // Errors channel, including error (default enabled).
  127. Errors bool
  128. }
  129. // The following config options control how often messages are batched up and
  130. // sent to the broker. By default, messages are sent as fast as possible, and
  131. // all messages received while the current batch is in-flight are placed
  132. // into the subsequent batch.
  133. Flush struct {
  134. // The best-effort number of bytes needed to trigger a flush. Use the
  135. // global sarama.MaxRequestSize to set a hard upper limit.
  136. Bytes int
  137. // The best-effort number of messages needed to trigger a flush. Use
  138. // `MaxMessages` to set a hard upper limit.
  139. Messages int
  140. // The best-effort frequency of flushes. Equivalent to
  141. // `queue.buffering.max.ms` setting of JVM producer.
  142. Frequency time.Duration
  143. // The maximum number of messages the producer will send in a single
  144. // broker request. Defaults to 0 for unlimited. Similar to
  145. // `queue.buffering.max.messages` in the JVM producer.
  146. MaxMessages int
  147. }
  148. Retry struct {
  149. // The total number of times to retry sending a message (default 3).
  150. // Similar to the `message.send.max.retries` setting of the JVM producer.
  151. Max int
  152. // How long to wait for the cluster to settle between retries
  153. // (default 100ms). Similar to the `retry.backoff.ms` setting of the
  154. // JVM producer.
  155. Backoff time.Duration
  156. }
  157. }
  158. // Consumer is the namespace for configuration related to consuming messages,
  159. // used by the Consumer.
  160. Consumer struct {
  161. // Group is the namespace for configuring consumer group.
  162. Group struct {
  163. Session struct {
  164. // The timeout used to detect consumer failures when using Kafka's group management facility.
  165. // The consumer sends periodic heartbeats to indicate its liveness to the broker.
  166. // If no heartbeats are received by the broker before the expiration of this session timeout,
  167. // then the broker will remove this consumer from the group and initiate a rebalance.
  168. // Note that the value must be in the allowable range as configured in the broker configuration
  169. // by `group.min.session.timeout.ms` and `group.max.session.timeout.ms` (default 10s)
  170. Timeout time.Duration
  171. }
  172. Heartbeat struct {
  173. // The expected time between heartbeats to the consumer coordinator when using Kafka's group
  174. // management facilities. Heartbeats are used to ensure that the consumer's session stays active and
  175. // to facilitate rebalancing when new consumers join or leave the group.
  176. // The value must be set lower than Consumer.Group.Session.Timeout, but typically should be set no
  177. // higher than 1/3 of that value.
  178. // It can be adjusted even lower to control the expected time for normal rebalances (default 3s)
  179. Interval time.Duration
  180. }
  181. Rebalance struct {
  182. // Strategy for allocating topic partitions to members (default BalanceStrategyRange)
  183. Strategy BalanceStrategy
  184. // The maximum allowed time for each worker to join the group once a rebalance has begun.
  185. // This is basically a limit on the amount of time needed for all tasks to flush any pending
  186. // data and commit offsets. If the timeout is exceeded, then the worker will be removed from
  187. // the group, which will cause offset commit failures (default 60s).
  188. Timeout time.Duration
  189. Retry struct {
  190. // When a new consumer joins a consumer group the set of consumers attempt to "rebalance"
  191. // the load to assign partitions to each consumer. If the set of consumers changes while
  192. // this assignment is taking place the rebalance will fail and retry. This setting controls
  193. // the maximum number of attempts before giving up (default 4).
  194. Max int
  195. // Backoff time between retries during rebalance (default 2s)
  196. Backoff time.Duration
  197. }
  198. }
  199. Member struct {
  200. // Custom metadata to include when joining the group. The user data for all joined members
  201. // can be retrieved by sending a DescribeGroupRequest to the broker that is the
  202. // coordinator for the group.
  203. UserData []byte
  204. }
  205. }
  206. Retry struct {
  207. // How long to wait after a failing to read from a partition before
  208. // trying again (default 2s).
  209. Backoff time.Duration
  210. }
  211. // Fetch is the namespace for controlling how many bytes are retrieved by any
  212. // given request.
  213. Fetch struct {
  214. // The minimum number of message bytes to fetch in a request - the broker
  215. // will wait until at least this many are available. The default is 1,
  216. // as 0 causes the consumer to spin when no messages are available.
  217. // Equivalent to the JVM's `fetch.min.bytes`.
  218. Min int32
  219. // The default number of message bytes to fetch from the broker in each
  220. // request (default 1MB). This should be larger than the majority of
  221. // your messages, or else the consumer will spend a lot of time
  222. // negotiating sizes and not actually consuming. Similar to the JVM's
  223. // `fetch.message.max.bytes`.
  224. Default int32
  225. // The maximum number of message bytes to fetch from the broker in a
  226. // single request. Messages larger than this will return
  227. // ErrMessageTooLarge and will not be consumable, so you must be sure
  228. // this is at least as large as your largest message. Defaults to 0
  229. // (no limit). Similar to the JVM's `fetch.message.max.bytes`. The
  230. // global `sarama.MaxResponseSize` still applies.
  231. Max int32
  232. }
  233. // The maximum amount of time the broker will wait for Consumer.Fetch.Min
  234. // bytes to become available before it returns fewer than that anyways. The
  235. // default is 250ms, since 0 causes the consumer to spin when no events are
  236. // available. 100-500ms is a reasonable range for most cases. Kafka only
  237. // supports precision up to milliseconds; nanoseconds will be truncated.
  238. // Equivalent to the JVM's `fetch.wait.max.ms`.
  239. MaxWaitTime time.Duration
  240. // The maximum amount of time the consumer expects a message takes to
  241. // process for the user. If writing to the Messages channel takes longer
  242. // than this, that partition will stop fetching more messages until it
  243. // can proceed again.
  244. // Note that, since the Messages channel is buffered, the actual grace time is
  245. // (MaxProcessingTime * ChanneBufferSize). Defaults to 100ms.
  246. // If a message is not written to the Messages channel between two ticks
  247. // of the expiryTicker then a timeout is detected.
  248. // Using a ticker instead of a timer to detect timeouts should typically
  249. // result in many fewer calls to Timer functions which may result in a
  250. // significant performance improvement if many messages are being sent
  251. // and timeouts are infrequent.
  252. // The disadvantage of using a ticker instead of a timer is that
  253. // timeouts will be less accurate. That is, the effective timeout could
  254. // be between `MaxProcessingTime` and `2 * MaxProcessingTime`. For
  255. // example, if `MaxProcessingTime` is 100ms then a delay of 180ms
  256. // between two messages being sent may not be recognized as a timeout.
  257. MaxProcessingTime time.Duration
  258. // Return specifies what channels will be populated. If they are set to true,
  259. // you must read from them to prevent deadlock.
  260. Return struct {
  261. // If enabled, any errors that occurred while consuming are returned on
  262. // the Errors channel (default disabled).
  263. Errors bool
  264. }
  265. // Offsets specifies configuration for how and when to commit consumed
  266. // offsets. This currently requires the manual use of an OffsetManager
  267. // but will eventually be automated.
  268. Offsets struct {
  269. // How frequently to commit updated offsets. Defaults to 1s.
  270. CommitInterval time.Duration
  271. // The initial offset to use if no offset was previously committed.
  272. // Should be OffsetNewest or OffsetOldest. Defaults to OffsetNewest.
  273. Initial int64
  274. // The retention duration for committed offsets. If zero, disabled
  275. // (in which case the `offsets.retention.minutes` option on the
  276. // broker will be used). Kafka only supports precision up to
  277. // milliseconds; nanoseconds will be truncated. Requires Kafka
  278. // broker version 0.9.0 or later.
  279. // (default is 0: disabled).
  280. Retention time.Duration
  281. Retry struct {
  282. // The total number of times to retry failing commit
  283. // requests during OffsetManager shutdown (default 3).
  284. Max int
  285. }
  286. }
  287. }
  288. // A user-provided string sent with every request to the brokers for logging,
  289. // debugging, and auditing purposes. Defaults to "sarama", but you should
  290. // probably set it to something specific to your application.
  291. ClientID string
  292. // The number of events to buffer in internal and external channels. This
  293. // permits the producer and consumer to continue processing some messages
  294. // in the background while user code is working, greatly improving throughput.
  295. // Defaults to 256.
  296. ChannelBufferSize int
  297. // The version of Kafka that Sarama will assume it is running against.
  298. // Defaults to the oldest supported stable version. Since Kafka provides
  299. // backwards-compatibility, setting it to a version older than you have
  300. // will not break anything, although it may prevent you from using the
  301. // latest features. Setting it to a version greater than you are actually
  302. // running may lead to random breakage.
  303. Version KafkaVersion
  304. // The registry to define metrics into.
  305. // Defaults to a local registry.
  306. // If you want to disable metrics gathering, set "metrics.UseNilMetrics" to "true"
  307. // prior to starting Sarama.
  308. // See Examples on how to use the metrics registry
  309. MetricRegistry metrics.Registry
  310. }
  311. // NewConfig returns a new configuration instance with sane defaults.
  312. func NewConfig() *Config {
  313. c := &Config{}
  314. c.Admin.Timeout = 3 * time.Second
  315. c.Net.MaxOpenRequests = 5
  316. c.Net.DialTimeout = 30 * time.Second
  317. c.Net.ReadTimeout = 30 * time.Second
  318. c.Net.WriteTimeout = 30 * time.Second
  319. c.Net.SASL.Handshake = true
  320. c.Metadata.Retry.Max = 3
  321. c.Metadata.Retry.Backoff = 250 * time.Millisecond
  322. c.Metadata.RefreshFrequency = 10 * time.Minute
  323. c.Metadata.Full = true
  324. c.Producer.MaxMessageBytes = 1000000
  325. c.Producer.RequiredAcks = WaitForLocal
  326. c.Producer.Timeout = 10 * time.Second
  327. c.Producer.Partitioner = NewHashPartitioner
  328. c.Producer.Retry.Max = 3
  329. c.Producer.Retry.Backoff = 100 * time.Millisecond
  330. c.Producer.Return.Errors = true
  331. c.Producer.CompressionLevel = CompressionLevelDefault
  332. c.Consumer.Fetch.Min = 1
  333. c.Consumer.Fetch.Default = 1024 * 1024
  334. c.Consumer.Retry.Backoff = 2 * time.Second
  335. c.Consumer.MaxWaitTime = 250 * time.Millisecond
  336. c.Consumer.MaxProcessingTime = 100 * time.Millisecond
  337. c.Consumer.Return.Errors = false
  338. c.Consumer.Offsets.CommitInterval = 1 * time.Second
  339. c.Consumer.Offsets.Initial = OffsetNewest
  340. c.Consumer.Offsets.Retry.Max = 3
  341. c.Consumer.Group.Session.Timeout = 10 * time.Second
  342. c.Consumer.Group.Heartbeat.Interval = 3 * time.Second
  343. c.Consumer.Group.Rebalance.Strategy = BalanceStrategyRange
  344. c.Consumer.Group.Rebalance.Timeout = 60 * time.Second
  345. c.Consumer.Group.Rebalance.Retry.Max = 4
  346. c.Consumer.Group.Rebalance.Retry.Backoff = 2 * time.Second
  347. c.ClientID = defaultClientID
  348. c.ChannelBufferSize = 256
  349. c.Version = MinVersion
  350. c.MetricRegistry = metrics.NewRegistry()
  351. return c
  352. }
  353. // Validate checks a Config instance. It will return a
  354. // ConfigurationError if the specified values don't make sense.
  355. func (c *Config) Validate() error {
  356. // some configuration values should be warned on but not fail completely, do those first
  357. if c.Net.TLS.Enable == false && c.Net.TLS.Config != nil {
  358. Logger.Println("Net.TLS is disabled but a non-nil configuration was provided.")
  359. }
  360. if c.Net.SASL.Enable == false {
  361. if c.Net.SASL.User != "" {
  362. Logger.Println("Net.SASL is disabled but a non-empty username was provided.")
  363. }
  364. if c.Net.SASL.Password != "" {
  365. Logger.Println("Net.SASL is disabled but a non-empty password was provided.")
  366. }
  367. }
  368. if c.Producer.RequiredAcks > 1 {
  369. Logger.Println("Producer.RequiredAcks > 1 is deprecated and will raise an exception with kafka >= 0.8.2.0.")
  370. }
  371. if c.Producer.MaxMessageBytes >= int(MaxRequestSize) {
  372. Logger.Println("Producer.MaxMessageBytes must be smaller than MaxRequestSize; it will be ignored.")
  373. }
  374. if c.Producer.Flush.Bytes >= int(MaxRequestSize) {
  375. Logger.Println("Producer.Flush.Bytes must be smaller than MaxRequestSize; it will be ignored.")
  376. }
  377. if (c.Producer.Flush.Bytes > 0 || c.Producer.Flush.Messages > 0) && c.Producer.Flush.Frequency == 0 {
  378. Logger.Println("Producer.Flush: Bytes or Messages are set, but Frequency is not; messages may not get flushed.")
  379. }
  380. if c.Producer.Timeout%time.Millisecond != 0 {
  381. Logger.Println("Producer.Timeout only supports millisecond resolution; nanoseconds will be truncated.")
  382. }
  383. if c.Consumer.MaxWaitTime < 100*time.Millisecond {
  384. Logger.Println("Consumer.MaxWaitTime is very low, which can cause high CPU and network usage. See documentation for details.")
  385. }
  386. if c.Consumer.MaxWaitTime%time.Millisecond != 0 {
  387. Logger.Println("Consumer.MaxWaitTime only supports millisecond precision; nanoseconds will be truncated.")
  388. }
  389. if c.Consumer.Offsets.Retention%time.Millisecond != 0 {
  390. Logger.Println("Consumer.Offsets.Retention only supports millisecond precision; nanoseconds will be truncated.")
  391. }
  392. if c.Consumer.Group.Session.Timeout%time.Millisecond != 0 {
  393. Logger.Println("Consumer.Group.Session.Timeout only supports millisecond precision; nanoseconds will be truncated.")
  394. }
  395. if c.Consumer.Group.Heartbeat.Interval%time.Millisecond != 0 {
  396. Logger.Println("Consumer.Group.Heartbeat.Interval only supports millisecond precision; nanoseconds will be truncated.")
  397. }
  398. if c.Consumer.Group.Rebalance.Timeout%time.Millisecond != 0 {
  399. Logger.Println("Consumer.Group.Rebalance.Timeout only supports millisecond precision; nanoseconds will be truncated.")
  400. }
  401. if c.ClientID == defaultClientID {
  402. Logger.Println("ClientID is the default of 'sarama', you should consider setting it to something application-specific.")
  403. }
  404. // validate Net values
  405. switch {
  406. case c.Net.MaxOpenRequests <= 0:
  407. return ConfigurationError("Net.MaxOpenRequests must be > 0")
  408. case c.Net.DialTimeout <= 0:
  409. return ConfigurationError("Net.DialTimeout must be > 0")
  410. case c.Net.ReadTimeout <= 0:
  411. return ConfigurationError("Net.ReadTimeout must be > 0")
  412. case c.Net.WriteTimeout <= 0:
  413. return ConfigurationError("Net.WriteTimeout must be > 0")
  414. case c.Net.KeepAlive < 0:
  415. return ConfigurationError("Net.KeepAlive must be >= 0")
  416. case c.Net.SASL.Enable == true && c.Net.SASL.User == "":
  417. return ConfigurationError("Net.SASL.User must not be empty when SASL is enabled")
  418. case c.Net.SASL.Enable == true && c.Net.SASL.Password == "":
  419. return ConfigurationError("Net.SASL.Password must not be empty when SASL is enabled")
  420. }
  421. // validate the Admin values
  422. switch {
  423. case c.Admin.Timeout <= 0:
  424. return ConfigurationError("Admin.Timeout must be > 0")
  425. }
  426. // validate the Metadata values
  427. switch {
  428. case c.Metadata.Retry.Max < 0:
  429. return ConfigurationError("Metadata.Retry.Max must be >= 0")
  430. case c.Metadata.Retry.Backoff < 0:
  431. return ConfigurationError("Metadata.Retry.Backoff must be >= 0")
  432. case c.Metadata.RefreshFrequency < 0:
  433. return ConfigurationError("Metadata.RefreshFrequency must be >= 0")
  434. }
  435. // validate the Producer values
  436. switch {
  437. case c.Producer.MaxMessageBytes <= 0:
  438. return ConfigurationError("Producer.MaxMessageBytes must be > 0")
  439. case c.Producer.RequiredAcks < -1:
  440. return ConfigurationError("Producer.RequiredAcks must be >= -1")
  441. case c.Producer.Timeout <= 0:
  442. return ConfigurationError("Producer.Timeout must be > 0")
  443. case c.Producer.Partitioner == nil:
  444. return ConfigurationError("Producer.Partitioner must not be nil")
  445. case c.Producer.Flush.Bytes < 0:
  446. return ConfigurationError("Producer.Flush.Bytes must be >= 0")
  447. case c.Producer.Flush.Messages < 0:
  448. return ConfigurationError("Producer.Flush.Messages must be >= 0")
  449. case c.Producer.Flush.Frequency < 0:
  450. return ConfigurationError("Producer.Flush.Frequency must be >= 0")
  451. case c.Producer.Flush.MaxMessages < 0:
  452. return ConfigurationError("Producer.Flush.MaxMessages must be >= 0")
  453. case c.Producer.Flush.MaxMessages > 0 && c.Producer.Flush.MaxMessages < c.Producer.Flush.Messages:
  454. return ConfigurationError("Producer.Flush.MaxMessages must be >= Producer.Flush.Messages when set")
  455. case c.Producer.Retry.Max < 0:
  456. return ConfigurationError("Producer.Retry.Max must be >= 0")
  457. case c.Producer.Retry.Backoff < 0:
  458. return ConfigurationError("Producer.Retry.Backoff must be >= 0")
  459. }
  460. if c.Producer.Compression == CompressionLZ4 && !c.Version.IsAtLeast(V0_10_0_0) {
  461. return ConfigurationError("lz4 compression requires Version >= V0_10_0_0")
  462. }
  463. if c.Producer.Compression == CompressionGZIP {
  464. if c.Producer.CompressionLevel != CompressionLevelDefault {
  465. if _, err := gzip.NewWriterLevel(ioutil.Discard, c.Producer.CompressionLevel); err != nil {
  466. return ConfigurationError(fmt.Sprintf("gzip compression does not work with level %d: %v", c.Producer.CompressionLevel, err))
  467. }
  468. }
  469. }
  470. if c.Producer.Idempotent {
  471. if !c.Version.IsAtLeast(V0_11_0_0) {
  472. return ConfigurationError("Idempotent producer requires Version >= V0_11_0_0")
  473. }
  474. if c.Producer.Retry.Max == 0 {
  475. return ConfigurationError("Idempotent producer requires Producer.Retry.Max >= 1")
  476. }
  477. if c.Producer.RequiredAcks != WaitForAll {
  478. return ConfigurationError("Idempotent producer requires Producer.RequiredAcks to be WaitForAll")
  479. }
  480. if c.Net.MaxOpenRequests > 1 {
  481. return ConfigurationError("Idempotent producer requires Net.MaxOpenRequests to be 1")
  482. }
  483. }
  484. // validate the Consumer values
  485. switch {
  486. case c.Consumer.Fetch.Min <= 0:
  487. return ConfigurationError("Consumer.Fetch.Min must be > 0")
  488. case c.Consumer.Fetch.Default <= 0:
  489. return ConfigurationError("Consumer.Fetch.Default must be > 0")
  490. case c.Consumer.Fetch.Max < 0:
  491. return ConfigurationError("Consumer.Fetch.Max must be >= 0")
  492. case c.Consumer.MaxWaitTime < 1*time.Millisecond:
  493. return ConfigurationError("Consumer.MaxWaitTime must be >= 1ms")
  494. case c.Consumer.MaxProcessingTime <= 0:
  495. return ConfigurationError("Consumer.MaxProcessingTime must be > 0")
  496. case c.Consumer.Retry.Backoff < 0:
  497. return ConfigurationError("Consumer.Retry.Backoff must be >= 0")
  498. case c.Consumer.Offsets.CommitInterval <= 0:
  499. return ConfigurationError("Consumer.Offsets.CommitInterval must be > 0")
  500. case c.Consumer.Offsets.Initial != OffsetOldest && c.Consumer.Offsets.Initial != OffsetNewest:
  501. return ConfigurationError("Consumer.Offsets.Initial must be OffsetOldest or OffsetNewest")
  502. case c.Consumer.Offsets.Retry.Max < 0:
  503. return ConfigurationError("Consumer.Offsets.Retry.Max must be >= 0")
  504. }
  505. // validate the Consumer Group values
  506. switch {
  507. case c.Consumer.Group.Session.Timeout <= 2*time.Millisecond:
  508. return ConfigurationError("Consumer.Group.Session.Timeout must be >= 2ms")
  509. case c.Consumer.Group.Heartbeat.Interval < 1*time.Millisecond:
  510. return ConfigurationError("Consumer.Group.Heartbeat.Interval must be >= 1ms")
  511. case c.Consumer.Group.Heartbeat.Interval >= c.Consumer.Group.Session.Timeout:
  512. return ConfigurationError("Consumer.Group.Heartbeat.Interval must be < Consumer.Group.Session.Timeout")
  513. case c.Consumer.Group.Rebalance.Strategy == nil:
  514. return ConfigurationError("Consumer.Group.Rebalance.Strategy must not be empty")
  515. case c.Consumer.Group.Rebalance.Timeout <= time.Millisecond:
  516. return ConfigurationError("Consumer.Group.Rebalance.Timeout must be >= 1ms")
  517. case c.Consumer.Group.Rebalance.Retry.Max < 0:
  518. return ConfigurationError("Consumer.Group.Rebalance.Retry.Max must be >= 0")
  519. case c.Consumer.Group.Rebalance.Retry.Backoff < 0:
  520. return ConfigurationError("Consumer.Group.Rebalance.Retry.Backoff must be >= 0")
  521. }
  522. // validate misc shared values
  523. switch {
  524. case c.ChannelBufferSize < 0:
  525. return ConfigurationError("ChannelBufferSize must be >= 0")
  526. case !validID.MatchString(c.ClientID):
  527. return ConfigurationError("ClientID is invalid")
  528. }
  529. return nil
  530. }