From da224092c4847cd78d46d371c7b3d9a1d05c6f83 Mon Sep 17 00:00:00 2001 From: swathipil <76007337+swathipil@users.noreply.github.com> Date: Thu, 6 Jun 2024 13:45:26 -0700 Subject: [PATCH 1/4] [EventHub] Update README for enable logging section Adding an enable logging section like in [servicebus](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/servicebus/azure-servicebus/README.md#logging) as it's a common enough scenario to have on the readme. --- sdk/eventhub/azure-eventhub/README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/sdk/eventhub/azure-eventhub/README.md b/sdk/eventhub/azure-eventhub/README.md index 8f9a905c3736..db82658be7ae 100644 --- a/sdk/eventhub/azure-eventhub/README.md +++ b/sdk/eventhub/azure-eventhub/README.md @@ -408,7 +408,29 @@ Refer to [IoT Hub Connection String Sample](https://github.com/Azure/azure-sdk-f ## Troubleshooting -See the `azure-eventhubs` [troubleshooting guide](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventhub/azure-eventhub/TROUBLESHOOTING.md) for details on how to diagnose various failure scenarios. +### Logging + +- Enable `azure.eventhub` logger to collect traces from the library. +- Enable AMQP frame level trace by setting `logging_enable=True` when creating the client. + +```python +import logging +import sys + +handler = logging.StreamHandler(stream=sys.stdout) +logger = logging.getLogger('azure.eventhub') +logger.setLevel(logging.DEBUG) +logger.addHandler(handler) + +... + +from azure.eventhub import EventHubProducerClient, EventHubConsumerClient + +producer = EventHubProducerClient(..., logging_enable=True) +consumer = EventHubConsumerClient(..., logging_enable=True) +``` + +See the `azure-eventhubs` [troubleshooting guide](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventhub/azure-eventhub/TROUBLESHOOTING.md) for details on how to diagnose various other failure scenarios. ## Next steps From 9c82e8d7e06b51fe9dd62b0686ef1e7aeb8ed9bd Mon Sep 17 00:00:00 2001 From: swathipil <76007337+swathipil@users.noreply.github.com> Date: Thu, 6 Jun 2024 13:53:33 -0700 Subject: [PATCH 2/4] typo --- sdk/eventhub/azure-eventhub/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/eventhub/azure-eventhub/README.md b/sdk/eventhub/azure-eventhub/README.md index db82658be7ae..b1aad6ff0d2d 100644 --- a/sdk/eventhub/azure-eventhub/README.md +++ b/sdk/eventhub/azure-eventhub/README.md @@ -430,7 +430,7 @@ producer = EventHubProducerClient(..., logging_enable=True) consumer = EventHubConsumerClient(..., logging_enable=True) ``` -See the `azure-eventhubs` [troubleshooting guide](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventhub/azure-eventhub/TROUBLESHOOTING.md) for details on how to diagnose various other failure scenarios. +See the `azure-eventhub` [troubleshooting guide](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventhub/azure-eventhub/TROUBLESHOOTING.md) for details on how to diagnose various other failure scenarios. ## Next steps From be2c933492236c9d019cc90082c23abb0164ecaf Mon Sep 17 00:00:00 2001 From: swathipil <76007337+swathipil@users.noreply.github.com> Date: Thu, 6 Jun 2024 13:56:58 -0700 Subject: [PATCH 3/4] add in krista's suggestion --- sdk/eventhub/azure-eventhub/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/sdk/eventhub/azure-eventhub/README.md b/sdk/eventhub/azure-eventhub/README.md index b1aad6ff0d2d..71ffe0377c7b 100644 --- a/sdk/eventhub/azure-eventhub/README.md +++ b/sdk/eventhub/azure-eventhub/README.md @@ -408,10 +408,13 @@ Refer to [IoT Hub Connection String Sample](https://github.com/Azure/azure-sdk-f ## Troubleshooting +See the `azure-eventhub` [troubleshooting guide](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventhub/azure-eventhub/TROUBLESHOOTING.md) for details on how to diagnose various failure scenarios. + ### Logging - Enable `azure.eventhub` logger to collect traces from the library. - Enable AMQP frame level trace by setting `logging_enable=True` when creating the client. +- Refer to [this guide](https://learn.microsoft.com/en-us/azure/developer/python/sdk/azure-sdk-logging) on configuring logging for Azure libraries for Python for additional information. ```python import logging @@ -430,8 +433,6 @@ producer = EventHubProducerClient(..., logging_enable=True) consumer = EventHubConsumerClient(..., logging_enable=True) ``` -See the `azure-eventhub` [troubleshooting guide](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/eventhub/azure-eventhub/TROUBLESHOOTING.md) for details on how to diagnose various other failure scenarios. - ## Next steps ### More sample code From eb0ae9a750850130b16d5aa6e077565ce95ba13b Mon Sep 17 00:00:00 2001 From: swathipil <76007337+swathipil@users.noreply.github.com> Date: Thu, 6 Jun 2024 14:41:27 -0700 Subject: [PATCH 4/4] Update README.md --- sdk/eventhub/azure-eventhub/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/eventhub/azure-eventhub/README.md b/sdk/eventhub/azure-eventhub/README.md index 71ffe0377c7b..5f4f3a1cfd44 100644 --- a/sdk/eventhub/azure-eventhub/README.md +++ b/sdk/eventhub/azure-eventhub/README.md @@ -414,7 +414,7 @@ See the `azure-eventhub` [troubleshooting guide](https://github.com/Azure/azure- - Enable `azure.eventhub` logger to collect traces from the library. - Enable AMQP frame level trace by setting `logging_enable=True` when creating the client. -- Refer to [this guide](https://learn.microsoft.com/en-us/azure/developer/python/sdk/azure-sdk-logging) on configuring logging for Azure libraries for Python for additional information. +- Refer to [this guide](https://learn.microsoft.com/azure/developer/python/sdk/azure-sdk-logging) on configuring logging for Azure libraries for Python for additional information. ```python import logging