Kafka.Producer.ProducerProperties

Module with producer properties types and functions.

Documentation

data ProducerProperties

Properties to create KafkaProducer.

Constructors

ProducerProperties

Fields

• ppKafkaProps :: Map Text Text
• ppTopicProps :: Map Text Text
• ppLogLevel :: Maybe KafkaLogLevel
• ppCallbacks :: [KafkaConf -> IO ()]

Instances

Semigroup ProducerProperties

Defined in Kafka.Producer.ProducerProperties

Methods

(<>) :: ProducerProperties -> ProducerProperties -> ProducerProperties

sconcat :: NonEmpty ProducerProperties -> ProducerProperties

stimes :: Integral b => b -> ProducerProperties -> ProducerProperties

Monoid ProducerProperties

Right biased so we prefer newer properties over older ones.

Defined in Kafka.Producer.ProducerProperties

Methods

mempty :: ProducerProperties

mappend :: ProducerProperties -> ProducerProperties -> ProducerProperties

mconcat :: [ProducerProperties] -> ProducerProperties

brokersList :: [BrokerAddress] -> ProducerProperties

Set the list of brokers to contact to connect to the Kafka cluster.

setCallback :: (KafkaConf -> IO ()) -> ProducerProperties

Set the producer callback.

For examples of use, see:

• errorCallback
• logCallback
• statsCallback

logLevel :: KafkaLogLevel -> ProducerProperties

Sets the logging level. Usually is used with debugOptions to configure which logs are needed.

compression :: KafkaCompressionCodec -> ProducerProperties

Set the compression.codec for the producer.

topicCompression :: KafkaCompressionCodec -> ProducerProperties

Set the compression.codec for the topic.

sendTimeout :: Timeout -> ProducerProperties

Set the message.timeout.ms.

extraProps :: Map Text Text -> ProducerProperties

Any configuration options that are supported by librdkafka. The full list can be found here

suppressDisconnectLogs :: ProducerProperties

Suppresses producer disconnects logs.

It might be useful to turn this off when interacting with brokers with an aggressive connection.max.idle.ms value.

extraTopicProps :: Map Text Text -> ProducerProperties

Any *topic* configuration options that are supported by librdkafka. The full list can be found here

debugOptions :: [KafkaDebug] -> ProducerProperties

Sets debug features for the producer Usually is used with logLevel.

deliveryCallback :: (DeliveryReport -> IO ()) -> KafkaConf -> IO ()

Sets the callback for delivery reports.

/Note: A callback should not be a long-running process as it blocks librdkafka from continuing on the thread that handles the delivery callbacks. For callbacks to individual messsages see 'Kafka.Producer.produceMessage\''./

errorCallback :: HasKafkaConf k => (KafkaError -> String -> IO ()) -> k -> IO ()

Add a callback for errors.

Examples

Basic usage:

'setCallback' ('errorCallback' myErrorCallback)

myErrorCallback :: 'KafkaError' -> String -> IO ()
myErrorCallback kafkaError message = print $ show kafkaError <> "|" <> message

logCallback :: HasKafkaConf k => (KafkaLogLevel -> String -> String -> IO ()) -> k -> IO ()

Add a callback for logs.

Examples

Basic usage:

'setCallback' ('logCallback' myLogCallback)

myLogCallback :: 'KafkaLogLevel' -> String -> String -> IO ()
myLogCallback level facility message = print $ show level <> "|" <> facility <> "|" <> message

statsCallback :: HasKafkaConf k => (String -> IO ()) -> k -> IO ()

Add a callback for stats.

Examples

Basic usage:

'setCallback' ('statsCallback' myStatsCallback)

myStatsCallback :: String -> IO ()
myStatsCallback stats = print $ show stats