**DRAFT** feat: Azure Service Bus Instrumentation #2880
+901
−5
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -423,6 +423,7 @@ jobs: | |
| matrix: | ||
| namespace: | ||
| [ | ||
| AzureServiceBus, | ||
| CosmosDB, | ||
| Couchbase, | ||
| Elasticsearch, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TargetFrameworks>net462;netstandard2.0</TargetFrameworks> | ||
| <AssemblyName>NewRelic.Providers.Wrapper.AzureServiceBus</AssemblyName> | ||
| <RootNamespace>NewRelic.Providers.Wrapper.AzureServiceBus</RootNamespace> | ||
| <Description>Azure Service Bus Wrapper Provider for New Relic .NET Agent</Description> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <Content Include="Instrumentation.xml"> | ||
| <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> | ||
| </Content> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.CSharp" Version="4.7.0" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\..\NewRelic.Agent.Extensions\NewRelic.Agent.Extensions.csproj" /> | ||
| </ItemGroup> | ||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| // Copyright 2020 New Relic, Inc. All rights reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| using System; | ||
| using System.Collections.Concurrent; | ||
| using System.Collections.Generic; | ||
| using System.Collections.ObjectModel; | ||
| using System.Threading.Tasks; | ||
| using NewRelic.Agent.Api; | ||
| using NewRelic.Agent.Extensions.Providers.Wrapper; | ||
| using NewRelic.Reflection; | ||
|
|
||
| namespace NewRelic.Providers.Wrapper.AzureServiceBus; | ||
|
|
||
| public class AzureServiceBusReceiveWrapper : AzureServiceBusWrapperBase | ||
| { | ||
| private static readonly ConcurrentDictionary<Type, Func<object, object>> _getResultFromGenericTask = new(); | ||
|
|
||
| public override CanWrapResponse CanWrap(InstrumentedMethodInfo instrumentedMethodInfo) | ||
| { | ||
| var canWrap = instrumentedMethodInfo.RequestedWrapperName.Equals(nameof(AzureServiceBusReceiveWrapper)); | ||
| return new CanWrapResponse(canWrap); | ||
| } | ||
|
|
||
| public override AfterWrappedMethodDelegate BeforeWrappedMethod(InstrumentedMethodCall instrumentedMethodCall, IAgent agent, ITransaction transaction) | ||
| { | ||
| dynamic serviceBusReceiver = instrumentedMethodCall.MethodCall.InvocationTarget; | ||
| string queueName = serviceBusReceiver.EntityPath; // some-queue-name | ||
| string fqns = serviceBusReceiver.FullyQualifiedNamespace; // some-service-bus-entity.servicebus.windows.net | ||
|
|
||
| MessageBrokerAction action = | ||
| instrumentedMethodCall.MethodCall.Method.MethodName switch | ||
| { | ||
| "ReceiveMessagesAsync" => MessageBrokerAction.Consume, | ||
| "ReceiveDeferredMessagesAsync" => MessageBrokerAction.Consume, | ||
| "PeekMessagesInternalAsync" => MessageBrokerAction.Peek, | ||
| "AbandonMessageAsync" => MessageBrokerAction.Purge, // TODO is this correct ??? Abandon sends the message back to the queue for re-delivery | ||
| "CompleteMessageAsync" => MessageBrokerAction.Consume, | ||
| "DeadLetterInternalAsync" => MessageBrokerAction.Purge, // TODO is this correct ??? | ||
| "DeferMessageAsync" => MessageBrokerAction.Consume, // TODO is this correct or should we extend MessageBrokerAction with more values??? | ||
| "RenewMessageLockAsync" => MessageBrokerAction.Consume, // TODO is this correct or should we extend MessageBrokerAction with more values??? | ||
| _ => throw new ArgumentOutOfRangeException(nameof(action), $"Unexpected instrumented method call: {instrumentedMethodCall.MethodCall.Method.MethodName}") | ||
| }; | ||
|
|
||
| // start a message broker segment | ||
| var segment = transaction.StartMessageBrokerSegment( | ||
| instrumentedMethodCall.MethodCall, | ||
| MessageBrokerDestinationType.Queue, | ||
| action, | ||
| BrokerVendorName, | ||
| queueName, | ||
| serverAddress: fqns ); | ||
|
|
||
| return instrumentedMethodCall.IsAsync | ||
| ? | ||
| // return an async delegate | ||
| Delegates.GetAsyncDelegateFor<Task>( | ||
| agent, | ||
| segment, | ||
| false, | ||
| HandleResponse, | ||
| TaskContinuationOptions.ExecuteSynchronously) | ||
| : Delegates.GetDelegateFor<object>( | ||
| onFailure: transaction.NoticeError, | ||
| onComplete: segment.End, | ||
| onSuccess: ExtractDTHeadersIfAvailable); | ||
|
|
||
| void HandleResponse(Task responseTask) | ||
| { | ||
| try | ||
| { | ||
| if (responseTask.IsFaulted) | ||
| { | ||
| transaction.NoticeError(responseTask.Exception); | ||
| return; | ||
| } | ||
|
|
||
| var resultObj = GetTaskResultFromObject(responseTask); | ||
| ExtractDTHeadersIfAvailable(resultObj); | ||
| } | ||
| finally | ||
| { | ||
| segment.End(); | ||
| } | ||
| } | ||
|
|
||
|
|
||
|
|
||
| void ExtractDTHeadersIfAvailable(object resultObj) | ||
| { | ||
| if (resultObj != null) | ||
| { | ||
| switch (instrumentedMethodCall.MethodCall.Method.MethodName) | ||
| { | ||
| case "ReceiveMessagesAsync": | ||
| case "ReceiveDeferredMessagesAsync": | ||
| case "PeekMessagesInternalAsync": | ||
| // the response contains a list of messages. | ||
| // get the first message from the response and extract DT headers | ||
| dynamic messages = resultObj; | ||
| if (messages.Count > 0) | ||
| { | ||
| var msg = messages[0]; | ||
| if (msg.ApplicationProperties is ReadOnlyDictionary<string, object> applicationProperties) | ||
| { | ||
| transaction.AcceptDistributedTraceHeaders(applicationProperties, ProcessHeaders, TransportType.Queue); | ||
| } | ||
| } | ||
| break; | ||
| } | ||
| } | ||
| IEnumerable<string> ProcessHeaders(ReadOnlyDictionary<string, object> applicationProperties, string key) | ||
| { | ||
| var headerValues = new List<string>(); | ||
| foreach (var item in applicationProperties) | ||
| { | ||
| if (item.Key.Equals(key, StringComparison.OrdinalIgnoreCase)) | ||
| { | ||
| headerValues.Add(item.Value as string); | ||
| } | ||
| } | ||
|
|
||
| return headerValues; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static object GetTaskResultFromObject(object taskObj) | ||
| { | ||
| var task = taskObj as Task; | ||
| if (task == null) | ||
| { | ||
| return null; | ||
| } | ||
| if (task.IsFaulted) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| var getResponse = _getResultFromGenericTask.GetOrAdd(task.GetType(), t => VisibilityBypasser.Instance.GeneratePropertyAccessor<object>(t, "Result")); | ||
| return getResponse(task); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| // Copyright 2020 New Relic, Inc. All rights reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Threading.Tasks; | ||
| using NewRelic.Agent.Api; | ||
| using NewRelic.Agent.Extensions.Providers.Wrapper; | ||
|
|
||
| namespace NewRelic.Providers.Wrapper.AzureServiceBus; | ||
|
|
||
| public class AzureServiceBusSendWrapper : AzureServiceBusWrapperBase | ||
| { | ||
| public override CanWrapResponse CanWrap(InstrumentedMethodInfo instrumentedMethodInfo) | ||
| { | ||
| var canWrap = instrumentedMethodInfo.RequestedWrapperName.Equals(nameof(AzureServiceBusSendWrapper)); | ||
| return new CanWrapResponse(canWrap); | ||
| } | ||
|
|
||
| public override AfterWrappedMethodDelegate BeforeWrappedMethod(InstrumentedMethodCall instrumentedMethodCall, IAgent agent, ITransaction transaction) | ||
| { | ||
| dynamic serviceBusReceiver = instrumentedMethodCall.MethodCall.InvocationTarget; | ||
| string queueName = serviceBusReceiver.EntityPath; // some-queue-name | ||
| string fqns = serviceBusReceiver.FullyQualifiedNamespace; // some-service-bus-entity.servicebus.windows.net | ||
|
|
||
| // determine message broker action based on method name | ||
| MessageBrokerAction action = | ||
| instrumentedMethodCall.MethodCall.Method.MethodName switch | ||
| { | ||
| "SendMessagesAsync" => MessageBrokerAction.Produce, | ||
| "ScheduleMessagesAsync" => MessageBrokerAction.Produce, | ||
| "CancelScheduledMessagesAsync" => MessageBrokerAction.Purge, // TODO is this correct ??? | ||
| _ => throw new ArgumentOutOfRangeException(nameof(action), $"Unexpected instrumented method call: {instrumentedMethodCall.MethodCall.Method.MethodName}") | ||
| }; | ||
|
|
||
| // start a message broker segment | ||
| var segment = transaction.StartMessageBrokerSegment( | ||
| instrumentedMethodCall.MethodCall, | ||
| MessageBrokerDestinationType.Queue, | ||
| action, | ||
| BrokerVendorName, | ||
| queueName, | ||
| serverAddress: fqns); | ||
|
|
||
| if (action == MessageBrokerAction.Produce) | ||
| { | ||
| dynamic messages = instrumentedMethodCall.MethodCall.MethodArguments[0]; | ||
|
|
||
| // iterate all messages that are being sent, | ||
| // insert DT headers into each message | ||
| foreach (var message in messages) | ||
| { | ||
| if (message.ApplicationProperties is IDictionary<string, object> applicationProperties) | ||
| transaction.InsertDistributedTraceHeaders(applicationProperties, ProcessHeaders); | ||
| } | ||
|
|
||
| void ProcessHeaders(IDictionary<string, object> applicationProperties, string key, string value) | ||
| { | ||
| applicationProperties.Add(key, value); | ||
| } | ||
| } | ||
|
|
||
| return instrumentedMethodCall.IsAsync ? Delegates.GetAsyncDelegateFor<Task>(agent, segment) : Delegates.GetDelegateFor(segment); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| // Copyright 2020 New Relic, Inc. All rights reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| using NewRelic.Agent.Api; | ||
| using NewRelic.Agent.Extensions.Providers.Wrapper; | ||
|
|
||
| namespace NewRelic.Providers.Wrapper.AzureServiceBus | ||
| { | ||
| public abstract class AzureServiceBusWrapperBase : IWrapper | ||
| { | ||
| protected const string BrokerVendorName = "AzureServiceBus"; | ||
|
|
||
| public bool IsTransactionRequired => true; // only instrument service bus methods if we're already in a transaction | ||
|
There was a problem hiding this comment. This seems different compared with other MQ that we instrument. Shouldn't the receive generate a transaction? There was a problem hiding this comment. 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. There was a problem hiding this comment. Looks like we could potentially instrument |
||
|
|
||
| public abstract CanWrapResponse CanWrap(InstrumentedMethodInfo instrumentedMethodInfo); | ||
|
|
||
| public abstract AfterWrappedMethodDelegate BeforeWrappedMethod(InstrumentedMethodCall instrumentedMethodCall, IAgent agent,ITransaction transaction); | ||
|
|
||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems correct based on the description of the method.