feat(azure_servicebus): add azure servicebus integration and function trigger distributed tracing #13691

duncanpharvey · 2025-06-17T15:01:59Z

This PR adds an integration for tracing the producer of the azure-servicebus package and adds support for distributed tracing for Azure Functions consuming the service bus messages.

Instrumentation details:

Both azure.servicebus and azure.servicebus.aio (async package) are patched
Methods patched
- ServiceBusSender.send_messages
- ServiceBusSender.schedule_messages
Trace context injected into application_properties of each service bus message passed to above methods
- Handles single ServiceBusMessage or AmqpAnnotatedMessage in addition to a list of ServiceBusMessage or AmqpAnnotatedMessage
- Will handle trace context propagation of ServiceBusMessageBatch in a future PR
Trace context extracted from application_properties in Azure Function service bus consumer
Operation: azure.servicebus.produce
Azure Service Bus span attributes
- component: azure_servicebus
- span.kind: producer
- messaging.destination.system: servicebus
- messaging.destination.name: <queue/topic name>
- azure.servicebus.fully_qualified_namespace: <host name for the Service Bus namespace>
  - Maps to peer.service if enabled

Additional Notes:

Adds azureservicebusemulator and azuresqledge services to run Azure Service Bus locally and in CI for tests
- https://learn.microsoft.com/en-us/azure/service-bus-messaging/test-locally-with-service-bus-emulator?tabs=docker-linux-container
Minor refactor to azure_functions integration to use ctx.span instead of adding req_span and trigger_span properties to the context

Checklist

PR author has checked that all the criteria below are met
The PR description includes an overview of the change
The PR description articulates the motivation for the change
The change includes tests OR the PR description describes a testing strategy
The PR description notes risks associated with the change, if any
Newly-added code is easy to change
The change follows the library release note guidelines
The change includes or references documentation updates if necessary
Backport labels are set (if applicable)

Reviewer Checklist

Reviewer has checked that all the criteria below are met
Title is accurate
All changes are related to the pull request's stated goal
Avoids breaking API changes
Testing strategy adequately addresses listed risks
Newly-added code is easy to change
Release note makes sense to a user of the library
If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
Backport labels are set in a manner that is consistent with the release branch maintenance policy

…e functions

…ced directly from the context

… related to service bus

…ctions and azure_servicebus

tests/contrib/azure_servicebus/test_azure_servicebus_patch.py

ddtrace/contrib/internal/azure_servicebus/patch.py

github-actions · 2025-06-17T15:02:35Z

CODEOWNERS have been resolved as:

.riot/requirements/10f86d9.txt                                          @DataDog/apm-python
.riot/requirements/1170953.txt                                          @DataDog/apm-python
.riot/requirements/156842b.txt                                          @DataDog/apm-python
.riot/requirements/1670b58.txt                                          @DataDog/apm-python
.riot/requirements/16ae446.txt                                          @DataDog/apm-python
.riot/requirements/1826cd3.txt                                          @DataDog/apm-python
.riot/requirements/18a650f.txt                                          @DataDog/apm-python
.riot/requirements/1d35b33.txt                                          @DataDog/apm-python
.riot/requirements/1e1c2b7.txt                                          @DataDog/apm-python
.riot/requirements/3f34788.txt                                          @DataDog/apm-python
.riot/requirements/5b956b7.txt                                          @DataDog/apm-python
.riot/requirements/6c15ef8.txt                                          @DataDog/apm-python
.riot/requirements/803d32f.txt                                          @DataDog/apm-python
.riot/requirements/a1026b8.txt                                          @DataDog/apm-python
.riot/requirements/ade49fb.txt                                          @DataDog/apm-python
.riot/requirements/b43c003.txt                                          @DataDog/apm-python
ddtrace/contrib/_azure_servicebus.py                                    @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/azure_servicebus/patch.py                      @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/azure_servicebus/utils.py                      @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/ext/azure_servicebus.py                                         @DataDog/apm-core-python @DataDog/apm-idm-python
releasenotes/notes/feat-add-azure-servicebus-integration-4034143c46abe1c6.yaml  @DataDog/apm-python
tests/contrib/azure_servicebus/__init__.py                              @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/azure_servicebus/test_azure_servicebus_patch.py           @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/azure_servicebus/test_azure_servicebus_snapshot.py        @DataDog/apm-core-python @DataDog/apm-idm-python
tests/snapshots/tests.contrib.azure_functions.test_azure_functions_snapshot.test_service_bus_distributed_tracing[disabled].json  @DataDog/apm-python
tests/snapshots/tests.contrib.azure_functions.test_azure_functions_snapshot.test_service_bus_distributed_tracing[enabled].json  @DataDog/apm-python
tests/snapshots/tests.contrib.azure_servicebus.test_azure_servicebus_snapshot.test_schedule_messages.json  @DataDog/apm-python
tests/snapshots/tests.contrib.azure_servicebus.test_azure_servicebus_snapshot.test_schedule_messages_async.json  @DataDog/apm-python
tests/snapshots/tests.contrib.azure_servicebus.test_azure_servicebus_snapshot.test_send_messages[default_config].json  @DataDog/apm-python
tests/snapshots/tests.contrib.azure_servicebus.test_azure_servicebus_snapshot.test_send_messages[distributed_tracing_disabled].json  @DataDog/apm-python
tests/snapshots/tests.contrib.azure_servicebus.test_azure_servicebus_snapshot.test_send_messages[peer_service_enabled].json  @DataDog/apm-python
tests/snapshots/tests.contrib.azure_servicebus.test_azure_servicebus_snapshot.test_send_messages_async.json  @DataDog/apm-python
.gitlab/services.yml                                                    @DataDog/python-guild @DataDog/apm-core-python
ddtrace/_monkey.py                                                      @DataDog/apm-core-python
ddtrace/_trace/trace_handlers.py                                        @DataDog/apm-sdk-api-python
ddtrace/contrib/_azure_functions.py                                     @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/integration_registry/registry.yaml                      @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/azure_functions/patch.py                       @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/settings/_config.py                                             @DataDog/apm-core-python
ddtrace/settings/peer_service.py                                        @DataDog/apm-core-python
docker-compose.yml                                                      @DataDog/apm-core-python
riotfile.py                                                             @DataDog/apm-python
supported_versions_output.json                                          @DataDog/apm-core-python
supported_versions_table.csv                                            @DataDog/apm-core-python
tests/contrib/azure_functions/azure_function_app/function_app.py        @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/azure_functions/azure_function_app/local.settings.json    @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/azure_functions/test_azure_functions_patch.py             @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/azure_functions/test_azure_functions_snapshot.py          @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/patch.py                                                  @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/suitespec.yml                                             @DataDog/apm-core-python @DataDog/apm-idm-python
tests/snapshots/tests.contrib.azure_functions.test_azure_functions_snapshot.test_http_get_distributed_tracing[disabled].json  @DataDog/apm-python
tests/snapshots/tests.contrib.azure_functions.test_azure_functions_snapshot.test_http_get_distributed_tracing[enabled].json  @DataDog/apm-python
.riot/requirements/1241599.txt                                          @DataDog/apm-python
.riot/requirements/1ac22db.txt                                          @DataDog/apm-python
.riot/requirements/9b11151.txt                                          @DataDog/apm-python
.riot/requirements/e7ef4bc.txt                                          @DataDog/apm-python

github-actions · 2025-06-17T15:23:39Z

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

The average import time from this PR is: 276 ± 2 ms.

The average import time from base is: 278 ± 2 ms.

The import time difference between this PR and base is: -1.63 ± 0.1 ms.

Import time breakdown

The following import paths have appeared:

ddtrace.auto 0.320 ms (0.12%)

ddtrace.bootstrap.sitecustomize 0.320 ms (0.12%)

ddtrace._trace.trace_handlers 0.320 ms (0.12%)

ddtrace.ext.azure_servicebus 0.320 ms (0.12%)

The following import paths have grown:

ddtrace.auto 0.091 ms (0.03%)

ddtrace.bootstrap.sitecustomize 0.091 ms (0.03%)

ddtrace.contrib.internal.subprocess.constants 0.063 ms (0.02%)

ddtrace.contrib.internal.logging.constants 0.028 ms (0.01%)

The following import paths have shrunk:

ddtrace.auto 2.003 ms (0.73%)

ddtrace.bootstrap.sitecustomize 1.330 ms (0.48%)

ddtrace.bootstrap.preload 1.330 ms (0.48%)

ddtrace.internal.remoteconfig.client 0.628 ms (0.23%)

ddtrace 0.673 ms (0.24%)

ddtrace.internal._unpatched 0.030 ms (0.01%)

json 0.030 ms (0.01%)

json.decoder 0.030 ms (0.01%)

re 0.030 ms (0.01%)

enum 0.030 ms (0.01%)

types 0.030 ms (0.01%)

pr-commenter · 2025-06-17T16:10:51Z

Benchmarks

Benchmark execution time: 2025-06-18 02:20:24

Comparing candidate commit 82e0204 in PR branch duncan-harvey/azure-servicebus-integration with baseline commit 5592908 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 561 metrics, 3 unstable metrics.

emmettbutler

Very nice use of ddtrace.internal.core!

emmettbutler · 2025-06-17T16:30:35Z

tests/contrib/azure_servicebus/test_azure_servicebus_patch.py

+    __get_version__ = get_version
+
+    def assert_module_patched(self, azure_servicebus):
+        pass


Replacing this with an assertion verifying that the azure.servicebus module has been patched would strengthen this test case and protect against regressions. Same for the other two functions here.

Great suggestion! I added some assertions to the patch tests.

Also because this integration also patches azure.servicebus.aio, a submodule of azure.servicebus, I added an additional case for test_supported_versions_function_exists. I tried changing the else to use rpartition as well but it broke the tests for pynamodb.connection.base since that submodule should resolve to pynamodb. Let me know if you have any ideas for a more general solution.

dd-trace-py/tests/contrib/patch.py

Lines 818 to 824 in 82e0204

elif module_name in {"azure.servicebus.aio"}:

# handle specific submodules where the top level module name includes a dot

module_name = module_name.rpartition(".")[0]

else:

# this may be a submodule we are importing, so get the top level module name

# ie: snowflake.connector -> snowflake

module_name = module_name.split(".")[0]

emmettbutler · 2025-06-17T16:46:30Z

ddtrace/contrib/internal/azure_servicebus/patch.py

+def get_version():
+    # type: () -> str


Suggested change

def get_version():

# type: () -> str

def get_version() -> str:

Suggestion applied for both Azure Service Bus and Azure Functions

dd-trace-py/ddtrace/contrib/internal/azure_servicebus/patch.py

Lines 29 to 30 in 82e0204

def get_version() -> str:

return getattr(azure_servicebus, "__version__", "")

dd-trace-py/ddtrace/contrib/internal/azure_functions/patch.py

Lines 27 to 28 in 82e0204

def get_version() -> str:

return getattr(azure_functions, "__version__", "")

…pan attribute

…grations

…'t reuse service bus messages

duncanpharvey added 27 commits June 9, 2025 13:16

initial commit to add azure_servicebus integration

5b53500

minor updates and todos

bfa1970

refactor service bus propagation

66a202e

check distributed tracing config and handle async

dc87a36

refactor patch and unpatch for multiple modules

5c9189c

add trace context to all messages in list

7cea1b7

fix formatting

b017652

add integration tests for distributing tracing of service bus in azur…

f1c1aa1

…e functions

add image tags, add riot requirements, and fix tests for python 3.8

ce5076b

rename azure service bus aio import

a11c715

remove setting of req_span and trigger_span since the span is referen…

c0293f3

…ced directly from the context

add services for testing with azure service bus emulator in ci

9c73178

clean up riot requirements files

790480a

add azure service bus tests and remove redundant azure function tests…

0885104

… related to service bus

Merge branch 'main' into duncan-harvey/azure-servicebus-integration

8c3fc76

add configuration documentation for distributed tracing for azure_fun…

f32cf5a

…ctions and azure_servicebus

add azure_service bus to suitspec

a6d6ee0

add supported versions to azure service bus integration

256aa65

fix parameter type in test and add port mapping for azuresqledge

b2048ac

fix additional type issues and add integrations to registry

89d6a30

add min version for azure servicebus integration

aa4505a

Merge branch 'main' into duncan-harvey/azure-servicebus-integration

6c5f5d6

patch schedule_messages

a60b657

complete messages in azure servicebus tests

a3974fb

add span attributes and refactor tests

5a7e2a6

add azure service bus span metadata to azure functions tests

e084e47

add release note

bc1fd82

duncanpharvey requested review from a team as code owners June 17, 2025 15:02

duncanpharvey requested review from ZStriker19, juanjux and wconti27 June 17, 2025 15:02

datadog-datadog-prod-us1 bot reviewed Jun 17, 2025

View reviewed changes

tests/contrib/azure_servicebus/test_azure_servicebus_patch.py Outdated Show resolved Hide resolved

ddtrace/contrib/internal/azure_servicebus/patch.py Outdated Show resolved Hide resolved

address code quality violations

88db325

duncanpharvey changed the title ~~feat(azure_servicebus): add azure servicebus integration and distributed tracing with azure function service bus triggers~~ feat(azure_servicebus): add azure servicebus integration and function trigger distributed tracing Jun 17, 2025

emmettbutler approved these changes Jun 17, 2025

View reviewed changes

emmettbutler and others added 10 commits June 17, 2025 09:49

Merge branch 'main' into duncan-harvey/azure-servicebus-integration

21e8c93

use servicebus instead of Microsoft.ServiceBus for messaging.system s…

a44a618

…pan attribute

clean up get_version signature

26d50f1

add patching assertions for azure_servicebus and azure_functions inte…

daadb0d

…grations

Merge branch 'main' into duncan-harvey/azure-servicebus-integration

ec18ff4

handle version for azure.servicebus.aio with specific case

40abb00

improve performance for azure servicebus tests

7fa4225

remove module scoped fixtures

203933b

remove remaining module scoped fixtures

bb557af

don't send messages to the same queue or topic asynchronously and don…

82e0204

…'t reuse service bus messages

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(azure_servicebus): add azure servicebus integration and function trigger distributed tracing #13691

feat(azure_servicebus): add azure servicebus integration and function trigger distributed tracing #13691

duncanpharvey commented Jun 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 17, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 17, 2025 •

edited

Loading

Uh oh!

pr-commenter bot commented Jun 17, 2025 •

edited

Loading

Uh oh!

emmettbutler left a comment

Uh oh!

emmettbutler Jun 17, 2025

Uh oh!

duncanpharvey Jun 18, 2025

Uh oh!

emmettbutler Jun 17, 2025

Uh oh!

duncanpharvey Jun 18, 2025

Uh oh!

Uh oh!

	elif module_name in {"azure.servicebus.aio"}:
	# handle specific submodules where the top level module name includes a dot
	module_name = module_name.rpartition(".")[0]
	else:
	# this may be a submodule we are importing, so get the top level module name
	# ie: snowflake.connector -> snowflake
	module_name = module_name.split(".")[0]

	def get_version():
	# type: () -> str
	def get_version() -> str:

	def get_version() -> str:
	return getattr(azure_servicebus, "__version__", "")

	def get_version() -> str:
	return getattr(azure_functions, "__version__", "")

feat(azure_servicebus): add azure servicebus integration and function trigger distributed tracing #13691

Are you sure you want to change the base?

feat(azure_servicebus): add azure servicebus integration and function trigger distributed tracing #13691

Conversation

duncanpharvey commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Instrumentation details:

Additional Notes:

Checklist

Reviewer Checklist

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bootstrap import analysis

Summary

Import time breakdown

Uh oh!

pr-commenter bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Benchmarks

Uh oh!

emmettbutler left a comment

Choose a reason for hiding this comment

Uh oh!

emmettbutler Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

duncanpharvey Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

emmettbutler Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

duncanpharvey Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

duncanpharvey commented Jun 17, 2025 •

edited

Loading

github-actions bot commented Jun 17, 2025 •

edited

Loading

github-actions bot commented Jun 17, 2025 •

edited

Loading

pr-commenter bot commented Jun 17, 2025 •

edited

Loading