Step 1 - Use new Activity to Replace OT Span

NuGet.config

@@ -1,8 +1,9 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <configuration>
   <packageSources>
     <clear />
     <add key="NuGet" value="https://api.nuget.org/v3/index.json" />
+    <add key="LocalDiagSource" value="C:\repos\tempnuget" />
   </packageSources>
   <disabledPackageSources />
 </configuration>

samples/Exporters/Console/Program.cs

@@ -38,7 +38,7 @@ public class Program
         /// <param name="args">Arguments from command line.</param>
         public static void Main(string[] args)
         {
-            Parser.Default.ParseArguments<JaegerOptions, ZipkinOptions, ApplicationInsightsOptions, PrometheusOptions, HttpClientOptions, StackdriverOptions, LightStepOptions, ZPagesOptions, ConsoleOptions, OtlpOptions>(args)
+            Parser.Default.ParseArguments<JaegerOptions, ZipkinOptions, ApplicationInsightsOptions, PrometheusOptions, HttpClientOptions, StackdriverOptions, LightStepOptions, ZPagesOptions, ConsoleOptions, ConsoleActivityOptions, OtlpOptions>(args)
                 .MapResult(
                     (JaegerOptions options) => TestJaeger.Run(options.Host, options.Port),
                     (ZipkinOptions options) => TestZipkin.Run(options.Uri),
@@ -50,6 +50,7 @@ public static void Main(string[] args)
                     (LightStepOptions options) => TestLightstep.Run(options.AccessToken),
                     (ZPagesOptions options) => TestZPages.Run(),
                     (ConsoleOptions options) => TestConsole.Run(options),
+                    (ConsoleActivityOptions options) => TestConsoleActvity.Run(options),
                     (OtlpOptions options) => TestOtlp.Run(options.Endpoint),
                     errs => 1);
 
@@ -127,7 +128,14 @@ internal class ZPagesOptions
     [Verb("console", HelpText = "Specify the options required to test console exporter")]
     internal class ConsoleOptions
     {
-        [Option('p', "pretty", HelpText = "Specify if the output should be pretty printed (default: false)", Default = false)]
+        [Option('p', "pretty", HelpText = "Specify if the output should be pretty printed (default: false)", Default = true)]
+        public bool Pretty { get; set; }
+    }
+
+    [Verb("consoleactivity", HelpText = "Specify the options required to test console activity exporter")]
+    internal class ConsoleActivityOptions
+    {
+        [Option('p', "pretty", HelpText = "Specify if the output should be pretty printed (default: false)", Default = true)]
         public bool Pretty { get; set; }
     }
 

samples/Exporters/Console/TestConsoleActivity.cs

@@ -0,0 +1,47 @@
+// <auto-generated/>
+
+using OpenTelemetry.Trace.Configuration;
+using OpenTelemetry.Exporter.Console;
+using OpenTelemetry.Trace;
+using System.Diagnostics;
+using OpenTelemetry.Trace.Export;
+
+namespace Samples
+{
+    internal class TestConsoleActvity
+    {
+        internal static object Run(ConsoleActivityOptions options)
+        {
+            // Setup exporter
+            var exporterOptions = new ConsoleExporterOptions
+            {
+                Pretty = options.Pretty
+            };
+            var activityExporter = new ConsoleActivityExporter(exporterOptions);
+
+            // Setup processor
+            var activityProcessor = new SimpleActivityProcessor(activityExporter);
+
+            // Enable OpenTelemetry for the "source" named "DemoSource".
+            OpenTelemetrySDK.EnableOpenTelemetry("DemoSource", activityProcessor);
+
+            // Everything above this line is required only in Applications
+            // which decide to use OT.
+
+            // The following is generating activity.
+            // A library would simply write the following line of code.
+            var source = new ActivitySource("DemoSource");
+            using (var parent = source.StartActivity("parent"))
+            {
+                parent?.AddTag("parent location", "parent location");
+
+                using (var child = source.StartActivity("child"))
+                {
+                    child?.AddTag("child location", "child location");
+                }
+            }
+
+            return null;
+        }
+    }
+}

src/OpenTelemetry.Api/OpenTelemetry.Api.csproj

@@ -19,7 +19,7 @@
   </PropertyGroup>
   -->
   <ItemGroup>
-    <PackageReference Include="System.Diagnostics.DiagnosticSource" Version="4.6.0" />
+    <PackageReference Include="System.Diagnostics.DiagnosticSource" Version="5.0.0-dev" />
   </ItemGroup>
 
 </Project>

src/OpenTelemetry.Exporter.Console/ConsoleActivityExporter.cs

@@ -0,0 +1,58 @@
+// <copyright file="ConsoleActivityExporter.cs" company="OpenTelemetry Authors">
+// Copyright 2018, OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using System.Threading;
+using System.Threading.Tasks;
+using OpenTelemetry.Trace.Export;
+
+namespace OpenTelemetry.Exporter.Console
+{
+    public class ConsoleActivityExporter : ActivityExporter
+    {
+        private readonly JsonSerializerOptions serializerOptions;
+
+        public ConsoleActivityExporter(ConsoleExporterOptions options)
+        {
+            this.serializerOptions = new JsonSerializerOptions
+            {
+                WriteIndented = options.Pretty,
+            };
+
+            this.serializerOptions.Converters.Add(new JsonStringEnumConverter());
+            this.serializerOptions.Converters.Add(new ActivitySpanIdConverter());
+            this.serializerOptions.Converters.Add(new ActivityTraceIdConverter());
+        }
+
+        public override Task<ExportResult> ExportAsync(IEnumerable<Activity> batch, CancellationToken cancellationToken)
+        {
+            foreach (var span in batch)
+            {
+                System.Console.WriteLine(JsonSerializer.Serialize(span, this.serializerOptions));
+            }
+
+            return Task.FromResult(ExportResult.Success);
+        }
+
+        public override Task ShutdownAsync(CancellationToken cancellationToken)
+        {
+            return Task.CompletedTask;
+        }
+    }
+}

src/OpenTelemetry/OpenTelemetry.csproj

@@ -21,6 +21,7 @@
 
   <ItemGroup>
     <PackageReference Include="System.Collections.Immutable" Version="1.4.0" />
+    <PackageReference Include="System.Diagnostics.DiagnosticSource" Version="5.0.0-dev" />
     <PackageReference Include="System.Reflection.Emit.Lightweight" Version="4.7.0" />
   </ItemGroup>
 

src/OpenTelemetry/Trace/Configuration/OpenTelemetrySDK.cs

@@ -0,0 +1,40 @@
+// <copyright file="OpenTelemetrySDK.cs" company="OpenTelemetry Authors">
+// Copyright 2018, OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+using System.Diagnostics;
+using OpenTelemetry.Trace.Export;
+
+namespace OpenTelemetry.Trace.Configuration
+{
+    public class OpenTelemetrySDK
+    {
+        static OpenTelemetrySDK()
+        {
+            Activity.DefaultIdFormat = ActivityIdFormat.W3C;
+            Activity.ForceDefaultIdFormat = true;
+        }
+
+        public static void EnableOpenTelemetry(string source, ActivityProcessor activityProcessor)
+        {
+            ActivitySource.AddActivityListener(
+            activitySource => activitySource.Name.Equals(source),
+            (activitySource, name, kind, context, tags, links) => ActivityDataRequest.AllData,
+            (activitySource, name, kind, parentId, tags, links) => ActivityDataRequest.AllData,
+            activityProcessor.OnStart,
+            activityProcessor.OnEnd);
+        }
+    }
+}

src/OpenTelemetry/Trace/Export/ActivityExporter.cs

@@ -0,0 +1,61 @@
+// <copyright file="ActivityExporter.cs" company="OpenTelemetry Authors">
+// Copyright 2018, OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace OpenTelemetry.Trace.Export
+{
+    /// <summary>
+    /// ActivityExporter base class.
+    /// </summary>
+    public abstract class ActivityExporter
+    {
+        public enum ExportResult
+        {
+            /// <summary>
+            /// Batch is successfully exported.
+            /// </summary>
+            Success = 0,
+
+            /// <summary>
+            /// Batch export failed. Caller must not retry.
+            /// </summary>
+            FailedNotRetryable = 1,
+
+            /// <summary>
+            /// Batch export failed transiently. Caller should record error and may retry.
+            /// </summary>
+            FailedRetryable = 2,
+        }
+
+        /// <summary>
+        /// Exports batch of activities asynchronously.
+        /// </summary>
+        /// <param name="batch">Batch of activities to export.</param>
+        /// <param name="cancellationToken">Cancellation token.</param>
+        /// <returns>Result of export.</returns>
+        public abstract Task<ExportResult> ExportAsync(IEnumerable<Activity> batch, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Shuts down exporter asynchronously.
+        /// </summary>
+        /// <param name="cancellationToken">Cancellation token.</param>
+        /// <returns>Returns <see cref="Task"/>.</returns>
+        public abstract Task ShutdownAsync(CancellationToken cancellationToken);
+    }
+}

src/OpenTelemetry/Trace/Export/ActivityProcessor.cs

@@ -0,0 +1,46 @@
+// <copyright file="ActivityProcessor.cs" company="OpenTelemetry Authors">
+// Copyright 2018, OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+using System.Diagnostics;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace OpenTelemetry.Trace.Export
+{
+    /// <summary>
+    /// Activity processor base class.
+    /// </summary>
+    public abstract class ActivityProcessor
+    {
+        /// <summary>
+        /// Span Activity hook.
+        /// </summary>
+        /// <param name="activity">Instance of span to process.</param>
+        public abstract void OnStart(Activity activity);
+
+        /// <summary>
+        /// Span Activity hook.
+        /// </summary>
+        /// <param name="activity">Instance of Span to process.</param>
+        public abstract void OnEnd(Activity activity);
+
+        /// <summary>
+        /// Shuts down Activity processor asynchronously.
+        /// </summary>
+        /// <param name="cancellationToken">Cancellation token.</param>
+        /// <returns>Returns <see cref="Task"/>.</returns>
+        public abstract Task ShutdownAsync(CancellationToken cancellationToken);
+    }
+}