TraceUtils.SourceGenerator 0.0.3

There is a newer version of this package available.
See the version list below for details.
dotnet add package TraceUtils.SourceGenerator --version 0.0.3
                    
NuGet\Install-Package TraceUtils.SourceGenerator -Version 0.0.3
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TraceUtils.SourceGenerator" Version="0.0.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="TraceUtils.SourceGenerator" Version="0.0.3" />
                    
Directory.Packages.props
<PackageReference Include="TraceUtils.SourceGenerator" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add TraceUtils.SourceGenerator --version 0.0.3
                    
#r "nuget: TraceUtils.SourceGenerator, 0.0.3"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package TraceUtils.SourceGenerator@0.0.3
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=TraceUtils.SourceGenerator&version=0.0.3
                    
Install as a Cake Addin
#tool nuget:?package=TraceUtils.SourceGenerator&version=0.0.3
                    
Install as a Cake Tool

OpenTelemetrySourceGenerator

A source generator that creates extension methods to wrap interface calls with tracing (Activity/span).

What’s in the repository

  • sources/TraceUtils – attributes and runtime utilities.
  • sources/TraceUtils.SourceGenerator – Roslyn Source Generator.
  • sources/TraceUtils.SourceGenerator.Tests – generator tests (NUnit + Verify snapshots).

How to use

1. Project setup

Add the following NuGet references to the project:

  • TraceUtils
  • TraceUtils.SourceGenerator
  • OpenTelemetry (official .NET SDK)

2. Interface annotations

  • On methods: [ActivityOperation("OperationName", ActivityType.Internal)] — defines the operation name and activity type.
  • On arguments: [SpanTag("tag.name")] or [SpanTag("tag.name", shouldSerialize: true)] — writes parameters to the span as tags (the second option serializes complex types).

3. Calling generated methods

The generator creates extension methods in TraceUtils.Extensions:

  • sync: MethodNameWithTrace(...)
  • async: MethodNameWithTraceAsync(...)

Instead of calling _service.Method(...) directly, call _service.MethodWithTrace(...) so the invocation is captured in a span.

4. Registration in OpenTelemetry

When configuring OpenTelemetry TracerProvider, register the activity source from TraceUtils (via AddSource(TraceUtils.Utils.ServiceName)) so that generated spans are exported by the selected exporter.

using OpenTelemetry;
using OpenTelemetry.Trace;

// When configuring the trace provider:
builder.Services.AddOpenTelemetry()
    .WithTracing(tracing => tracing
        .AddSource(TraceUtils.Utils.ServiceName)
        .AddYourExporter(...));
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.