Status code and sub status code

Author: pablomartinezbernardo

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/CosmosDb/IResponseHeaders.cs

@@ -0,0 +1,23 @@
+// <copyright file="IResponseHeaders.cs" company="Datadog">
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.
+// </copyright>
+
+#nullable enable
+
+using Datadog.Trace.DuckTyping;
+
+namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.CosmosDb
+{
+    /// <summary>
+    /// Microsoft.Azure.Cosmos.Headers interface for duck typing
+    /// </summary>
+    /// <remarks>
+    /// https://github.com/Azure/azure-cosmos-dotnet-v3/blob/master/Microsoft.Azure.Cosmos/src/Headers/Headers.cs
+    /// </remarks>
+    internal interface IResponseHeaders : IDuckType
+    {
+        [Duck(Name = "SubStatusCodeLiteral")]
+        string? SubStatusCodeLiteral { get; }
+    }
+}

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/CosmosDb/IResponseMessage.cs

@@ -0,0 +1,25 @@
+// <copyright file="IResponseMessage.cs" company="Datadog">
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.
+// </copyright>
+
+#nullable enable
+
+using System.Net;
+using Datadog.Trace.DuckTyping;
+
+namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.CosmosDb
+{
+    /// <summary>
+    /// Microsoft.Azure.Cosmos.ResponseMessage interface for duck typing
+    /// </summary>
+    /// <remarks>
+    /// https://github.com/Azure/azure-cosmos-dotnet-v3/blob/master/Microsoft.Azure.Cosmos/src/Handler/ResponseMessage.cs
+    /// </remarks>
+    internal interface IResponseMessage : IDuckType
+    {
+        HttpStatusCode StatusCode { get; }
+
+        IResponseHeaders Headers { get; }
+    }
+}

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/CosmosDb/RequestInvokerHandlerSendAsyncIntegration.cs

@@ -13,6 +13,7 @@
 using Datadog.Trace.Configuration;
 using Datadog.Trace.DuckTyping;
 using Datadog.Trace.Logging;
+using Datadog.Trace.Tagging;
 using Datadog.Trace.Util;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.CosmosDb;
@@ -102,13 +103,35 @@ internal static CallTargetState OnMethodBegin<TTarget, TContainer>(TTarget insta
         return CallTargetState.GetDefault();
     }
 
-    internal static TReturn OnAsyncMethodEnd<TTarget, TReturn>(
-        TTarget instance,
-        TReturn returnValue,
-        Exception exception,
-        in CallTargetState state)
+    internal static TReturn OnAsyncMethodEnd<TTarget, TReturn>(TTarget instance, TReturn returnValue, Exception exception, in CallTargetState state)
+        where TReturn : IResponseMessage
     {
-        state.Scope?.DisposeWithException(exception);
+        var scope = state.Scope;
+
+        if (scope != null && returnValue.Instance is not null)
+        {
+            try
+            {
+                var tags = (CosmosDbTags)scope.Span.Tags;
+                var statusCode = (int)returnValue.StatusCode;
+                tags.ResponseStatusCode = statusCode.ToString();
+
+                if (returnValue.Headers?.Instance != null)
+                {
+                    var subStatusCode = returnValue.Headers.SubStatusCodeLiteral;
+                    if (!StringUtil.IsNullOrEmpty(subStatusCode))
+                    {
+                        tags.ResponseSubStatusCode = subStatusCode;
+                    }
+                }
+            }
+            catch (Exception ex)
+            {
+                Log.Error(ex, "Error handling CosmosDb response.");
+            }
+        }
+
+        scope?.DisposeWithException(exception);
         return returnValue;
     }
 }

tracer/src/Datadog.Trace/Generated/net461/Datadog.Trace.SourceGenerators/TagListGenerator/CosmosDbTags.g.cs

@@ -26,6 +26,10 @@ partial class CosmosDbTags
         private static ReadOnlySpan<byte> DatabaseIdBytes => new byte[] { 167, 100, 98, 46, 110, 97, 109, 101 };
         // HostBytes = MessagePack.Serialize("out.host");
         private static ReadOnlySpan<byte> HostBytes => new byte[] { 168, 111, 117, 116, 46, 104, 111, 115, 116 };
+        // ResponseStatusCodeBytes = MessagePack.Serialize("db.response.status_code");
+        private static ReadOnlySpan<byte> ResponseStatusCodeBytes => new byte[] { 183, 100, 98, 46, 114, 101, 115, 112, 111, 110, 115, 101, 46, 115, 116, 97, 116, 117, 115, 95, 99, 111, 100, 101 };
+        // ResponseSubStatusCodeBytes = MessagePack.Serialize("cosmosdb.response.sub_status_code");
+        private static ReadOnlySpan<byte> ResponseSubStatusCodeBytes => new byte[] { 217, 33, 99, 111, 115, 109, 111, 115, 100, 98, 46, 114, 101, 115, 112, 111, 110, 115, 101, 46, 115, 117, 98, 95, 115, 116, 97, 116, 117, 115, 95, 99, 111, 100, 101 };
 
         public override string? GetTag(string key)
         {
@@ -37,6 +41,8 @@ partial class CosmosDbTags
                 "cosmosdb.container" => ContainerId,
                 "db.name" => DatabaseId,
                 "out.host" => Host,
+                "db.response.status_code" => ResponseStatusCode,
+                "cosmosdb.response.sub_status_code" => ResponseSubStatusCode,
                 _ => base.GetTag(key),
             };
         }
@@ -54,6 +60,12 @@ public override void SetTag(string key, string value)
                 case "out.host": 
                     Host = value;
                     break;
+                case "db.response.status_code": 
+                    ResponseStatusCode = value;
+                    break;
+                case "cosmosdb.response.sub_status_code": 
+                    ResponseSubStatusCode = value;
+                    break;
                 case "span.kind": 
                 case "component": 
                 case "db.type": 
@@ -97,6 +109,16 @@ public override void EnumerateTags<TProcessor>(ref TProcessor processor)
                 processor.Process(new TagItem<string>("out.host", Host, HostBytes));
             }
 
+            if (ResponseStatusCode is not null)
+            {
+                processor.Process(new TagItem<string>("db.response.status_code", ResponseStatusCode, ResponseStatusCodeBytes));
+            }
+
+            if (ResponseSubStatusCode is not null)
+            {
+                processor.Process(new TagItem<string>("cosmosdb.response.sub_status_code", ResponseSubStatusCode, ResponseSubStatusCodeBytes));
+            }
+
             base.EnumerateTags(ref processor);
         }
 
@@ -144,6 +166,20 @@ protected override void WriteAdditionalTags(System.Text.StringBuilder sb)
                   .Append(',');
             }
 
+            if (ResponseStatusCode is not null)
+            {
+                sb.Append("db.response.status_code (tag):")
+                  .Append(ResponseStatusCode)
+                  .Append(',');
+            }
+
+            if (ResponseSubStatusCode is not null)
+            {
+                sb.Append("cosmosdb.response.sub_status_code (tag):")
+                  .Append(ResponseSubStatusCode)
+                  .Append(',');
+            }
+
             base.WriteAdditionalTags(sb);
         }
     }

tracer/src/Datadog.Trace/Generated/net6.0/Datadog.Trace.SourceGenerators/TagListGenerator/CosmosDbTags.g.cs

@@ -26,6 +26,10 @@ partial class CosmosDbTags
         private static ReadOnlySpan<byte> DatabaseIdBytes => new byte[] { 167, 100, 98, 46, 110, 97, 109, 101 };
         // HostBytes = MessagePack.Serialize("out.host");
         private static ReadOnlySpan<byte> HostBytes => new byte[] { 168, 111, 117, 116, 46, 104, 111, 115, 116 };
+        // ResponseStatusCodeBytes = MessagePack.Serialize("db.response.status_code");
+        private static ReadOnlySpan<byte> ResponseStatusCodeBytes => new byte[] { 183, 100, 98, 46, 114, 101, 115, 112, 111, 110, 115, 101, 46, 115, 116, 97, 116, 117, 115, 95, 99, 111, 100, 101 };
+        // ResponseSubStatusCodeBytes = MessagePack.Serialize("cosmosdb.response.sub_status_code");
+        private static ReadOnlySpan<byte> ResponseSubStatusCodeBytes => new byte[] { 217, 33, 99, 111, 115, 109, 111, 115, 100, 98, 46, 114, 101, 115, 112, 111, 110, 115, 101, 46, 115, 117, 98, 95, 115, 116, 97, 116, 117, 115, 95, 99, 111, 100, 101 };
 
         public override string? GetTag(string key)
         {
@@ -37,6 +41,8 @@ partial class CosmosDbTags
                 "cosmosdb.container" => ContainerId,
                 "db.name" => DatabaseId,
                 "out.host" => Host,
+                "db.response.status_code" => ResponseStatusCode,
+                "cosmosdb.response.sub_status_code" => ResponseSubStatusCode,
                 _ => base.GetTag(key),
             };
         }
@@ -54,6 +60,12 @@ public override void SetTag(string key, string value)
                 case "out.host": 
                     Host = value;
                     break;
+                case "db.response.status_code": 
+                    ResponseStatusCode = value;
+                    break;
+                case "cosmosdb.response.sub_status_code": 
+                    ResponseSubStatusCode = value;
+                    break;
                 case "span.kind": 
                 case "component": 
                 case "db.type": 
@@ -97,6 +109,16 @@ public override void EnumerateTags<TProcessor>(ref TProcessor processor)
                 processor.Process(new TagItem<string>("out.host", Host, HostBytes));
             }
 
+            if (ResponseStatusCode is not null)
+            {
+                processor.Process(new TagItem<string>("db.response.status_code", ResponseStatusCode, ResponseStatusCodeBytes));
+            }
+
+            if (ResponseSubStatusCode is not null)
+            {
+                processor.Process(new TagItem<string>("cosmosdb.response.sub_status_code", ResponseSubStatusCode, ResponseSubStatusCodeBytes));
+            }
+
             base.EnumerateTags(ref processor);
         }
 
@@ -144,6 +166,20 @@ protected override void WriteAdditionalTags(System.Text.StringBuilder sb)
                   .Append(',');
             }
 
+            if (ResponseStatusCode is not null)
+            {
+                sb.Append("db.response.status_code (tag):")
+                  .Append(ResponseStatusCode)
+                  .Append(',');
+            }
+
+            if (ResponseSubStatusCode is not null)
+            {
+                sb.Append("cosmosdb.response.sub_status_code (tag):")
+                  .Append(ResponseSubStatusCode)
+                  .Append(',');
+            }
+
             base.WriteAdditionalTags(sb);
         }
     }

tracer/src/Datadog.Trace/Generated/netcoreapp3.1/Datadog.Trace.SourceGenerators/TagListGenerator/CosmosDbTags.g.cs

@@ -26,6 +26,10 @@ partial class CosmosDbTags
         private static ReadOnlySpan<byte> DatabaseIdBytes => new byte[] { 167, 100, 98, 46, 110, 97, 109, 101 };
         // HostBytes = MessagePack.Serialize("out.host");
         private static ReadOnlySpan<byte> HostBytes => new byte[] { 168, 111, 117, 116, 46, 104, 111, 115, 116 };
+        // ResponseStatusCodeBytes = MessagePack.Serialize("db.response.status_code");
+        private static ReadOnlySpan<byte> ResponseStatusCodeBytes => new byte[] { 183, 100, 98, 46, 114, 101, 115, 112, 111, 110, 115, 101, 46, 115, 116, 97, 116, 117, 115, 95, 99, 111, 100, 101 };
+        // ResponseSubStatusCodeBytes = MessagePack.Serialize("cosmosdb.response.sub_status_code");
+        private static ReadOnlySpan<byte> ResponseSubStatusCodeBytes => new byte[] { 217, 33, 99, 111, 115, 109, 111, 115, 100, 98, 46, 114, 101, 115, 112, 111, 110, 115, 101, 46, 115, 117, 98, 95, 115, 116, 97, 116, 117, 115, 95, 99, 111, 100, 101 };
 
         public override string? GetTag(string key)
         {
@@ -37,6 +41,8 @@ partial class CosmosDbTags
                 "cosmosdb.container" => ContainerId,
                 "db.name" => DatabaseId,
                 "out.host" => Host,
+                "db.response.status_code" => ResponseStatusCode,
+                "cosmosdb.response.sub_status_code" => ResponseSubStatusCode,
                 _ => base.GetTag(key),
             };
         }
@@ -54,6 +60,12 @@ public override void SetTag(string key, string value)
                 case "out.host": 
                     Host = value;
                     break;
+                case "db.response.status_code": 
+                    ResponseStatusCode = value;
+                    break;
+                case "cosmosdb.response.sub_status_code": 
+                    ResponseSubStatusCode = value;
+                    break;
                 case "span.kind": 
                 case "component": 
                 case "db.type": 
@@ -97,6 +109,16 @@ public override void EnumerateTags<TProcessor>(ref TProcessor processor)
                 processor.Process(new TagItem<string>("out.host", Host, HostBytes));
             }
 
+            if (ResponseStatusCode is not null)
+            {
+                processor.Process(new TagItem<string>("db.response.status_code", ResponseStatusCode, ResponseStatusCodeBytes));
+            }
+
+            if (ResponseSubStatusCode is not null)
+            {
+                processor.Process(new TagItem<string>("cosmosdb.response.sub_status_code", ResponseSubStatusCode, ResponseSubStatusCodeBytes));
+            }
+
             base.EnumerateTags(ref processor);
         }
 
@@ -144,6 +166,20 @@ protected override void WriteAdditionalTags(System.Text.StringBuilder sb)
                   .Append(',');
             }
 
+            if (ResponseStatusCode is not null)
+            {
+                sb.Append("db.response.status_code (tag):")
+                  .Append(ResponseStatusCode)
+                  .Append(',');
+            }
+
+            if (ResponseSubStatusCode is not null)
+            {
+                sb.Append("cosmosdb.response.sub_status_code (tag):")
+                  .Append(ResponseSubStatusCode)
+                  .Append(',');
+            }
+
             base.WriteAdditionalTags(sb);
         }
     }

tracer/src/Datadog.Trace/Generated/netstandard2.0/Datadog.Trace.SourceGenerators/TagListGenerator/CosmosDbTags.g.cs

@@ -26,6 +26,10 @@ partial class CosmosDbTags
         private static ReadOnlySpan<byte> DatabaseIdBytes => new byte[] { 167, 100, 98, 46, 110, 97, 109, 101 };
         // HostBytes = MessagePack.Serialize("out.host");
         private static ReadOnlySpan<byte> HostBytes => new byte[] { 168, 111, 117, 116, 46, 104, 111, 115, 116 };
+        // ResponseStatusCodeBytes = MessagePack.Serialize("db.response.status_code");
+        private static ReadOnlySpan<byte> ResponseStatusCodeBytes => new byte[] { 183, 100, 98, 46, 114, 101, 115, 112, 111, 110, 115, 101, 46, 115, 116, 97, 116, 117, 115, 95, 99, 111, 100, 101 };
+        // ResponseSubStatusCodeBytes = MessagePack.Serialize("cosmosdb.response.sub_status_code");
+        private static ReadOnlySpan<byte> ResponseSubStatusCodeBytes => new byte[] { 217, 33, 99, 111, 115, 109, 111, 115, 100, 98, 46, 114, 101, 115, 112, 111, 110, 115, 101, 46, 115, 117, 98, 95, 115, 116, 97, 116, 117, 115, 95, 99, 111, 100, 101 };
 
         public override string? GetTag(string key)
         {
@@ -37,6 +41,8 @@ partial class CosmosDbTags
                 "cosmosdb.container" => ContainerId,
                 "db.name" => DatabaseId,
                 "out.host" => Host,
+                "db.response.status_code" => ResponseStatusCode,
+                "cosmosdb.response.sub_status_code" => ResponseSubStatusCode,
                 _ => base.GetTag(key),
             };
         }
@@ -54,6 +60,12 @@ public override void SetTag(string key, string value)
                 case "out.host": 
                     Host = value;
                     break;
+                case "db.response.status_code": 
+                    ResponseStatusCode = value;
+                    break;
+                case "cosmosdb.response.sub_status_code": 
+                    ResponseSubStatusCode = value;
+                    break;
                 case "span.kind": 
                 case "component": 
                 case "db.type": 
@@ -97,6 +109,16 @@ public override void EnumerateTags<TProcessor>(ref TProcessor processor)
                 processor.Process(new TagItem<string>("out.host", Host, HostBytes));
             }
 
+            if (ResponseStatusCode is not null)
+            {
+                processor.Process(new TagItem<string>("db.response.status_code", ResponseStatusCode, ResponseStatusCodeBytes));
+            }
+
+            if (ResponseSubStatusCode is not null)
+            {
+                processor.Process(new TagItem<string>("cosmosdb.response.sub_status_code", ResponseSubStatusCode, ResponseSubStatusCodeBytes));
+            }
+
             base.EnumerateTags(ref processor);
         }
 
@@ -144,6 +166,20 @@ protected override void WriteAdditionalTags(System.Text.StringBuilder sb)
                   .Append(',');
             }
 
+            if (ResponseStatusCode is not null)
+            {
+                sb.Append("db.response.status_code (tag):")
+                  .Append(ResponseStatusCode)
+                  .Append(',');
+            }
+
+            if (ResponseSubStatusCode is not null)
+            {
+                sb.Append("cosmosdb.response.sub_status_code (tag):")
+                  .Append(ResponseSubStatusCode)
+                  .Append(',');
+            }
+
             base.WriteAdditionalTags(sb);
         }
     }

tracer/src/Datadog.Trace/Tagging/CosmosDbTags.cs

@@ -31,6 +31,12 @@ internal partial class CosmosDbTags : InstrumentationTags
         [Tag(Trace.Tags.OutHost)]
         public string Host { get; set; }
 
+        [Tag(Trace.Tags.DbResponseStatusCode)]
+        public string ResponseStatusCode { get; set; }
+
+        [Tag(Trace.Tags.CosmosDbResponseSubStatusCode)]
+        public string ResponseSubStatusCode { get; set; }
+
         public virtual void SetEndpoint(Uri endpoint)
         {
             Host = endpoint?.ToString();