-
Notifications
You must be signed in to change notification settings - Fork 951
[KIP-932] : Implement Share consumer interface with poll API #2217
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: dev_kip-932_queues-for-kafka
Are you sure you want to change the base?
Changes from all commits
51ec85d
fc5ef4f
e23df2e
88b4a3a
852d090
d59b196
48208f4
1e41691
59db830
9580e6d
6991299
5b4b408
cabc157
1e1fe37
62021da
f32e19c
901697c
5f4bc3b
282d38f
cc940c2
d4d1456
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| #!/usr/bin/env python | ||
| # | ||
| # Copyright 2026 Confluent Inc. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # | ||
|
|
||
| import sys | ||
|
|
||
| # | ||
| # Example KIP-932 ShareConsumer. | ||
| # | ||
| # A share consumer reads from one or more topics like a queue: many consumers | ||
| # in the same share group can read the same partition, and each record is | ||
| # acknowledged implicitly. | ||
| # | ||
| from confluent_kafka import KafkaException, ShareConsumer | ||
|
|
||
|
|
||
| def print_usage_and_exit(program_name): | ||
| sys.stderr.write('Usage: %s <bootstrap-brokers> <group> <topic1> <topic2> ..\n' % program_name) | ||
| sys.exit(1) | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| if len(sys.argv) < 4: | ||
| print_usage_and_exit(sys.argv[0]) | ||
|
|
||
| broker = sys.argv[1] | ||
| group = sys.argv[2] | ||
| topics = sys.argv[3:] | ||
|
|
||
| # ShareConsumer configuration. | ||
| # See https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md | ||
| conf = { | ||
| 'bootstrap.servers': broker, | ||
| 'group.id': group, | ||
| 'auto.offset.reset': 'earliest', | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is no |
||
| } | ||
|
|
||
| sc = ShareConsumer(conf) | ||
| sc.subscribe(topics) | ||
|
|
||
| try: | ||
| while True: | ||
| messages = sc.poll(timeout=1.0) # returns a list (possibly empty) | ||
| for msg in messages: | ||
| # This example is fail-fast on per-message | ||
| # errors — the first error terminates the consumer. For a long-running queue worker, prefer | ||
| # logging msg.error() and `continue` so transient delivery | ||
| # errors don't kill the process. | ||
| if msg.error(): | ||
| raise KafkaException(msg.error()) | ||
|
Comment on lines
+62
to
+63
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We shouldn't throw exception in this case. We should log and move on. These errors are mostly informational. We only fail in FATAL errors. |
||
| sys.stderr.write( | ||
| '%% %s [%d] at offset %d with key %s:\n' | ||
| % (msg.topic(), msg.partition(), msg.offset(), str(msg.key())) | ||
| ) | ||
| print(msg.value()) | ||
| # Implicit ack: the next poll() acknowledges this message. | ||
| # If we crash before the next poll, the broker will | ||
| # redeliver this record to another consumer in the share | ||
| # group after the acquisition lock expires. | ||
| except KeyboardInterrupt: | ||
| sys.stderr.write('%% Aborted by user\n') | ||
| finally: | ||
| sc.close() | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add an example file |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,12 +63,14 @@ class KafkaError: | |
| DELEGATION_TOKEN_REQUEST_NOT_ALLOWED: int | ||
| DUPLICATE_RESOURCE: int | ||
| DUPLICATE_SEQUENCE_NUMBER: int | ||
| DUPLICATE_VOTER: int | ||
|
pranavrth marked this conversation as resolved.
|
||
| ELECTION_NOT_NEEDED: int | ||
| ELIGIBLE_LEADERS_NOT_AVAILABLE: int | ||
| FEATURE_UPDATE_FAILED: int | ||
| FENCED_INSTANCE_ID: int | ||
| FENCED_LEADER_EPOCH: int | ||
| FENCED_MEMBER_EPOCH: int | ||
| FENCED_STATE_EPOCH: int | ||
| FETCH_SESSION_ID_NOT_FOUND: int | ||
| GROUP_AUTHORIZATION_FAILED: int | ||
| GROUP_ID_NOT_FOUND: int | ||
|
|
@@ -89,20 +91,26 @@ class KafkaError: | |
| INVALID_PRODUCER_EPOCH: int | ||
| INVALID_PRODUCER_ID_MAPPING: int | ||
| INVALID_RECORD: int | ||
| INVALID_RECORD_STATE: int | ||
| INVALID_REGISTRATION: int | ||
| INVALID_REGULAR_EXPRESSION: int | ||
| INVALID_REPLICATION_FACTOR: int | ||
| INVALID_REPLICA_ASSIGNMENT: int | ||
| INVALID_REQUEST: int | ||
| INVALID_REQUIRED_ACKS: int | ||
| INVALID_SHARE_SESSION_EPOCH: int | ||
| INVALID_SESSION_TIMEOUT: int | ||
| INVALID_TIMESTAMP: int | ||
| INVALID_TRANSACTION_TIMEOUT: int | ||
| INVALID_TXN_STATE: int | ||
| INVALID_UPDATE_VERSION: int | ||
| INVALID_VOTER_KEY: int | ||
| KAFKA_STORAGE_ERROR: int | ||
| LEADER_NOT_AVAILABLE: int | ||
| LISTENER_NOT_FOUND: int | ||
| LOG_DIR_NOT_FOUND: int | ||
| MEMBER_ID_REQUIRED: int | ||
| MISMATCHED_ENDPOINT_TYPE: int | ||
| MSG_SIZE_TOO_LARGE: int | ||
| NETWORK_EXCEPTION: int | ||
| NON_EMPTY_GROUP: int | ||
|
|
@@ -131,19 +139,26 @@ class KafkaError: | |
| RESOURCE_NOT_FOUND: int | ||
| SASL_AUTHENTICATION_FAILED: int | ||
| SECURITY_DISABLED: int | ||
| SHARE_SESSION_LIMIT_REACHED: int | ||
| SHARE_SESSION_NOT_FOUND: int | ||
| STALE_BROKER_EPOCH: int | ||
| STALE_CTRL_EPOCH: int | ||
| STALE_MEMBER_EPOCH: int | ||
| STREAMS_INVALID_TOPOLOGY: int | ||
| STREAMS_INVALID_TOPOLOGY_EPOCH: int | ||
| STREAMS_TOPOLOGY_FENCED: int | ||
| TELEMETRY_TOO_LARGE: int | ||
| THROTTLING_QUOTA_EXCEEDED: int | ||
| TOPIC_ALREADY_EXISTS: int | ||
| TOPIC_AUTHORIZATION_FAILED: int | ||
| TOPIC_DELETION_DISABLED: int | ||
| TOPIC_EXCEPTION: int | ||
| TRANSACTION_ABORTABLE: int | ||
| TRANSACTIONAL_ID_AUTHORIZATION_FAILED: int | ||
| TRANSACTION_COORDINATOR_FENCED: int | ||
| UNACCEPTABLE_CREDENTIAL: int | ||
| UNKNOWN: int | ||
| UNKNOWN_CONTROLLER_ID: int | ||
| UNKNOWN_LEADER_EPOCH: int | ||
| UNKNOWN_MEMBER_ID: int | ||
| UNKNOWN_PRODUCER_ID: int | ||
|
|
@@ -154,9 +169,11 @@ class KafkaError: | |
| UNSTABLE_OFFSET_COMMIT: int | ||
| UNSUPPORTED_ASSIGNOR: int | ||
| UNSUPPORTED_COMPRESSION_TYPE: int | ||
| UNSUPPORTED_ENDPOINT_TYPE: int | ||
| UNSUPPORTED_FOR_MESSAGE_FORMAT: int | ||
| UNSUPPORTED_SASL_MECHANISM: int | ||
| UNSUPPORTED_VERSION: int | ||
| VOTER_NOT_FOUND: int | ||
| _ALL_BROKERS_DOWN: int | ||
| _APPLICATION: int | ||
| _ASSIGNMENT_LOST: int | ||
|
|
@@ -535,6 +552,22 @@ class Consumer: | |
| def memberid(self) -> str: ... | ||
| def set_sasl_credentials(self, username: str, password: str) -> None: ... | ||
|
|
||
| class ShareConsumer: | ||
| """Share Consumer for queue-like message consumption (KIP-932).""" | ||
| @overload | ||
| def __init__(self, config: Dict[str, Any]) -> None: ... | ||
| @overload | ||
| def __init__(self, config: Dict[str, Any], /, **kwargs: Any) -> None: ... | ||
| @overload | ||
| def __init__(self, **config: Any) -> None: ... | ||
| def subscribe(self, topics: List[str]) -> None: ... | ||
| def unsubscribe(self) -> None: ... | ||
| def subscription(self) -> List[str]: ... | ||
| def poll(self, timeout: float = -1) -> List[Message]: ... | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. it should be |
||
| def close(self) -> None: ... | ||
| def __enter__(self) -> "ShareConsumer": ... | ||
| def __exit__(self, exc_type: Any, exc_value: Any, exc_traceback: Any) -> Optional[bool]: ... | ||
|
|
||
| class _AdminClientImpl: | ||
| def __init__(self, config: Dict[str, Union[str, int, float, bool]]) -> None: ... | ||
| def __enter__(self) -> Self: ... | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.