|
| 1 | +# ------------------------------------ |
| 2 | +# Copyright (c) Microsoft Corporation. |
| 3 | +# Licensed under the MIT License. |
| 4 | +# ------------------------------------ |
| 5 | +import pytest |
| 6 | + |
| 7 | +from azure.servicebus import ServiceBusClient, ServiceBusMessage |
| 8 | +from opentelemetry.trace import SpanKind |
| 9 | + |
| 10 | + |
| 11 | +class TestServiceBusTracing: |
| 12 | + def _verify_span_attributes(self, *, span): |
| 13 | + # Ensure all attributes are set and have a value. |
| 14 | + for attr in span.attributes: |
| 15 | + assert span.attributes[attr] is not None and span.attributes[attr] != "" |
| 16 | + |
| 17 | + def _verify_message(self, *, span, dest, server_address): |
| 18 | + assert span.name == "ServiceBus.message" |
| 19 | + assert span.kind == SpanKind.PRODUCER |
| 20 | + self._verify_span_attributes(span=span) |
| 21 | + assert span.attributes["az.namespace"] == "Microsoft.ServiceBus" |
| 22 | + assert span.attributes["messaging.system"] == "servicebus" |
| 23 | + assert span.attributes["messaging.destination.name"] == dest |
| 24 | + assert span.attributes["server.address"] == server_address |
| 25 | + |
| 26 | + def _verify_send(self, *, span, dest, server_address, message_count): |
| 27 | + assert span.name == "ServiceBus.send" |
| 28 | + assert span.kind == SpanKind.CLIENT |
| 29 | + self._verify_span_attributes(span=span) |
| 30 | + assert span.attributes["az.namespace"] == "Microsoft.ServiceBus" |
| 31 | + assert span.attributes["messaging.system"] == "servicebus" |
| 32 | + assert span.attributes["messaging.destination.name"] == dest |
| 33 | + assert span.attributes["messaging.operation"] == "publish" |
| 34 | + assert span.attributes["server.address"] == server_address |
| 35 | + if message_count > 1: |
| 36 | + assert span.attributes["messaging.batch.message_count"] == message_count |
| 37 | + |
| 38 | + def _verify_receive(self, *, span, dest, server_address, message_count): |
| 39 | + assert span.name == "ServiceBus.receive" |
| 40 | + assert span.kind == SpanKind.CLIENT |
| 41 | + self._verify_span_attributes(span=span) |
| 42 | + assert span.attributes["az.namespace"] == "Microsoft.ServiceBus" |
| 43 | + assert span.attributes["messaging.system"] == "servicebus" |
| 44 | + assert span.attributes["messaging.destination.name"] == dest |
| 45 | + assert span.attributes["messaging.operation"] == "receive" |
| 46 | + assert span.attributes["server.address"] == server_address |
| 47 | + for link in span.links: |
| 48 | + assert "enqueuedTime" in link.attributes |
| 49 | + if message_count > 1: |
| 50 | + assert span.attributes["messaging.batch.message_count"] == message_count |
| 51 | + |
| 52 | + def _verify_complete(self, *, span, dest, server_address): |
| 53 | + assert span.name == "ServiceBus.complete" |
| 54 | + assert span.kind == SpanKind.CLIENT |
| 55 | + self._verify_span_attributes(span=span) |
| 56 | + assert span.attributes["az.namespace"] == "Microsoft.ServiceBus" |
| 57 | + assert span.attributes["messaging.system"] == "servicebus" |
| 58 | + assert span.attributes["messaging.operation"] == "settle" |
| 59 | + assert span.attributes["server.address"] == server_address |
| 60 | + assert span.attributes["messaging.destination.name"] == dest |
| 61 | + |
| 62 | + @pytest.mark.live_test_only |
| 63 | + def test_servicebus_client_tracing_queue(self, config, exporter, tracer): |
| 64 | + connection_string = config["servicebus_connection_string"] |
| 65 | + queue_name = config["servicebus_queue_name"] |
| 66 | + client = ServiceBusClient.from_connection_string(connection_string) |
| 67 | + |
| 68 | + with tracer.start_as_current_span(name="root"): |
| 69 | + with client.get_queue_sender(queue_name) as sender: |
| 70 | + |
| 71 | + # Sending a single message |
| 72 | + sender.send_messages(ServiceBusMessage("Test foo message")) |
| 73 | + |
| 74 | + # Sending a batch of messages |
| 75 | + message_batch = sender.create_message_batch() |
| 76 | + message_batch.add_message(ServiceBusMessage("First batch foo message")) |
| 77 | + message_batch.add_message(ServiceBusMessage("Second batch foo message")) |
| 78 | + sender.send_messages(message_batch) |
| 79 | + |
| 80 | + send_spans = exporter.get_finished_spans() |
| 81 | + server_address = sender.fully_qualified_namespace |
| 82 | + |
| 83 | + # We expect 5 spans to have finished: 2 send spans, and 3 message spans. |
| 84 | + assert len(send_spans) == 5 |
| 85 | + |
| 86 | + # Verify the spans from the first send. |
| 87 | + self._verify_message(span=send_spans[0], dest=queue_name, server_address=server_address) |
| 88 | + self._verify_send(span=send_spans[1], dest=queue_name, server_address=server_address, message_count=1) |
| 89 | + |
| 90 | + # Verify span links from single send. |
| 91 | + link = send_spans[1].links[0] |
| 92 | + assert link.context.span_id == send_spans[0].context.span_id |
| 93 | + assert link.context.trace_id == send_spans[0].context.trace_id |
| 94 | + |
| 95 | + # Verify the spans from the second send. |
| 96 | + self._verify_message(span=send_spans[2], dest=queue_name, server_address=server_address) |
| 97 | + self._verify_message(span=send_spans[3], dest=queue_name, server_address=server_address) |
| 98 | + self._verify_send(span=send_spans[4], dest=queue_name, server_address=server_address, message_count=2) |
| 99 | + |
| 100 | + # Verify span links from batch send. |
| 101 | + assert len(send_spans[4].links) == 2 |
| 102 | + link = send_spans[4].links[0] |
| 103 | + assert link.context.span_id == send_spans[2].context.span_id |
| 104 | + assert link.context.trace_id == send_spans[2].context.trace_id |
| 105 | + |
| 106 | + link = send_spans[4].links[1] |
| 107 | + assert link.context.span_id == send_spans[3].context.span_id |
| 108 | + assert link.context.trace_id == send_spans[3].context.trace_id |
| 109 | + |
| 110 | + exporter.clear() |
| 111 | + |
| 112 | + # Receive all the sent spans. |
| 113 | + receiver = client.get_queue_receiver(queue_name=queue_name) |
| 114 | + with receiver: |
| 115 | + received_msgs = receiver.receive_messages(max_message_count=3, max_wait_time=10) |
| 116 | + for msg in received_msgs: |
| 117 | + assert "foo" in str(msg) |
| 118 | + receiver.complete_message(msg) |
| 119 | + |
| 120 | + receive_spans = exporter.get_finished_spans() |
| 121 | + |
| 122 | + # We expect 4 spans to have finished: 1 receive span, and 3 settlement spans. |
| 123 | + assert len(receive_spans) == 4 |
| 124 | + self._verify_receive(span=receive_spans[0], dest=queue_name, server_address=server_address, message_count=3) |
| 125 | + |
| 126 | + # Verify span links from receive. |
| 127 | + assert len(receive_spans[0].links) == 3 |
| 128 | + assert receive_spans[0].links[0].context.span_id == send_spans[0].context.span_id |
| 129 | + assert receive_spans[0].links[1].context.span_id == send_spans[2].context.span_id |
| 130 | + assert receive_spans[0].links[2].context.span_id == send_spans[3].context.span_id |
| 131 | + |
| 132 | + # Verify settlement spans. |
| 133 | + self._verify_complete(span=receive_spans[1], dest=queue_name, server_address=server_address) |
| 134 | + self._verify_complete(span=receive_spans[2], dest=queue_name, server_address=server_address) |
| 135 | + self._verify_complete(span=receive_spans[3], dest=queue_name, server_address=server_address) |
| 136 | + |
| 137 | + @pytest.mark.live_test_only |
| 138 | + def test_servicebus_client_tracing_topic(self, config, exporter, tracer): |
| 139 | + connection_string = config["servicebus_connection_string"] |
| 140 | + topic_name = config["servicebus_topic_name"] |
| 141 | + subscription_name = config["servicebus_subscription_name"] |
| 142 | + client = ServiceBusClient.from_connection_string(connection_string) |
| 143 | + |
| 144 | + with tracer.start_as_current_span(name="root"): |
| 145 | + with client.get_topic_sender(topic_name) as sender: |
| 146 | + |
| 147 | + # Sending a single message |
| 148 | + sender.send_messages(ServiceBusMessage("Test foo message")) |
| 149 | + |
| 150 | + # Sending a batch of messages |
| 151 | + message_batch = sender.create_message_batch() |
| 152 | + message_batch.add_message(ServiceBusMessage("First batch foo message")) |
| 153 | + message_batch.add_message(ServiceBusMessage("Second batch foo message")) |
| 154 | + sender.send_messages(message_batch) |
| 155 | + |
| 156 | + send_spans = exporter.get_finished_spans() |
| 157 | + server_address = sender.fully_qualified_namespace |
| 158 | + |
| 159 | + # We expect 5 spans to have finished: 2 send spans, and 3 message spans. |
| 160 | + assert len(send_spans) == 5 |
| 161 | + |
| 162 | + # Verify the spans from the first send. |
| 163 | + self._verify_message(span=send_spans[0], dest=topic_name, server_address=server_address) |
| 164 | + self._verify_send(span=send_spans[1], dest=topic_name, server_address=server_address, message_count=1) |
| 165 | + |
| 166 | + # Verify span links from single send. |
| 167 | + link = send_spans[1].links[0] |
| 168 | + assert link.context.span_id == send_spans[0].context.span_id |
| 169 | + assert link.context.trace_id == send_spans[0].context.trace_id |
| 170 | + |
| 171 | + # Verify the spans from the second send. |
| 172 | + self._verify_message(span=send_spans[2], dest=topic_name, server_address=server_address) |
| 173 | + self._verify_message(span=send_spans[3], dest=topic_name, server_address=server_address) |
| 174 | + self._verify_send(span=send_spans[4], dest=topic_name, server_address=server_address, message_count=2) |
| 175 | + |
| 176 | + # Verify span links from batch send. |
| 177 | + assert len(send_spans[4].links) == 2 |
| 178 | + link = send_spans[4].links[0] |
| 179 | + assert link.context.span_id == send_spans[2].context.span_id |
| 180 | + assert link.context.trace_id == send_spans[2].context.trace_id |
| 181 | + |
| 182 | + link = send_spans[4].links[1] |
| 183 | + assert link.context.span_id == send_spans[3].context.span_id |
| 184 | + assert link.context.trace_id == send_spans[3].context.trace_id |
| 185 | + |
| 186 | + exporter.clear() |
| 187 | + |
| 188 | + # Receive all the sent spans. |
| 189 | + receiver = client.get_subscription_receiver(topic_name, subscription_name) |
| 190 | + with receiver: |
| 191 | + received_msgs = receiver.receive_messages(max_message_count=3, max_wait_time=10) |
| 192 | + for msg in received_msgs: |
| 193 | + assert "foo" in str(msg) |
| 194 | + receiver.complete_message(msg) |
| 195 | + |
| 196 | + receive_spans = exporter.get_finished_spans() |
| 197 | + |
| 198 | + # We expect 4 spans to have finished: 1 receive span, and 3 settlement spans. |
| 199 | + assert len(receive_spans) == 4 |
| 200 | + self._verify_receive(span=receive_spans[0], dest=topic_name, server_address=server_address, message_count=3) |
| 201 | + |
| 202 | + assert len(receive_spans[0].links) == 3 |
| 203 | + assert receive_spans[0].links[0].context.span_id == send_spans[0].context.span_id |
| 204 | + assert receive_spans[0].links[1].context.span_id == send_spans[2].context.span_id |
| 205 | + assert receive_spans[0].links[2].context.span_id == send_spans[3].context.span_id |
| 206 | + |
| 207 | + # Verify settlement spans. |
| 208 | + self._verify_complete(span=receive_spans[1], dest=topic_name, server_address=server_address) |
| 209 | + self._verify_complete(span=receive_spans[2], dest=topic_name, server_address=server_address) |
| 210 | + self._verify_complete(span=receive_spans[3], dest=topic_name, server_address=server_address) |
0 commit comments