ClusterMetadata

class kafka.cluster.ClusterMetadata(**configs)

A class to manage kafka cluster metadata.

This class does not perform any IO. It simply updates internal state given API responses (MetadataResponse, GroupCoordinatorResponse).

Keyword Arguments:  

• retry_backoff_ms (int) – Milliseconds to backoff when retrying on errors. Default: 100.
• metadata_max_age_ms (int) – The period of time in milliseconds after which we force a refresh of metadata even if we haven’t seen any partition leadership changes to proactively discover any new brokers or partitions. Default: 300000

add_group_coordinator(group, response)

Update with metadata for a group coordinator

Parameters:

• group (str) – name of group from GroupCoordinatorRequest
• response (GroupCoordinatorResponse) – broker response

Returns:

True if metadata is updated, False on error

Return type:

bool

add_listener(listener)

Add a callback function to be called on each metadata update

available_partitions_for_topic(topic)

Return set of partitions with known leaders

Parameters:topic (str) – topic to check for partitions Returns:{partition (int), …} Return type:set

broker_metadata(broker_id)

Get BrokerMetadata

Parameters:broker_id (int) – node_id for a broker to check Returns:BrokerMetadata or None if not found

brokers()

Get all BrokerMetadata

Returns:{BrokerMetadata, …} Return type:set

coordinator_for_group(group)

Return node_id of group coordinator.

Parameters:group (str) – name of consumer group Returns:node_id for group coordinator Return type:int

failed_update(exception)

Update cluster state given a failed MetadataRequest.

leader_for_partition(partition)

Return node_id of leader, -1 unavailable, None if unknown.

partitions_for_broker(broker_id)

Return TopicPartitions for which the broker is a leader.

Parameters:broker_id (int) – node id for a broker Returns:{TopicPartition, …} Return type:set

partitions_for_topic(topic)

Return set of all partitions for topic (whether available or not)

Parameters:topic (str) – topic to check for partitions Returns:{partition (int), …} Return type:set

refresh_backoff()

Return milliseconds to wait before attempting to retry after failure

remove_listener(listener)

Remove a previously added listener callback

request_update()

Flags metadata for update, return Future()

Actual update must be handled separately. This method will only change the reported ttl()

Returns:kafka.future.Future (value will be the cluster object after update)

topics(exclude_internal_topics=True)

Get set of known topics.

Parameters:exclude_internal_topics (bool) – Whether records from internal topics (such as offsets) should be exposed to the consumer. If set to True the only way to receive records from an internal topic is subscribing to it. Default True Returns:{topic (str), …} Return type:set

ttl()

Milliseconds until metadata should be refreshed

update_metadata(metadata)

Update cluster state given a MetadataResponse.

Parameters:metadata (MetadataResponse) – broker response to a metadata request

Returns: None

with_partitions(partitions_to_add)

Returns a copy of cluster metadata with partitions added