Update sample to use latest version of Python Event Hubs package by YijunXieMS · Pull Request #24 · Azure-Samples/azure-iot-samples-python

YijunXieMS · 2020-05-15T23:30:20Z

Purpose

Provide quick start guide example code for receiving events from the eventhub-compatible endpoint of IoT Hub d2c messages

Does this introduce a breaking change?

[ ] Yes
[x] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Documentation content changes
[x] Other: Uses latest version of the python `azure-eventhub` package that has newer APIs

How to Test

Get the code

git clone https://github.com/Azure-Samples/azure-iot-samples-python.git
cd azure-iot-samples-python
git checkout [branch-name]
cd iot-hub/Quickstarts/read-d2c-messages
pip install -r requirements.txt

Test the code

Add your event hub compatible endpoint information by running Azure CLI, and run the code
Send data to your IotHub via any means you are familiar with in another program

Then run the python files.

What to Check

Verify that the following are valid

Command line should print content of received iot hub d2c messages.

Other Information

ramya-rao-a · 2020-05-15T23:45:32Z

cc @elhorton, @jebrando, @JimacoMS3, @robinsh, @philmea

This is similar to what was done to the Node sample in Azure-Samples/azure-iot-samples-node#39

JimacoMS3 · 2020-05-19T23:52:02Z

+
+# If you have access to the Event Hub-compatible connection string from the Azure portal, then
+# you can skip the Azure CLI commands above, and assign the connection string directly here.
+CONNECTION_STR = f'Endpoint=sb://{EVENTHUB_COMPATIBLE_ENDPOINT}/;SharedAccessKeyName=service;SharedAccessKey={IOTHUB_SAS_KEY};EntityPath={EVENTHUB_COMPATIBLE_PATH}';


You don't need the leading 'sb://' here. It's inlcuded in the EVENTHUB_COMPATIBLE_ENDPOINT. Also, I don't think you need/want the terminating semi-colon. Same things for the sync sample

Sorry for the trailing ';'. I used VS code to create this sample. I realized it didn't save automatically like Pycharm so my last small fixes were not saved and pushed.
Corrected now.

JimacoMS3 · 2020-05-19T23:54:18Z

+        await client.receive_batch(
+            on_event_batch=on_event_batch,
+            on_error=on_error,
+            starting_position="-1",  # "-1" is from the beginning of the partition.


Can we get rid of the starting_position parameter? This spits out a bunch of telemetry that could have happened before you actually ran the SimulatedDevice sample. I think getting rid of the parameter, just starts from the current time -- I think. Same thing for the sync sample.

Removed. So it will only receive new messages.

JimacoMS3 · 2020-05-19T23:54:43Z

+
+# If you have access to the Event Hub-compatible connection string from the Azure portal, then
+# you can skip the Azure CLI commands above, and assign the connection string directly here.
+CONNECTION_STR = f'Endpoint=sb://{EVENTHUB_COMPATIBLE_ENDPOINT}/;SharedAccessKeyName=service;SharedAccessKey={IOTHUB_SAS_KEY};EntityPath={EVENTHUB_COMPATIBLE_PATH}';


See comment for async

JimacoMS3 · 2020-05-19T23:55:11Z

+        client.receive_batch(
+            on_event_batch=on_event_batch,
+            on_error=on_error,
+            starting_position="-1",  # "-1" is from the beginning of the partition.


See comment for async wrt starting_position.

JimacoMS3 · 2020-05-19T23:55:44Z

+# Event Hub-compatible endpoint
+# az iot hub show --query properties.eventHubEndpoints.events.endpoint --name {your IoT Hub name}
+EVENTHUB_COMPATIBLE_ENDPOINT = "{your Event Hubs compatible endpoint}"
+EVENTHUB_COMPATIBLE_ENDPOINT = "iothub-ns-yijun-ioth-3130889-4398262da5.servicebus.windows.net"


Don't forget to yank your hard-coded constants :)

This is embarrassing. I used them to test the script.
Not saved file before git commit in VS code again.
I regenerated the key on portal as well since it's compromised.
Thanks for pointing this out.

Just realized the resource was already deleted on github.

I've done the same thing roughly a million times :)

JimacoMS3 · 2020-05-20T19:19:10Z

doc updates in this PR: https://github.com/MicrosoftDocs/azure-docs-pr/pull/115889

(Note: screenshot needs updating.)

JimacoMS3 · 2020-05-21T19:26:08Z

@YijunXieMS Hi Yijun -- one last request here. Is it possible to have a graceful way to exit these samples (without adding a ton of code) ? Right now, ctrl-c generates exception output. (if that's something that's common across the EH samples, then don't worry about it). The other EH platform samples exit more gracefully.

Thanks,

Jimaco

YijunXieMS · 2020-05-27T04:23:08Z

@YijunXieMS Hi Yijun -- one last request here. Is it possible to have a graceful way to exit these samples (without adding a ton of code) ? Right now, ctrl-c generates exception output. (if that's something that's common across the EH samples, then don't worry about it). The other EH platform samples exit more gracefully.

Thanks,

Jimaco

Hi Jimaco, yes I can add some code for ctrl-c within this week.

JimacoMS3 · 2020-06-02T17:51:23Z

Awesome Yi -- let me know when you have it ready.

JimacoMS3 · 2020-06-12T19:36:15Z

@YijunXieMS Thanks Yijun! Ctrl-c works great. Just one last nit (if you don't have time for this - just let me know). Can please add a line between groups of readings. I think it just makes it more easy to parse. i.e.

This really is a nit. Like I said, if you don't have time - just let me know.

YijunXieMS · 2020-06-16T19:38:16Z

@JimacoMS3 Added that extra line. Let me know if anything else.

JimacoMS3 · 2020-06-16T22:07:29Z

Thanks Yijun!

JimacoMS3 · 2020-06-16T22:27:35Z

#sign-off

JimacoMS3 · 2020-06-16T22:28:13Z

@robinsh - just signed-off please merge

yijxie added 2 commits May 15, 2020 16:11

add read_d2c examples

030cd19

add websocket and proxy description"

a3fb3af

JimacoMS3 reviewed May 19, 2020

View reviewed changes

Update from review feedback

6e5c0f6

Catch KeyboardInterrupt

29afc60

print a extra line

a45f6ee

robinsh merged commit 64467e9 into Azure-Samples:master Jun 16, 2020

Conversation

YijunXieMS commented May 15, 2020

Purpose

Does this introduce a breaking change?

Pull Request Type

How to Test

What to Check

Other Information

Uh oh!

ramya-rao-a commented May 15, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JimacoMS3 commented May 20, 2020

Uh oh!

JimacoMS3 commented May 21, 2020

Uh oh!

YijunXieMS commented May 27, 2020

Uh oh!

JimacoMS3 commented Jun 2, 2020

Uh oh!

JimacoMS3 commented Jun 12, 2020

Uh oh!

YijunXieMS commented Jun 16, 2020

Uh oh!

JimacoMS3 commented Jun 16, 2020

Uh oh!

JimacoMS3 commented Jun 16, 2020

Uh oh!

JimacoMS3 commented Jun 16, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants