**DRAFT** feat: Azure Service Bus Instrumentation

[tippmar-nr]

Thank you for submitting a pull request. Please review our contributing guidelines and code of conduct.

Description

This PR adds instrumentation for Azure Service Bus, for applications that use the Azure.Messaging.ServiceBus NuGet package, v7.12.0 and later.

The following methods are instrumented:

• ServiceBusReceiver:
  • ReceiveMessageAsync() and ReceiveMessagesAsync()
  • ReceiveDeferredMessageAsync() and ReceiveDeferredMessagesAsync()
  • PeekMessageAsync() and PeekMessagesAsync()
  • CompleteMessageAsync()
  • AbandonMessageAsync()
  • DeadLetterMessageAsync()
  • DeferMessageAsync()
  • RenewMessageLockAsync()
• ServiceBusSender:
  • SendMessageAsync() and SendMessagesAsync()
  • ScheduleMessageAsync() and ScheduleMessagesAsync()
  • CancelScheduledMessageAsync() and CancelScheduledMessagesAsync()

Distributed tracing support is included, using the ApplicationProperties dictionary.

Author Checklist

• Unit tests, Integration tests, and Unbounded tests completed
• Performance testing completed with satisfactory results (if required)

Reviewer Checklist

• Perform code review
• Pull request was adequately tested (new/existing tests, performance tests)

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.45%. Comparing base (d1e29ea) to head (81f48ae).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2880      +/-   ##
==========================================
+ Coverage   81.43%   81.45%   +0.02%     
==========================================
  Files         465      465              
  Lines       29573    29573              
  Branches     3275     3275              
==========================================
+ Hits        24084    24090       +6     
+ Misses       4692     4688       -4     
+ Partials      797      795       -2     

Flag	Coverage Δ
Agent	82.39% <ø> (+0.02%)	⬆️
Profiler	73.07% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 2 files with indirect coverage changes

[jaffinito]

This seems correct based on the description of the method.

[jaffinito]

This seems different compared with other MQ that we instrument. Shouldn't the receive generate a transaction?

[tippmar-nr]

Probably a topic for pairing on Tuesday. But this implementation is consistent with our MSMQ instrumentation. Unlike RabbitMQ, there's not an "eventing" layer that we could instrument that would wrap processing time on the client application.

[tippmar-nr]

Looks like we could potentially instrument ServiceBusProcessor which does implement an event-based receive model where client code is called when a message is received. I'll take a quick look to see if it's worth the effort or not.