cl-rdkafka

2020-12-20

A client library for Apache Kafka based on librdkafka CFFI bindings.

Upstream URL

github.com/SahilKang/cl-rdkafka

Author

Sahil Kang <sahil.kang@asilaycomputing.com>

License

GPLv3
README

cl-rdkafka

CircleCI tag license

A Common Lisp client library for Apache Kafka.

The public API is split between two packages:

  • cl-rdkafka/low-level

    Nicknamed cl-rdkafka/ll, this package provides CFFI bindings for librdkafka.

  • cl-rdkafka

    Nicknamed kf, this package provides a higher-level interface :nail_care: with amenities such as garbage-collection :recycle:, out-of-band error processing :leftwards_arrow_with_hook:, and more!

Documentation for cl-rdkafka/ll can be found in librdkafka/rdkafka.h, and kf is documented under the API section.

Examples

Producer

(ql:quickload '(cl-rdkafka babel))

(let ((producer (make-instance
                 'kf:producer
                 :conf '("bootstrap.servers" "127.0.0.1:9092"
                         "enable.idempotence" "true")
                 :serde #'babel:string-to-octets))
      (messages '(("key-1" "value-1")
                  ("key-2" "value-2"))))
  (loop
     for (k v) in messages
     do (kf:send producer "topic-name" v :key k))

  (kf:flush producer))

Consumer

(ql:quickload '(cl-rdkafka babel))

(let ((consumer (make-instance
                 'kf:consumer
                 :conf '("bootstrap.servers" "127.0.0.1:9092"
                         "group.id" "consumer-group-id"
                         "enable.auto.commit" "false"
                         "auto.offset.reset" "earliest")
                 :serde #'babel:octets-to-string)))
  (kf:subscribe consumer "topic-name")

  (loop
     for message = (kf:poll consumer 2000)
     while message

     for key = (kf:key message)
     for value = (kf:value message)

     collect (list key value)

     do (kf:commit consumer)))

;; => (("key-1" "message-1") ("key-2" "message-2"))

Transactions :sparkles:

Here's an example which atomically:

  1. Consumes a batch of messages from an input topic
  2. Processes the messages by prefixing them with "processed-"
  3. Produces the processed batch to an output topic
(ql:quickload '(cl-rdkafka babel))

(defun get-next-batch (consumer max-batch-size)
  (loop
    with batch = (make-array 0 :adjustable t :fill-pointer 0)

    repeat max-batch-size
    for message = (kf:poll consumer 5000)
    while message
    do (vector-push-extend message batch)

    finally (return batch)))

(defun process-message (message producer output-topic)
  (let ((new-value (format nil "processed-~A" (kf:value message))))
    (kf:send producer output-topic new-value)))

(defun process-batch (consumer producer output-topic)
  (let ((messages (get-next-batch consumer 5)))
    (map nil
         (lambda (message)
           (process-message message producer output-topic))
         messages)
    (kf:send-offsets-to-transaction producer consumer messages 5000)))

(defun rewind-consumer (consumer)
  (let ((committed (kf:committed consumer (kf:assignment consumer) 5000)))
    (flet ((rewind (topic&partition->offset&metadata)
             (let ((topic (caar topic&partition->offset&metadata))
                   (partition (cdar topic&partition->offset&metadata))
                   (offset (cadr topic&partition->offset&metadata)))
               (if (< offset 0)
                   (kf:seek-to-beginning consumer topic partition 5000)
                   (kf:seek consumer topic partition offset 5000)))))
      (map nil #'rewind committed))))

(let ((consumer (make-instance
                 'kf:consumer
                 :conf '("bootstrap.servers" "127.0.0.1:9092"
                         "group.id" "some-group-id"
                         "enable.auto.commit" "false"
                         "auto.offset.reset" "earliest")
                 :serde #'babel:octets-to-string))
      (producer (make-instance
                 'kf:producer
                 :conf '("bootstrap.servers" "127.0.0.1:9092"
                         "transactional.id" "some-transaction-id")
                 :serde #'babel:string-to-octets)))
  (kf:subscribe consumer "some-input-topic")
  (kf:initialize-transactions producer 5000)

  (kf:begin-transaction producer)
  (handler-case
      (progn
        (process-batch consumer producer "some-output-topic")
        (kf:commit-transaction producer 5000))
    (kf:fatal-error (c)
      (error c))
    (condition (c)
      ;; in case of abort, must seek consumer back to its committed offsets
      ;; this is only needed if the consumer object will continue to be used
      ;; after the abort
      (rewind-consumer consumer)
      (kf:abort-transaction producer 5000)
      (error c))))

Contributing and Hacking

PRs and GitHub issues are always welcome :octocat: and feel free to email me with any questions :incoming_envelope:

To run the tests:

$ docker-compose -f ./test/docker-compose.test.yml \
>   up --build --remove-orphans --abort-on-container-exit test

$ docker-compose -f ./test/docker-compose.test.yml down --rmi all
$ docker system prune -fa && docker volume prune -f

To spin up and teardown a dockerized Kafka cluster to hack against:

# start a cluster on 127.0.0.1:9092
$ docker-compose up --build --remove-orphans -d

# tear the cluster down
$ docker-compose down --rmi all

# clean up after yourself
$ docker system prune -fa && docker volume prune -f

API

producer class

A client that produces messages to kafka topics.

make-instance accepts the following keyword args:

  • conf

    A required plist, alist, or hash-table mapping config keys to their respective values; both keys and values should be strings. The provided key-value pairs are passed as-is to librdkafka, so consult the librdkafka config docs for more info.

  • serde

    An optional unary function accepting an object and returning a byte sequence; defaults to #'identity.

  • key-serde

    An optional unary function used to serialize message keys; defaults to serde.

  • value-serde

    An optional unary function used to serialize message values; defaults to serde.

Example:

(let ((producer (make-instance
                 'kf:producer
                 :conf '("bootstrap.servers" "127.0.0.1:9092"
                         "enable.idempotence" "true")
                 :serde #'babel:string-to-octets))
      (messages '(("key-1" "value-1")
                  ("key-2" "value-2"))))
  (loop
     for (k v) in messages
     do (kf:send producer "topic-name" v :key k))

  (kf:flush producer))

send

((producer producer) (topic string) value &key key partition headers timestamp)

Asynchronously send a message and return a message future.

If partition is not specified, one is chosen using the topic's partitioner function.

If specified, headers should be an alist mapping strings to byte-vectors.

timestamp is the number of milliseconds since the UTC epoch. If not specified, one will be generated by this call.

May signal partition-error or condition from producer's serde. A store-function restart will be provided if it's a serde condition.


flush

((producer producer))

Block while in-flight messages are sent to kafka cluster.


initialize-transactions

((producer producer) (timeout-ms integer))

Block for up to timeout-ms milliseconds and initialize transactions for producer.

When transactional.id is configured, this method needs to be called exactly once before any other methods on producer.

This method:

  1. Ensures any transactions initiated by previous producer instances with the same transactional.id are completed:

    • If the previous instance had failed with an in-progress transaction, it will be aborted.

    • If the previous transaction had started committing, but had not yet finished, this method waits for it to finish.

  2. Acquires the internal producer id and epoch to use with all future transactional messages sent by producer. This will be used to fence out any previous instances.

May signal a fatal-error, transaction-error, or retryable-operation-error. A retry-operation restart will be provided if it's a retryable-operation-error.


begin-transaction

((producer producer))

Begin a transaction.

initialize-transactions must have been called exactly once before this method, and only one transaction can be in progress at a time for producer.

The transaction can be committed with commit-transaction or aborted with abort-transaction.

May signal fatal-error or transaction-error.


commit-transaction

((producer producer) (timeout-ms integer))

Block for up to timeout-ms milliseconds and commit the ongoing transaction.

A transaction must have been started by begin-transaction.

This method will flush all enqueued messages before issuing the commit. If any of the messages fails to be sent, an abort-required-error will be signalled.

May signal:

  • retryable-operation-error, in which case a retry-operation and abort restart will be provided.

  • abort-required-error, in which case an abort restart will be provided.

  • transaction-error

  • fatal-error


abort-transaction

((producer producer) (timeout-ms integer))

Block for up to timeout-ms milliseconds and abort the ongoing transaction.

A transaction must have been started by begin-transaction.

This method will purge all enqueued messages before issuing the abort.

May signal a fatal-error, transaction-error, or retryable-operation-error. A retry-operation and continue restart will be provided if it's a retryable-operation-error.


send-offsets-to-transaction

(producer consumer offsets timeout-ms)

Send offsets to consumer group coordinator and mark them as part of the ongoing transaction.

A transaction must have been started by begin-transaction.

This method will block for up to timeout-ms milliseconds.

offsets should be associated with consumer, and will be considered committed only if the ongoing transaction is committed successfully. Each offset should refer to the next message that the consumer poll method should return: the last processed message's offset + 1. Invalid offsets will be ignored.

consumer should have enable.auto.commit set to false and should not commit offsets itself through the commit method.

This method should be called at the end of a consume->transform->produce cycle, before calling commit-transaction.

May signal:

  • retryable-operation-error, in which case a retry-operation and abort restart will be provided.

  • abort-required-error, in which case an abort restart will be provided.

  • transaction-error

  • fatal-error

list specialization

((producer producer) (consumer consumer) (offsets list) (timeout-ms integer))

offsets should be an alist mapping (topic . partition) cons cells to either (offset . metadata) cons cells or lone offset values.

hash-table specialization

((producer producer) (consumer consumer) (offsets hash-table) (timeout-ms integer))

offsets should be a hash-table mapping (topic . partition) cons cells to either (offset . metadata) cons cells or lone offset values.

sequence specialization

((producer producer) (consumer consumer) (offsets sequence) (timeout-ms integer))

offsets should be a sequence of messages processed by consumer.

This method will figure out the correct offsets to send to the consumer group coordinator.


consumer class

A client that consumes messages from kafka topics.

make-instance accepts the following keyword args:

  • conf

    A required plist, alist, or hash-table mapping config keys to their respective values; both keys and values should be strings. The provided key-value pairs are passed as-is to librdkafka, so consult the librdkafka config docs for more info.

  • serde

    An optional unary function accepting a byte vector and returning a deserialized value; defaults to #'identity.

  • key-serde

    An optional unary function used to deserialize message keys; defaults to serde.

  • value-serde

    An optional unary function used to deserialize message values; defaults to serde.

Example:

(let ((consumer (make-instance
                 'kf:consumer
                 :conf '("bootstrap.servers" "127.0.0.1:9092"
                         "group.id" "consumer-group-id"
                         "enable.auto.commit" "false"
                         "auto.offset.reset" "earliest")
                 :serde #'babel:octets-to-string)))
  (kf:subscribe consumer "topic-name")

  (loop
     for message = (kf:poll consumer 2000)
     while message

     for key = (kf:key message)
     for value = (kf:value message)

     collect (list key value)

     do (kf:commit consumer)))

poll

((consumer consumer) (timeout-ms integer))

Block for up to timeout-ms milliseconds and return a message or nil.

May signal partition-error or condition from consumer's serde. A store-function restart will be provided if it's a serde condition.


seek

((consumer consumer) (topic string) (partition integer) (offset integer) (timeout-ms integer))

Block for up to timeout-ms milliseconds and seek consumer to offset.


seek-to-beginning

((consumer consumer) (topic string) (partition integer) (timeout-ms integer))

Block for up to timeout-ms milliseconds and seek consumer to beginning of partition.


seek-to-end

((consumer consumer) (topic string) (partition integer) (timeout-ms integer))

Block for up to timeout-ms milliseconds and seek consumer to end of partition.


subscribe

sequence specialization

((consumer consumer) (topics sequence))

Subscribe consumer to topics.

Any topic prefixed with ^ will be regex-matched with the cluster's topics.

string specialization

((consumer consumer) (topic string))

Subscribe consumer to topic.

If topic starts with ^, then it will be regex-matched with the cluster's topics.


unsubscribe

((consumer consumer))

Unsubscribe consumer from its current topic subscription.


subscription

((consumer consumer))

Return a list of topic names that consumer is subscribed to.


assign

((consumer consumer) (partitions sequence))

Assign partitions to consumer.

partitions should be a sequence of (topic . partition) cons cells.


assignment

((consumer consumer))

Return a (topic . partition) list of partitions assigned to consumer.


commit

((consumer consumer) &key offsets asyncp)

Commit offsets to broker.

If offsets is nil, then the current assignment is committed; otherwise, offsets should be an alist mapping (topic . partition) cons cells to either (offset . metadata) cons cells or lone offset values.

On success, an alist of committed offsets is returned, mapping (topic . partition) to (offset . metadata).

On failure, either an rdkafka-error or partial-error is signalled. The partial-error will have the slots:

  • goodies: Same format as successful return value
  • baddies: An alist mapping (topic . partition) to rdkafka-error

If asyncp is true, then a future will be returned instead.


committed

((consumer consumer) (partitions sequence) (timeout-ms integer))

Block for up to timeout-ms milliseconds and return committed offsets for partitions.

partitions should be a sequence of (topic . partition) cons cells.

On success, an alist of committed offsets is returned, mapping (topic . partition) to (offset . metadata).

On failure, either an rdkafka-error or partial-error is signalled. The partial-error will have the slots:

  • goodies: Same format as successful return value
  • baddies: An alist mapping (topic . partition) to rdkafka-error

pause

((consumer consumer) (partitions sequence))

Pause consumption from partitions.

partitions should be a sequence of (topic . partition) cons cells.

partitions is returned on success.

On failure, either an rdkafka-error or partial-error is signalled. The partial-error will have the slots:

  • goodies: A list of (topic . partition) cons cells
  • baddies: An alist mapping (topic . partition) to rdkafka-error

resume

((consumer consumer) (partitions sequence))

Resume consumption from partitions.

partitions should be a sequence of (topic . partition) cons cells.

partitions is returned on success.

On failure, either an rdkafka-error or partial-error is signalled. The partial-error will have the slots:

  • goodies: A list of (topic . partition) cons cells
  • baddies: An alist mapping (topic . partition) to rdkafka-error

member-id

((consumer consumer))

Return consumer's broker-assigned group member-id.


offsets-for-times

((consumer consumer) (timestamps list) (timeout-ms integer))

Look up the offsets for the given partitions by timestamp.

The returned offset for each partition is the earliest offset whose timestamp is greater than or equal to the given timestamp in timestamps.

timestamps should be an alist mapping (topic . partition) cons cells to timestamp values.

On success, an alist of offsets is returned, mapping (topic . partition) cons cells to offset values.

On failure, either an rdkafka-error or partial-error is signalled. The partial-error will have the slots:

  • goodies: Same format as successful return value
  • baddies: An alist mapping (topic . partition) to rdkafka-error

watermarks

((consumer consumer) (topic string) (partition integer) (timeout-ms integer))

Query broker for low (oldest/beginning) and high (newest/end) offsets.

A (low . high) cons cell is returned.


positions

((consumer consumer) (partitions sequence))

Retrieve current positions (offsets) for partitions.

partitions should be a sequence of (topic . partition) cons cells.

On success, an alist of positions is returned, mapping (topic . partition) to one of either:

  • 1 plus the last consumed message offset
  • nil if there was no previous message.

On failure, either an rdkafka-error or partial-error is signalled. The partial-error will have the slots:

  • goodies: Same format as successful return value
  • baddies: An alist mapping (topic . partition) to rdkafka-error

close

((consumer consumer))

Close consumer after revoking assignment, committing offsets, and leaving group.

consumer will be closed during garbage collection if it's still open; this method is provided if closing needs to occur at a well-defined time.


message class

A kafka message as returned by consumer's poll or producer's send.

make-instance should not be called with this class.

Example:

(let ((message (kf:poll consumer 5000)))
  (kf:key message)
  ;; => "key-1", #(107 101 121 45 49)

  (kf:value message)
  ;; => "Hello", #(72 101 108 108 111)

  (kf:topic message)
  ;; => "foobar"

  (kf:partition message)
  ;; => 0

  (kf:offset message)
  ;; => 0

  (kf:timestamp message)
  ;; => 1577002478269, :CREATE-TIME

  (kf:headers message)
  ;; => '(("one" . #(1 2 3))
  ;;      ("two" . #(4 5 6)))

  )

key

((message message))

Return (values deserialized-key serialized-key) from message.


value

((message message))

Return (values deserialized-value serialized-value) from message.


topic

((message message))

Return the topic message originated from.


partition

((message message))

Return the partition message originated from.


offset

((message message))

Return the offset for message.


timestamp

((message message))

Return (values timestamp timestamp-type) from message.

If timestamp is not available, then nil is returned. Otherwise:

  • timestamp is the number of milliseconds since the UTC epoch
  • timestamp-type is either :create-time or :log-append-time

headers

((message message))

Return headers from message as an alist mapping strings to byte vectors.


future class

A future to hold the result of an async operation.

make-instance should not be called with this class.

Example:

(let ((future (kf:send producer "topic" "message")))
  (kf:donep future) ;; => nil
  (kf:value future) ;; => #<MESSAGE {1005BE9D23}>
  (kf:donep future) ;; => t

  (let ((new-future (kf:then future
                             (lambda (message err)
                               (when err
                                 (error err))
                               (kf:value message)))))
    (kf:value new-future))) ;; => "message"

value

((future future))

Wait until future is done and return its value or signal its condition.


then

((future future) (callback function))

Return a new future that calls callback when current future completes.

callback should be a binary function accepting the positional args:

  1. value: the value that the current future evaluates to, or nil when it signals a condition.
  2. condition: the condition signalled by the current future, or nil when it does not signal a condition.

callback is called in a background thread.


donep

((future future))

Determine if future is done processing.


conditions

The conditions are structured in the following class hierarchy:

  • cl:serious-condition
    • cl:storage-condition
      • allocation-error
    • cl:error
      • kafka-error
        • partial-error
        • rdkafka-error
          • partition-error
          • fatal-error
          • transaction-error
            • retryable-operation-error
            • abort-required-error

kafka-error

Generic condition signalled by cl-rdkafka for expected errors.

Slot readers:

  • description: Hopefully some descriptive description describing the error.

rdkafka-error

Condition signalled for librdkafka errors.

Slot readers:

  • enum: cl-rdkafka/ll:rd-kafka-resp-err enum symbol.
  • description: enum description (inherited)

partition-error

Condition signalled for errors specific to a topic's partition.

Slot readers:

  • topic: Topic name
  • partition: Topic partition
  • enum: cl-rdkafka/ll:rd-kafka-resp-err enum symbol (inherited)
  • description: enum description (inherited)

transaction-error

Condition signalled for errors related to transactions.

Slot readers:

  • enum: cl-rdkafka/ll:rd-kafka-resp-err enum symbol (inherited)
  • description: enum description (inherited)

retryable-operation-error

Condition signalled by retryable operations that fail during transactions.

Slot readers:

  • enum: cl-rdkafka/ll:rd-kafka-resp-err enum symbol (inherited)
  • description: enum description (inherited)

abort-required-error

Condition signalled when a transaction fails and must be aborted.

Slot readers:

  • enum: cl-rdkafka/ll:rd-kafka-resp-err enum symbol (inherited)
  • description: enum description (inherited)

fatal-error

Condition signalled for librdkafka fatal errors.

These conditions indicate that the producer or consumer instance should no longer be used.

  • enum: cl-rdkafka/ll:rd-kafka-resp-err enum symbol (inherited)
  • description: enum description (inherited)

partial-error

Condition signalled for operations that partially failed.

Slot readers:

  • goodies: Successful results
  • baddies: Unsuccessful results
  • description: baddies description (inherited)

allocation-error

Condition signalled when librdkafka functions fail to allocate pointers.

Slot readers:

  • name: Name of the object that failed to be allocated.
  • description: Details about why the allocation may have failed.

Admin API

The admin API is still baking :bread:, so it's not publicly exposed. The admin functionality is accessible if needed (see tests for usage examples), but it will be changing significantly in the near future.

Dependencies (6)

  • 1am
  • babel
  • bordeaux-threads
  • cffi
  • lparallel
  • trivial-garbage

Dependents (0)

    • GitHub
    • Quicklisp