[Part1] Support Activity Status and status description in Zipkin Exporter.

src/OpenTelemetry.Api/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+* Support Activity Status and status description in Zipkin Exporter.
+ ([#3003](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3003))
+
 ## 1.2.0-rc3
 
 Released 2022-Mar-04

src/OpenTelemetry.Api/Internal/StatusHelper.cs

@@ -15,6 +15,7 @@
 // </copyright>
 
 using System;
+using System.Diagnostics;
 using System.Runtime.CompilerServices;
 using OpenTelemetry.Trace;
 
@@ -43,6 +44,23 @@ public static string GetTagValueForStatusCode(StatusCode statusCode)
             };
         }
 
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public static string GetTagValueForActivityStatusCode(ActivityStatusCode activityStatusCode)
+        {
+            return activityStatusCode switch
+            {
+                /*
+                 * Note: Order here does matter for perf. Unset is
+                 * first because assumption is most spans will be
+                 * Unset, then Error, then Ok.
+                 */
+                ActivityStatusCode.Unset => UnsetStatusCodeTagValue,
+                ActivityStatusCode.Error => ErrorStatusCodeTagValue,
+                ActivityStatusCode.Ok => OkStatusCodeTagValue,
+                _ => null,
+            };
+        }
+
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static StatusCode? GetStatusCodeForTagValue(string statusCodeTagValue)
         {

src/OpenTelemetry.Exporter.Zipkin/Implementation/ZipkinActivityConversionExtensions.cs

@@ -45,7 +45,20 @@ internal static ZipkinSpan ToZipkinSpan(this Activity activity, ZipkinEndpoint l
                 Tags = PooledList<KeyValuePair<string, object>>.Create(),
             };
 
-            activity.EnumerateTags(ref tagState);
+            if (activity.Status == ActivityStatusCode.Ok || activity.Status == ActivityStatusCode.Error)
+            {
+                PooledList<KeyValuePair<string, object>>.Add(
+                    ref tagState.Tags,
+                    new KeyValuePair<string, object>(
+                        SpanAttributeConstants.StatusCodeKey,
+                        StatusHelper.GetTagValueForActivityStatusCode(activity.Status)));
+            }
+            else
+            {
+                // In the rare cases when both ActivityStatus and Status Tags were set,
+                // ActivityStatus takes precedence over status tags.
+                activity.EnumerateTags(ref tagState);
+            }
 
             var activitySource = activity.Source;
             if (!string.IsNullOrEmpty(activitySource.Name))
@@ -72,9 +85,17 @@ internal static ZipkinSpan ToZipkinSpan(this Activity activity, ZipkinEndpoint l
                 }
             }
 
-            if (tagState.StatusCode == StatusCode.Error)
+            // Error flag rule from https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk_exporters/zipkin.md#status
+            if (activity.StatusDescription != null)
+            {
+                PooledList<KeyValuePair<string, object>>.Add(
+                    ref tagState.Tags,
+                    new KeyValuePair<string, object>(
+                        ZipkinErrorFlagTagName,
+                        activity.StatusDescription ?? string.Empty));
+            }
+            else if (tagState.StatusCode == StatusCode.Error)
             {
-                // Error flag rule from https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk_exporters/zipkin.md#status
                 PooledList<KeyValuePair<string, object>>.Add(
                     ref tagState.Tags,
                     new KeyValuePair<string, object>(

test/OpenTelemetry.Exporter.Zipkin.Tests/Implementation/ZipkinActivityConversionTest.cs

@@ -14,6 +14,7 @@
 // limitations under the License.
 // </copyright>
 
+using System.Diagnostics;
 using System.Linq;
 using OpenTelemetry.Exporter.Zipkin.Tests;
 using OpenTelemetry.Internal;
@@ -125,5 +126,74 @@ public void ToZipkinSpan_Status_ErrorFlagTest(StatusCode expectedStatusCode, str
                 Assert.DoesNotContain(zipkinSpan.Tags, t => t.Key == "error");
             }
         }
+
+        [Theory]
+        [InlineData(ActivityStatusCode.Unset)]
+        [InlineData(ActivityStatusCode.Ok)]
+        [InlineData(ActivityStatusCode.Error)]
+        public void ToZipkinSpan_Activity_Status_And_StatusDescription_is_Set(ActivityStatusCode expectedStatusCode)
+        {
+            // Arrange
+            const string description = "Description when ActivityStatusCode is Error.";
+            var activity = ZipkinExporterTests.CreateTestActivity();
+            activity.SetStatus(expectedStatusCode, description);
+
+            // Act
+            var zipkinSpan = activity.ToZipkinSpan(DefaultZipkinEndpoint);
+
+            // Assert
+            if (expectedStatusCode == ActivityStatusCode.Unset)
+            {
+                Assert.DoesNotContain(zipkinSpan.Tags, t => t.Key == SpanAttributeConstants.StatusCodeKey);
+            }
+            else
+            {
+                Assert.Equal(
+                    StatusHelper.GetTagValueForActivityStatusCode(expectedStatusCode),
+                    zipkinSpan.Tags.FirstOrDefault(t => t.Key == SpanAttributeConstants.StatusCodeKey).Value);
+            }
+
+            if (expectedStatusCode == ActivityStatusCode.Error)
+            {
+                Assert.Contains(zipkinSpan.Tags, t => t.Key == "error" && (string)t.Value == description);
+            }
+            else
+            {
+                Assert.DoesNotContain(zipkinSpan.Tags, t => t.Key == "error");
+            }
+        }
+
+        [Theory]
+        [InlineData(ActivityStatusCode.Error, "OK")]
+        [InlineData(ActivityStatusCode.Ok, "ERROR")]
+        public void ActivityStatus_Takes_precedence_Over_Status_Tags(ActivityStatusCode activityStatus, string statusCodeTagValue)
+        {
+            // Arrange
+            const string description = "Description when ActivityStatusCode is Error.";
+            var activity = ZipkinExporterTests.CreateTestActivity();
+
+            activity.SetStatus(activityStatus, description);
+            activity.SetTag(SpanAttributeConstants.StatusCodeKey, statusCodeTagValue);
+
+            // Act
+            var zipkinSpan = activity.ToZipkinSpan(DefaultZipkinEndpoint);
+
+            // Assert
+            Assert.Equal(
+                StatusHelper.GetTagValueForActivityStatusCode(activityStatus),
+                zipkinSpan.Tags.FirstOrDefault(t => t.Key == SpanAttributeConstants.StatusCodeKey).Value);
+
+            if (activityStatus == ActivityStatusCode.Error)
+            {
+                Assert.Contains(zipkinSpan.Tags, t => t.Key == "error" && (string)t.Value == description);
+
+                // ActivityStatusDescription takes higher precedence.
+                Assert.DoesNotContain(zipkinSpan.Tags, t => t.Key == "error" && (string)t.Value == statusCodeTagValue);
+            }
+            else
+            {
+                Assert.DoesNotContain(zipkinSpan.Tags, t => t.Key == "error");
+            }
+        }
     }
 }