Skip to content

[EventHubs] add logging.info to warn the usage of partition key of non-string type #17057

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.

Sign up for GitHub

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

Merged
yunhaoling merged 3 commits into from
Mar 4, 2021
Merged

[EventHubs] add logging.info to warn the usage of partition key of non-string type #17057

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b6db7e
add a logging to warn the usage of partition key of non-string type
yunhaoling Mar 3, 2021
0e3ae84
move the logging info into eventdatabatch to avoid duplicate logging …
yunhaoling Mar 4, 2021
3c4fbcc
remove unused six module
yunhaoling Mar 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,12 @@ def send_batch(self, event_data_batch, **kwargs):
"""
partition_id = kwargs.get("partition_id")
partition_key = kwargs.get("partition_key")

if partition_key and not isinstance(partition_key, str):
_LOGGER.info("WARNING: Please DO NOT pass a partition_key of non-string type to the send_batch method."
Comment thread
yunhaoling marked this conversation as resolved.
Outdated
"The Event Hub service ignores partition_key of non-string type, "
"in which case events will be assigned to all partitions using round-robin.")

if isinstance(event_data_batch, EventDataBatch):
if partition_id or partition_key:
raise TypeError("partition_id and partition_key should be None when sending an EventDataBatch "
Expand Down Expand Up @@ -306,6 +312,11 @@ def create_batch(self, **kwargs):
partition_id = kwargs.get("partition_id", None)
partition_key = kwargs.get("partition_key", None)

if partition_key and not isinstance(partition_key, str):
Comment thread
yunhaoling marked this conversation as resolved.
Outdated
_LOGGER.info("WARNING: Please DO NOT pass a partition_key of non-string type to the create_batch method."
"The Event Hub service ignores partition_key of non-string type, "
"in which case events will be assigned to all partitions using round-robin.")

if max_size_in_bytes and max_size_in_bytes > self._max_message_size_on_link:
raise ValueError(
"Max message size: {} is too large, acceptable max batch size is: {} bytes.".format(
Expand Down
11 changes: 11 additions & 0 deletions sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,12 @@ async def send_batch(
"""
partition_id = kwargs.get("partition_id")
partition_key = kwargs.get("partition_key")

if partition_key and not isinstance(partition_key, str):
_LOGGER.info("WARNING: Please DO NOT pass a partition_key of non-string type to the send_batch method."
"The Event Hub service ignores partition_key of non-string type, "
"in which case events will be assigned to all partitions using round-robin.")

if isinstance(event_data_batch, EventDataBatch):
if partition_id or partition_key:
raise TypeError("partition_id and partition_key should be None when sending an EventDataBatch "
Expand Down Expand Up @@ -337,6 +343,11 @@ async def create_batch(
if not self._max_message_size_on_link:
await self._get_max_mesage_size()

if partition_key and not isinstance(partition_key, str):
_LOGGER.info("WARNING: Please DO NOT pass a partition_key of non-string type to the create_batch method."
"The Event Hub service ignores partition_key of non-string type, "
"in which case events will be assigned to all partitions using round-robin.")

if max_size_in_bytes and max_size_in_bytes > self._max_message_size_on_link:
raise ValueError(
"Max message size: {} is too large, acceptable max batch size is: {} bytes.".format(
Expand Down