Remove config option from tracing libraries (#59)

aleks-p · web-flow · commit cad3d9060200 · 2024-04-17T09:51:08.000-03:00
* Remove config option for tracing libraries

* Improve Pyroscope tracing library helpers naming consistency
diff --git a/.github/workflows/build_tracing_packages.yml b/.github/workflows/build_tracing_packages.yml
@@ -18,7 +18,7 @@ jobs:
         with:
           dotnet-version: '6.0'
       - run: dotnet build -c Release
-        working-directory: Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTracing
+        working-directory: Pyroscope/Pyroscope.OpenTracing
   build-tracing-lib-opentelemetry:
     runs-on: ubuntu-latest
     steps:
@@ -30,4 +30,4 @@ jobs:
         with:
           dotnet-version: '6.0'
       - run: dotnet build -c Release
-        working-directory: Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTelemetry
+        working-directory: Pyroscope/Pyroscope.OpenTelemetry
diff --git a/.github/workflows/tag_tracing_opentelemetry_helper.yml b/.github/workflows/tag_tracing_opentelemetry_helper.yml
@@ -17,16 +17,16 @@ jobs:
         with:
           dotnet-version: '6.0'
       - run: dotnet build -c Release
-        working-directory: Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTelemetry
+        working-directory: Pyroscope/Pyroscope.OpenTelemetry
       - name: Publish the package to nuget.org
         run: dotnet nuget push bin/Release/*.nupkg -k $NUGET_AUTH_TOKEN -s https://api.nuget.org/v3/index.json
-        working-directory: Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTelemetry
+        working-directory: Pyroscope/Pyroscope.OpenTelemetry
         env:
           NUGET_AUTH_TOKEN: ${{ secrets.NUGET_API_KEY }}
       - name: Release
         uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/')
         with:
           files: |
-            ./Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTelemetry/bin/Release/net6.0/Pyroscope.Tracing.OpenTelemetry.dll
-            ./Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTelemetry/bin/Release/Pyroscope.Tracing.OpenTelemetry*.nupkg
+            ./Pyroscope/Pyroscope.OpenTelemetry/bin/Release/net6.0/Pyroscope.OpenTelemetry.dll
+            ./Pyroscope/Pyroscope.OpenTelemetry/bin/Release/Pyroscope.OpenTelemetry*.nupkg
diff --git a/.github/workflows/tag_tracing_opentracing_helper.yml b/.github/workflows/tag_tracing_opentracing_helper.yml
@@ -17,16 +17,16 @@ jobs:
         with:
           dotnet-version: '6.0'
       - run: dotnet build -c Release
-        working-directory: Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTracing
+        working-directory: Pyroscope/Pyroscope.OpenTracing
       - name: Publish the package to nuget.org
         run: dotnet nuget push bin/Release/*.nupkg -k $NUGET_AUTH_TOKEN -s https://api.nuget.org/v3/index.json
-        working-directory: Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTracing
+        working-directory: Pyroscope/Pyroscope.OpenTracing
         env:
           NUGET_AUTH_TOKEN: ${{ secrets.NUGET_API_KEY }}
       - name: Release
         uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/')
         with:
           files: |
-            ./Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTracing/bin/Release/net6.0/Pyroscope.Tracing.OpenTracing.dll
-            ./Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTracing/bin/Release/Pyroscope.Tracing.OpenTracing*.nupkg
+            ./Pyroscope/Pyroscope.OpenTracing/bin/Release/net6.0/Pyroscope.OpenTracing.dll
+            ./Pyroscope/Pyroscope.OpenTracing/bin/Release/Pyroscope.OpenTracing*.nupkg
diff --git a/Pyroscope/Pyroscope.OpenTelemetry/Pyroscope.OpenTelemetry.csproj b/Pyroscope/Pyroscope.OpenTelemetry/Pyroscope.OpenTelemetry.csproj
@@ -5,9 +5,9 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <PackageVersion>0.1.0</PackageVersion>
-    <AssemblyVersion>0.1.0</AssemblyVersion>
-    <FileVersion>0.1.0</FileVersion>
+    <PackageVersion>0.2.0</PackageVersion>
+    <AssemblyVersion>0.2.0</AssemblyVersion>
+    <FileVersion>0.2.0</FileVersion>
     <LangVersion>10</LangVersion>
     <PackageReadmeFile>README.md</PackageReadmeFile>
  </PropertyGroup>
diff --git a/Pyroscope/Pyroscope.OpenTelemetry/Pyroscope.OpenTelemetry.sln b/Pyroscope/Pyroscope.OpenTelemetry/Pyroscope.OpenTelemetry.sln
@@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.5.002.0
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Pyroscope.Tracing.OpenTelemetry", "Pyroscope.Tracing.OpenTelemetry.csproj", "{42160563-B7D4-41D6-89DE-9CEDEEB542AA}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Pyroscope.OpenTelemetry", "Pyroscope.OpenTelemetry.csproj", "{42160563-B7D4-41D6-89DE-9CEDEEB542AA}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
diff --git a/Pyroscope/Pyroscope.OpenTelemetry/PyroscopeSpanProcessor.cs b/Pyroscope/Pyroscope.OpenTelemetry/PyroscopeSpanProcessor.cs
@@ -0,0 +1,46 @@
+﻿using System.Diagnostics;
+using OpenTelemetry;
+
+namespace Pyroscope.OpenTelemetry;
+
+public class PyroscopeSpanProcessor : BaseProcessor<Activity>
+{
+    private const string ProfileIdSpanTagKey = "pyroscope.profile.id";
+
+    public override void OnStart(Activity data)
+    {
+        if (!IsRootSpan(data))
+        {
+            return;
+        }
+
+        try
+        {
+            var spanId = data.SpanId.ToString();
+            var spanIdLong = Convert.ToUInt64(spanId.ToUpper(), 16);
+
+            // Establish a two-way connection between the span and profiling data
+            Profiler.Instance.SetProfileId(spanIdLong);
+            data.AddTag(ProfileIdSpanTagKey, spanId);
+        }
+        catch (Exception ex)
+        {
+            Console.WriteLine($"Caught exception while setting profile id in profiler instance: {ex.Message}");
+        }
+    }
+
+    public override void OnEnd(Activity data)
+    {
+        if (IsRootSpan(data))
+        {
+            Profiler.Instance.SetProfileId(0); // TODO: Replace with ResetContext()
+            return;
+        }
+    }
+
+    private static bool IsRootSpan(Activity data)
+    {
+        var parent = data.Parent;
+        return parent == null || parent.HasRemoteParent;
+    }
+}
diff --git a/Pyroscope/Pyroscope.OpenTelemetry/README.md b/Pyroscope/Pyroscope.OpenTelemetry/README.md
@@ -13,7 +13,7 @@ See https://grafana.com/docs/pyroscope/latest/configure-client/trace-span-profil
 Add the following package to your project:
 
 ```shell
-dotnet add package Pyroscope.Tracing.OpenTelemetry
+dotnet add package Pyroscope.OpenTelemetry
 ```
 
 Register the `PyroscopeSpanProcessor` in your OpenTelemetry integration:
@@ -27,9 +27,7 @@ builder.Services.AddOpenTelemetry()
         .AddAspNetCoreInstrumentation()
         .AddConsoleExporter()
         .AddOtlpExporter()
-        .AddProcessor(new PyroscopeSpanProcessor.Builder()
-            .WithRootSpanOnly(true)
-            .Build());
+        .AddProcessor(new Pyroscope.OpenTelemetry.PyroscopeSpanProcessor());
     });
 
 ```
diff --git a/Pyroscope/Pyroscope.OpenTracing/Pyroscope.OpenTracing.csproj b/Pyroscope/Pyroscope.OpenTracing/Pyroscope.OpenTracing.csproj
@@ -5,9 +5,9 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <PackageVersion>0.1.0</PackageVersion>
-    <AssemblyVersion>0.1.0</AssemblyVersion>
-    <FileVersion>0.1.0</FileVersion>
+    <PackageVersion>0.2.0</PackageVersion>
+    <AssemblyVersion>0.2.0</AssemblyVersion>
+    <FileVersion>0.2.0</FileVersion>
     <LangVersion>10</LangVersion>
     <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
diff --git a/Pyroscope/Pyroscope.OpenTracing/Pyroscope.OpenTracing.sln b/Pyroscope/Pyroscope.OpenTracing/Pyroscope.OpenTracing.sln
@@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.5.002.0
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Pyroscope.Tracing.OpenTracing", "Pyroscope.Tracing.OpenTracing.csproj", "{311866C4-042D-4F43-B025-CC142FDD02B3}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Pyroscope.OpenTracing", "Pyroscope.OpenTracing.csproj", "{311866C4-042D-4F43-B025-CC142FDD02B3}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
diff --git a/Pyroscope/Pyroscope.OpenTracing/PyroscopeSpanBuilder.cs b/Pyroscope/Pyroscope.OpenTracing/PyroscopeSpanBuilder.cs
@@ -1,19 +1,17 @@
 using OpenTracing;
 using OpenTracing.Tag;
 
-namespace Pyroscope.Tracing.OpenTracing;
+namespace Pyroscope.OpenTracing;
 
 public class PyroscopeSpanBuilder : ISpanBuilder
 {
     private const string ProfileIdSpanTagKey = "pyroscope.profile.id";
 
     private readonly ISpanBuilder _delegate;
-    private readonly Config _config;
     private ISpanContext? _parent;
 
-    internal PyroscopeSpanBuilder(Config config, ISpanBuilder spanBuilder, ISpanContext? parent)
+    internal PyroscopeSpanBuilder(ISpanBuilder spanBuilder, ISpanContext? parent)
     {
-        _config = config;
         _delegate = spanBuilder;
         _parent = parent;
     }
@@ -29,19 +27,19 @@ public IScope StartActive()
     {
         var scope = _delegate.StartActive();
         ConnectSpanWithProfiling(scope.Span);
-        return new PyroscopeScope(_config, scope, _parent);
+        return new PyroscopeScope(scope, _parent);
     }
 
     public IScope StartActive(bool finishSpanOnDispose)
     {
         var scope = _delegate.StartActive(finishSpanOnDispose);
         ConnectSpanWithProfiling(scope.Span);
-        return new PyroscopeScope(_config, scope, _parent);
+        return new PyroscopeScope(scope, _parent);
     }
 
     private void ConnectSpanWithProfiling(ISpan span)
     {
-        if (_parent != null && _config.RootSpanOnly)
+        if (_parent != null)
         {
             return;
         }
@@ -139,15 +137,13 @@ public ISpanBuilder IgnoreActiveSpan()
 
     class PyroscopeScope : IScope
     {
-        private readonly Config _config;
         private readonly IScope _delegate;
         private readonly ISpanContext? _parent;
 
         public ISpan Span => _delegate.Span;
 
-        internal PyroscopeScope(Config _config, IScope _delegate, ISpanContext? _parent)
+        internal PyroscopeScope(IScope _delegate, ISpanContext? _parent)
         {
-            this._config = _config;
             this._delegate = _delegate;
             this._parent = _parent;
         }
@@ -160,21 +156,6 @@ public void Dispose()
                 Profiler.Instance.SetProfileId(0); // TODO: Replace with ResetContext()
                 return;
             }
-            if (_config.RootSpanOnly)
-            {
-                return;
-            }
-            try
-            {
-                var spanId = _parent.SpanId;
-                var spanIdLong = Convert.ToUInt64(spanId.ToUpper(), 16);
-
-                Profiler.Instance.SetProfileId(spanIdLong);
-            }
-            catch (Exception ex)
-            {
-                Console.WriteLine($"Caught exception while setting profile id in profiler instance: {ex.Message}");
-            }
         }
     }
 }
diff --git a/Pyroscope/Pyroscope.OpenTracing/PyroscopeTracer.cs b/Pyroscope/Pyroscope.OpenTracing/PyroscopeTracer.cs
@@ -0,0 +1,32 @@
+using OpenTracing;
+using OpenTracing.Propagation;
+
+namespace Pyroscope.OpenTracing;
+
+public class PyroscopeTracer : ITracer
+{
+    private readonly ITracer _delegate;
+    public IScopeManager ScopeManager { get; }
+    public ISpan? ActiveSpan => ScopeManager.Active?.Span;
+
+    public PyroscopeTracer(ITracer tracerDelegate)
+    {
+        _delegate = tracerDelegate;
+        ScopeManager = tracerDelegate.ScopeManager;
+    }
+
+    public ISpanBuilder BuildSpan(string operationName)
+    {
+        return new PyroscopeSpanBuilder(_delegate.BuildSpan(operationName), ActiveSpan?.Context);
+    }
+
+    public void Inject<TCarrier>(ISpanContext spanContext, IFormat<TCarrier> format, TCarrier carrier)
+    {
+        _delegate.Inject(spanContext, format, carrier);
+    }
+
+    public ISpanContext Extract<TCarrier>(IFormat<TCarrier> format, TCarrier carrier)
+    {
+        return _delegate.Extract(format, carrier);
+    }
+}
diff --git a/Pyroscope/Pyroscope.OpenTracing/README.md b/Pyroscope/Pyroscope.OpenTracing/README.md
@@ -13,7 +13,7 @@ See https://grafana.com/docs/pyroscope/latest/configure-client/trace-span-profil
 Add the following package to your project:
 
 ```shell
-dotnet add package Pyroscope.Tracing.OpenTracing
+dotnet add package Pyroscope.OpenTracing
 ```
 
 Wrap your existing tracer with the `PyroscopeTracer` and register it globally:
@@ -25,7 +25,5 @@ var tracingConfig = Configuration.FromEnv(loggerFactory);
 var tracer = tracingConfig.GetTracer();
 
 // wrap the OpenTracing tracer with the PyroscopeTracer and register it
-GlobalTracer.Register(new PyroscopeTracer.Builder(tracer)
-    .WithRootSpanOnly(true)
-    .Build()));
+GlobalTracer.Register(new Pyroscope.OpenTracing.PyroscopeTracer(tracer));
 ```
diff --git a/Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTelemetry/PyroscopeSpanProcessor.cs b/Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTelemetry/PyroscopeSpanProcessor.cs
diff --git a/Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTracing/PyroscopeTracer.cs b/Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTracing/PyroscopeTracer.cs
diff --git a/Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTracing/PyroscopeTracerConfig.cs b/Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTracing/PyroscopeTracerConfig.cs

Original file line number	Diff line number	Diff line change
`@@ -1,19 +1,17 @@`
`1`	`1`	`using OpenTracing;`
`2`	`2`	`using OpenTracing.Tag;`
`3`	`3`
`4`		`-namespace Pyroscope.Tracing.OpenTracing;`
	`4`	`+namespace Pyroscope.OpenTracing;`
`5`	`5`
`6`	`6`	`public class PyroscopeSpanBuilder : ISpanBuilder`
`7`	`7`	`{`
`8`	`8`	`private const string ProfileIdSpanTagKey = "pyroscope.profile.id";`
`9`	`9`
`10`	`10`	`private readonly ISpanBuilder _delegate;`
`11`		`- private readonly Config _config;`
`12`	`11`	`private ISpanContext? _parent;`
`13`	`12`
`14`		`- internal PyroscopeSpanBuilder(Config config, ISpanBuilder spanBuilder, ISpanContext? parent)`
	`13`	`+ internal PyroscopeSpanBuilder(ISpanBuilder spanBuilder, ISpanContext? parent)`
`15`	`14`	`{`
`16`		`- _config = config;`
`17`	`15`	`_delegate = spanBuilder;`
`18`	`16`	`_parent = parent;`
`19`	`17`	`}`
`@@ -29,19 +27,19 @@ public IScope StartActive()`
`29`	`27`	`{`
`30`	`28`	`var scope = _delegate.StartActive();`
`31`	`29`	`ConnectSpanWithProfiling(scope.Span);`
`32`		`- return new PyroscopeScope(_config, scope, _parent);`
	`30`	`+ return new PyroscopeScope(scope, _parent);`
`33`	`31`	`}`
`34`	`32`
`35`	`33`	`public IScope StartActive(bool finishSpanOnDispose)`
`36`	`34`	`{`
`37`	`35`	`var scope = _delegate.StartActive(finishSpanOnDispose);`
`38`	`36`	`ConnectSpanWithProfiling(scope.Span);`
`39`		`- return new PyroscopeScope(_config, scope, _parent);`
	`37`	`+ return new PyroscopeScope(scope, _parent);`
`40`	`38`	`}`
`41`	`39`
`42`	`40`	`private void ConnectSpanWithProfiling(ISpan span)`
`43`	`41`	`{`
`44`		`- if (_parent != null && _config.RootSpanOnly)`
	`42`	`+ if (_parent != null)`
`45`	`43`	`{`
`46`	`44`	`return;`
`47`	`45`	`}`
`@@ -139,15 +137,13 @@ public ISpanBuilder IgnoreActiveSpan()`
`139`	`137`
`140`	`138`	`class PyroscopeScope : IScope`
`141`	`139`	`{`
`142`		`- private readonly Config _config;`
`143`	`140`	`private readonly IScope _delegate;`
`144`	`141`	`private readonly ISpanContext? _parent;`
`145`	`142`
`146`	`143`	`public ISpan Span => _delegate.Span;`
`147`	`144`
`148`		`- internal PyroscopeScope(Config _config, IScope _delegate, ISpanContext? _parent)`
	`145`	`+ internal PyroscopeScope(IScope _delegate, ISpanContext? _parent)`
`149`	`146`	`{`
`150`		`- this._config = _config;`
`151`	`147`	`this._delegate = _delegate;`
`152`	`148`	`this._parent = _parent;`
`153`	`149`	`}`
`@@ -160,21 +156,6 @@ public void Dispose()`
`160`	`156`	`Profiler.Instance.SetProfileId(0); // TODO: Replace with ResetContext()`
`161`	`157`	`return;`
`162`	`158`	`}`
`163`		`- if (_config.RootSpanOnly)`
`164`		`- {`
`165`		`- return;`
`166`		`- }`
`167`		`- try`
`168`		`- {`
`169`		`- var spanId = _parent.SpanId;`
`170`		`- var spanIdLong = Convert.ToUInt64(spanId.ToUpper(), 16);`
`171`		`-`
`172`		`- Profiler.Instance.SetProfileId(spanIdLong);`
`173`		`- }`
`174`		`- catch (Exception ex)`
`175`		`- {`
`176`		`- Console.WriteLine($"Caught exception while setting profile id in profiler instance: {ex.Message}");`
`177`		`- }`
`178`	`159`	`}`
`179`	`160`	`}`
`180`	`161`	`}`