Broker

Required

clusterName

Name of the cluster to which this broker belongs to

Type: java.lang.String

Default: null

Dynamic: false

Category: Server

Optional

topicFactoryClassName

Factory class-name to create topic with custom workflow

Type: java.lang.String

Default: null

Dynamic: true

Category:

zookeeperSessionExpiredPolicy

There are two policies to apply when broker metadata session expires: session expired happens, “shutdown” or “reconnect”.

With “shutdown”, the broker will be restarted.

Category: Authorization

authorizationEnabled

Enforce authorization

Type: boolean

Default: false

Dynamic: false

Category: Authorization

authorizationProvider

Authorization provider fully qualified class-name

Type: java.lang.String

Default: org.apache.pulsar.broker.authorization.PulsarAuthorizationProvider

Dynamic: false

Category: Authorization

proxyRoles

Role names that are treated as proxy roles.

Specify the tls cipher the internal client will use to negotiate during TLS Handshake (a comma-separated list of ciphers).

Max number of unacknowledged messages allowed per broker.

Once this limit reaches, broker will stop dispatching messages to all shared subscription which has higher number of unack messages until subscriptions start acknowledging messages back and unack count reaches to limit/2. Using a value of 0, is disabling unackedMessage-limit check and broker doesn't block dispatchers

Type: int

Default: 0

Dynamic: false

Category: Policies

maxUnackedMessagesPerConsumer

Max number of unacknowledged messages allowed to receive messages by a consumer on a shared subscription.

Broker will stop sending messages to consumer once, this limit reaches until consumer starts acknowledging messages back and unack count reaches to maxUnackedMessagesPerConsumer/2. Using a value of 0, it is disabling unackedMessage-limit check and consumer can receive messages without any restriction

Type: int

Default: 50000

Dynamic: false

Category: Policies

maxUnackedMessagesPerSubscription

Max number of unacknowledged messages allowed per shared subscription.

isSchemaValidationEnforced

Enforce schema validation on following cases:

if a producer without a schema attempts to produce to a topic with schema, the producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don't support schema. if you enable this setting, it will cause non-java clients failed to produce.

Once this limit reaches, Broker will reject new consumers until the number of connected consumers decrease. Using a value of 0, is disabling maxConsumersPerSubscription-limit check.

Type: int

Default: 0

Dynamic: false

Category: Server

maxConsumersPerTopic

Max number of consumers allowed to connect to topic.

Once this limit reaches, Broker will reject new consumers until the number of connected consumers decrease. Using a value of 0, is disabling maxConsumersPerTopic-limit check.

Type: int

Default: 0

Dynamic: false

Category: Server

maxHttpServerConnections

Maximum number of inbound http connections. (0 to disable limiting)

Type: int

Default: 2048

Dynamic: false

Category: Server

maxMessagePublishBufferSizeInMB

Max memory size for broker handling messages sending from producers.

If the processing message size exceed this value, broker will stop read data from the connection. The processing messages means messages are sends to broker but broker have not send response to client, usually waiting to write to bookies.

It's shared across all the topics running in the same broker.

Use -1 to disable the memory limitation. Default is 1/2 of direct memory.

Type: int

Default: 1998

Dynamic: true

Category: Server

maxMessageSize

Max size of messages.

Type: int

Default: 5242880

Dynamic: false

Category: Server

maxNumPartitionsPerPartitionedTopic

The number of partitions per partitioned topic. If try to create or update partitioned topics by exceeded number of partitions, then fail. Use 0 or negative number to disable the check.

Type: int

Default: 0

Dynamic: true

Category: Server

maxProducersPerTopic

Max number of producers allowed to connect to topic.

Once this limit reaches, Broker will reject new producers until the number of connected producers decrease. Using a value of 0, is disabling maxProducersPerTopic-limit check.

Type: int

Default: 0

Dynamic: false

Category: Server

maxPublishRatePerTopicInBytes

Max Rate(in 1 seconds) of Byte allowed to publish for a topic when topic publish rate limiting enabled. (Disable byte rate limit with value 0)

Type: long

Default: 0

Dynamic: true

Category: Server

The metadata store URL. Examples:

zk:my-zk-1:2181,my-zk-2:2181,my-zk-3:2181
my-zk-1:2181,my-zk-2:2181,my-zk-3:2181 (will default to ZooKeeper when the schema is not specified)
zk:my-zk-1:2181,my-zk-2:2181,my-zk-3:2181/my-chroot-path (to add a ZK chroot path)

1. Mark `-partition-` as a keyword.

E.g.

Create a non-partitioned topic.
  No corresponding partitioned topic
   - persistent://public/default/local-name (passed)
   - persistent://public/default/local-name-partition-z (rejected by keyword)
   - persistent://public/default/local-name-partition-0 (rejected by keyword)
  Has corresponding partitioned topic, partitions=2 and topic partition name is persistent://public/default/local-name
   - persistent://public/default/local-name-partition-0 (passed, Because it is the partition topic's sub-partition)
   - persistent://public/default/local-name-partition-z (rejected by keyword)
   - persistent://public/default/local-name-partition-4 (rejected, Because it exceeds the number of maximum partitions)
Create a partitioned topic(topic metadata)
   - persistent://public/default/local-name (passed)
   - persistent://public/default/local-name-partition-z (rejected by keyword)
   - persistent://public/default/local-name-partition-0 (rejected by keyword)

bookkeeperClientEnforceMinNumRacksPerWriteQuorum

Enforces rack-aware bookie selection policy to pick bookies from ‘bookkeeperClientMinNumRacksPerWriteQuorum’ racks for a writeQuorum.

If BK can't find bookie then it would throw BKNotEnoughBookiesException instead of picking random one.

Type: boolean

Default: false

Dynamic: false

Category: Storage (BookKeeper)

bookkeeperClientExposeStatsToPrometheus

whether expose managed ledger client stats to prometheus

Type: boolean

Default: false

Dynamic: false

Category: Storage (BookKeeper)

bookkeeperClientGetBookieInfoIntervalSeconds

Set the interval to periodically check bookie info

Type: int

Default: 86400

Dynamic: false

Category: Storage (BookKeeper)

bookkeeperClientGetBookieInfoRetryIntervalSeconds

Set the interval to retry a failed bookie info lookup

Type: int

Default: 60

Dynamic: false

Category: Storage (BookKeeper)

bookkeeperClientHealthCheckEnabled

Enable bookies health check.

Bookies that have more than the configured number of failure within the interval will be quarantined for some time. During this period, new ledgers won't be created on these bookies

Type: boolean

Default: true

Dynamic: false

Category: Storage (BookKeeper)

bookkeeperClientHealthCheckErrorThresholdPerInterval

Bookies health check error threshold per check interval

Type: long

Default: 5

Dynamic: false

Category: Storage (BookKeeper)

Number of BookKeeper client worker threads. Default is Runtime.getRuntime().availableProcessors()

Type: int

Default: 4

Dynamic: false

Category: Storage (BookKeeper)

Skip reading non-recoverable/unreadable data-ledger under managed-ledger's list.

It helps when data-ledgers gets corrupted at bookkeeper and managed-cursor is stuck at that ledger.

Type: boolean

Default: false

Dynamic: true

Category: Storage (Managed Ledger)

Dynamic: false

Category: Storage (Managed Ledger)

managedLedgerMaxEntriesPerLedger

Max number of entries to append to a ledger before triggering a rollover.

A ledger rollover is triggered after the min rollover time has passed and one of the following conditions is true: the max rollover time has been reached, the max entries have been written to the ledger, or the max ledger size has been written to the ledger

Type: int

Default: 50000

Dynamic: false

Category: Storage (Managed Ledger)

managedLedgerMaxLedgerRolloverTimeMinutes

Maximum time before forcing a ledger rollover for a topic

Type: int

Default: 240

Dynamic: false

Category: Storage (Managed Ledger)

managedLedgerMaxReadsInFlightSizeInMB

Maximum buffer size for bytes read from storage. This is the memory retained by data read from storage (or cache) until it has been delivered to the Consumer Netty channel. Use O to disable

Type: long

Default: 0

Dynamic: false

Category: Storage (Managed Ledger)

Category: TLS

tlsEnabled

Enable TLS

Type: boolean

Default: false

Dynamic: false

Category: TLS

tlsHostnameVerificationEnabled

Whether the hostname is validated when the broker creates a TLS connection with other brokers

Type: boolean

Default: false

Dynamic: false

Category: TLS

tlsKeyFilePath

Path for the TLS private key file

Type: java.lang.String

Default: null

Dynamic: false

Category: TLS

tlsProtocols

Specify the tls protocols the broker will use to negotiate during TLS Handshake.

Example:- [TLSv1.3, TLSv1.2]

Type: java.util.Set

Default: []

Dynamic: false

Category: TLS

tlsRequireTrustedClientCertOnConnect

Specify whether Client certificates are required for TLS Reject. the Connection if the Client Certificate is not trusted

Type: boolean

Default: false

Dynamic: false

Category: TLS

managedLedgerMaxUnackedRangesToPersistInZooKeeper

Max number of acknowledgment holes that can be stored in Zookeeper.

If number of unack message range is higher than this limit then broker will persist unacked ranges into bookkeeper to avoid additional data overhead into zookeeper. @deprecated - use managedLedgerMaxUnackedRangesToPersistInMetadataStore.

Type: int

Default: -1

Dynamic: false

Category: Storage (Managed Ledger)