|
| 1 | +// <copyright file="AwsSqsHandlerCommon.cs" company="Datadog"> |
| 2 | +// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License. |
| 3 | +// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc. |
| 4 | +// </copyright> |
| 5 | + |
| 6 | +#nullable enable |
| 7 | + |
| 8 | +using System; |
| 9 | +using Datadog.Trace.ClrProfiler.CallTarget; |
| 10 | +using Datadog.Trace.DataStreamsMonitoring; |
| 11 | +using Datadog.Trace.DuckTyping; |
| 12 | +using Datadog.Trace.Vendors.Newtonsoft.Json.Utilities; |
| 13 | + |
| 14 | +namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AWS.SQS; |
| 15 | + |
| 16 | +/// <summary> |
| 17 | +/// Contains the code that is shared between the integrations of sync/async and batch/single send and receive. |
| 18 | +/// </summary> |
| 19 | +internal static class AwsSqsHandlerCommon |
| 20 | +{ |
| 21 | + internal static CallTargetState BeforeSend<TSendMessageRequest>(TSendMessageRequest request, SendType sendType) |
| 22 | + { |
| 23 | + if (request is null) |
| 24 | + { |
| 25 | + return CallTargetState.GetDefault(); |
| 26 | + } |
| 27 | + |
| 28 | + // we can't use generic constraints for this duck typing, because we need the original type |
| 29 | + // for the InjectHeadersIntoMessage<TSendMessageRequest> call below |
| 30 | + var requestProxy = request.DuckCast<IAmazonSQSRequestWithQueueUrl>(); |
| 31 | + |
| 32 | + var scope = AwsSqsCommon.CreateScope(Tracer.Instance, sendType.OperationName, out var tags, spanKind: SpanKinds.Producer); |
| 33 | + |
| 34 | + var queueName = AwsSqsCommon.GetQueueName(requestProxy.QueueUrl); |
| 35 | + if (tags is not null && requestProxy.QueueUrl is not null) |
| 36 | + { |
| 37 | + tags.QueueUrl = requestProxy.QueueUrl; |
| 38 | + tags.QueueName = queueName; |
| 39 | + } |
| 40 | + |
| 41 | + if (scope?.Span.Context != null && !string.IsNullOrEmpty(queueName)) |
| 42 | + { |
| 43 | + var dataStreamsManager = Tracer.Instance.TracerManager.DataStreamsManager; |
| 44 | + |
| 45 | + if (sendType == SendType.SingleMessage) |
| 46 | + { |
| 47 | + InjectForSingleMessage(dataStreamsManager, request, scope, queueName); |
| 48 | + } |
| 49 | + else if (sendType == SendType.Batch) |
| 50 | + { |
| 51 | + InjectForBatch(dataStreamsManager, request, scope, queueName); |
| 52 | + } |
| 53 | + } |
| 54 | + |
| 55 | + return new CallTargetState(scope); |
| 56 | + } |
| 57 | + |
| 58 | + private static void InjectForSingleMessage<TSendMessageRequest>(DataStreamsManager? dataStreamsManager, TSendMessageRequest request, Scope scope, string queueName) |
| 59 | + { |
| 60 | + var requestProxy = request.DuckCast<ISendMessageRequest>(); |
| 61 | + if (requestProxy == null) |
| 62 | + { |
| 63 | + return; |
| 64 | + } |
| 65 | + |
| 66 | + if (dataStreamsManager != null && dataStreamsManager.IsEnabled) |
| 67 | + { |
| 68 | + var edgeTags = new[] { "direction:out", $"topic:{queueName}", "type:sqs" }; |
| 69 | + scope.Span.SetDataStreamsCheckpoint(dataStreamsManager, CheckpointKind.Produce, edgeTags, payloadSizeBytes: 0, timeInQueueMs: 0); |
| 70 | + } |
| 71 | + |
| 72 | + ContextPropagation.InjectHeadersIntoMessage<TSendMessageRequest>(requestProxy, scope.Span.Context, dataStreamsManager); |
| 73 | + } |
| 74 | + |
| 75 | + private static void InjectForBatch<TSendMessageBatchRequest>(DataStreamsManager? dataStreamsManager, TSendMessageBatchRequest request, Scope scope, string queueName) |
| 76 | + { |
| 77 | + var requestProxy = request.DuckCast<ISendMessageBatchRequest>(); |
| 78 | + if (requestProxy == null) |
| 79 | + { |
| 80 | + return; |
| 81 | + } |
| 82 | + |
| 83 | + var edgeTags = new[] { "direction:out", $"topic:{queueName}", "type:sqs" }; |
| 84 | + foreach (var e in requestProxy.Entries) |
| 85 | + { |
| 86 | + var entry = e.DuckCast<IContainsMessageAttributes>(); |
| 87 | + if (entry != null) |
| 88 | + { |
| 89 | + // this has no effect is DSM is disabled |
| 90 | + scope.Span.SetDataStreamsCheckpoint(dataStreamsManager, CheckpointKind.Produce, edgeTags, payloadSizeBytes: 0, timeInQueueMs: 0); |
| 91 | + // this needs to be done for context propagation even when DSM is disabled |
| 92 | + // (when DSM is enabled, it injects the pathway context on top of the trace context) |
| 93 | + ContextPropagation.InjectHeadersIntoMessage<TSendMessageBatchRequest>(entry, scope.Span.Context, dataStreamsManager); |
| 94 | + } |
| 95 | + } |
| 96 | + } |
| 97 | + |
| 98 | + internal static TResponse AfterSend<TResponse>(TResponse response, Exception? exception, in CallTargetState state) |
| 99 | + { |
| 100 | + state.Scope.DisposeWithException(exception); |
| 101 | + return response; |
| 102 | + } |
| 103 | + |
| 104 | + internal static CallTargetState BeforeReceive(IReceiveMessageRequest request) |
| 105 | + { |
| 106 | + if (request.Instance is null) |
| 107 | + { |
| 108 | + return CallTargetState.GetDefault(); |
| 109 | + } |
| 110 | + |
| 111 | + var queueName = AwsSqsCommon.GetQueueName(request.QueueUrl); |
| 112 | + var scope = AwsSqsCommon.CreateScope(Tracer.Instance, "ReceiveMessage", out var tags, spanKind: SpanKinds.Consumer); |
| 113 | + if (tags is not null && request.QueueUrl is not null) |
| 114 | + { |
| 115 | + tags.QueueUrl = request.QueueUrl; |
| 116 | + tags.QueueName = queueName; |
| 117 | + } |
| 118 | + |
| 119 | + // request the message attributes that a datadog instrumentation might have set when sending |
| 120 | + request.MessageAttributeNames.AddDistinct(ContextPropagation.SqsKey); |
| 121 | + request.AttributeNames.AddDistinct("SentTimestamp"); |
| 122 | + |
| 123 | + return new CallTargetState(scope, queueName); |
| 124 | + } |
| 125 | + |
| 126 | + internal static TResponse AfterReceive<TResponse>(TResponse response, Exception? exception, in CallTargetState state) |
| 127 | + where TResponse : IReceiveMessageResponse |
| 128 | + { |
| 129 | + if (response.Instance != null && response.Messages != null && response.Messages.Count > 0 && state.State != null) |
| 130 | + { |
| 131 | + var dataStreamsManager = Tracer.Instance.TracerManager.DataStreamsManager; |
| 132 | + if (dataStreamsManager != null && dataStreamsManager.IsEnabled) |
| 133 | + { |
| 134 | + var edgeTags = new[] { "direction:in", $"topic:{(string)state.State}", "type:sqs" }; |
| 135 | + foreach (var o in response.Messages) |
| 136 | + { |
| 137 | + var message = o.DuckCast<IMessage>(); |
| 138 | + if (message == null) |
| 139 | + { |
| 140 | + continue; // should not happen |
| 141 | + } |
| 142 | + |
| 143 | + var sentTime = 0; |
| 144 | + if (message.Attributes != null && message.Attributes.TryGetValue("SentTimestamp", out var sentTimeStr) && sentTimeStr != null) |
| 145 | + { |
| 146 | + int.TryParse(sentTimeStr, out sentTime); |
| 147 | + } |
| 148 | + |
| 149 | + var adapter = AwsSqsHeadersAdapters.GetExtractionAdapter(message.MessageAttributes); |
| 150 | + var parentPathway = dataStreamsManager.ExtractPathwayContext(adapter); |
| 151 | + state.Scope.Span.SetDataStreamsCheckpoint(dataStreamsManager, CheckpointKind.Consume, edgeTags, payloadSizeBytes: 0, sentTime, parentPathway); |
| 152 | + } |
| 153 | + } |
| 154 | + } |
| 155 | + |
| 156 | + state.Scope.DisposeWithException(exception); |
| 157 | + return response; |
| 158 | + } |
| 159 | + |
| 160 | + public class SendType |
| 161 | + { |
| 162 | + public static readonly SendType SingleMessage = new("SendMessage"); |
| 163 | + |
| 164 | + public static readonly SendType Batch = new("SendMessageBatch"); |
| 165 | + |
| 166 | + private SendType(string value) |
| 167 | + { |
| 168 | + OperationName = value; |
| 169 | + } |
| 170 | + |
| 171 | + public string OperationName { get; } |
| 172 | + |
| 173 | + public override string ToString() |
| 174 | + { |
| 175 | + return OperationName; |
| 176 | + } |
| 177 | + } |
| 178 | +} |
0 commit comments