Nuxeo Server


Updated: December 18, 2017 Page Information Edit on GitHub

Kafka configuration and integration with Nuxeo.

Kafka Setup

Nuxeo Stream (introduced in Nuxeo 9.3) requires Kafka 1.0.x.

In addition to a Kafka broker access Nuxeo Stream will also require a Zookeeper access.

Kafka broker need to be tuned a bit:

Kafka broker options default recommended Description
offsets.retention.minutes 1440 20160 The default offset retention is only 1 day, without activity for this amount of time the current consumer offset position is lost and all messages will be reprocessed. To prevent this we recommend to use a value 2 times bigger as log.retention.hours, so by default 14 days or 20160. See KAFKA-3806 for more information.
log.retention.hours 168 The default log retention is 7 days. If you change this make sure you update offset.retention.minutes.
auto.create.topics.enable true This is not a requirement for Log, because topic are created from Zookeeper.

Kafka Configuration

Access, consumer and producer properties are registered using the Nuxeo KafkaConfigService extension point:

<?xml version="1.0"?>
<component name="my.project.kafka.contrib">
  <extension target="" point="kafkaConfig">
    <kafkaConfig name="default" zkServers="localhost:2181" topicPrefix="nuxeo-">
        <property name="bootstrap.servers">localhost:9092</property>
        <property name="bootstrap.servers">localhost:9092</property>
        <property name="">65000</property>
        <property name="">60000</property>
        <property name="">20000</property>
        <property name="">1000</property>
        <property name="max.poll.records">50</property>

Here are some important properties:

Consumer options default Description
bootstrap.servers localhost:9092 A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. false The module manages the offset commit this is always set to false.
auto.offset.reset earliest This option is always set to earliest 30000 Requests timeout between client and Kafka brokers. 300000 Consumers that don't call poll during this delay are removed from the group. 10000 Consumers that don't send heartbeat during this delay are removed from the group. 3000 Interval between heartbeats.
max.poll.records 500 Can be adjusted to make sure the poll interval is respected. 3000 Delay for the initial consumer rebalance.
subscribe.disable false Not a Kafka option, used by the module to disable the dynamic assignment, when this option is true LogManager will only support static partition assignment.
Producer options default Description
acks 1 The number of acknowledgments the producer requires the leader to have received before considering a request complete.
compression.type none Valid values are none, gzip, snappy, or lz4. Compression is of full batches of data, so the efficacy of batching will also impact the compression ratio (more batching means better compression).
default.replication.factor 1 Not a Kafka option, used by the module to set the topic replication factor when creating new topic.

Please refer to Kafka document about the consumer and producer options for more information.

3 months ago Benoit Delbosc fix EP target service name for kafkaConfig
4 months ago manonlumeau NXDOC-1369: Add new pages Nuxeo Stream and Kafka, update nuxeo.conf other references in audit and workmanager
4 months ago manonlumeau review format
History: Created by manonlumeau

We'd love to hear your thoughts!

All fields required