Example and docs for .NET span profiles

docs/sources/configure-client/trace-span-profiles/_index.md

@@ -21,10 +21,11 @@ Key benefits and features:
 Get started:
 
 - Configure Pyroscope: Begin sending profiling data to unlock the full potential of Span Profiles
-- Client-Side Packages: Easily link traces and profiles using available packages for Go, Ruby, and Java
+- Client-Side Packages: Easily link traces and profiles using available packages for Go, Java, Ruby and .NET
   - Go: [Span profiles with Traces to profiles (Go)]({{< relref "./go-span-profiles" >}})
   - Java: [Span profiles with Traces to profiles (Java)]({{< relref "./java-span-profiles" >}})
   - Ruby: [Span profiles with Traces to profiles (Ruby)]({{< relref "./ruby-span-profiles" >}})
+  - .NET: [Span profiles with Traces to profiles (.NET)]({{< relref "./dotnet-span-profiles" >}})
 - Grafana Tempo: Visualize and analyze Span Profiles within the Grafana using a Tempo data source.
 
 To learn more, check out our product announcement blog: [Introducing Span Profiles](/blog/2024/02/06/combining-tracing-and-profiling-for-enhanced-observability-introducing-span-profiles/).

docs/sources/configure-client/trace-span-profiles/dotnet-span-profiles.md

@@ -0,0 +1,72 @@
+---
+title: Span profiles with Traces to profiles for .NET
+menuTitle: Span profiles with Traces to profiles (.NET)
+description: Learn about and configure Span profiles with Traces to profiles in Grafana for .NET applications.
+weight: 103
+---
+
+# Span profiles with Traces to profiles for .NET
+
+![span-profiles screenshot](https://grafana.com/static/img/docs/tempo/profiles/tempo-profiles-Span-link-profile-data-source.png)
+
+## Before you begin
+
+Your applications must be instrumented for profiling and tracing before you can use span profiles.
+
+* Profiling: Your application must be instrumented with Pyroscope's .NET instrumentation library. If you haven't done this yet, please refer to the [.NET]({{< relref "../language-sdks/dotnet" >}}) guide.
+* Tracing: Your application must be instrumented with OpenTelemetry traces. If you haven't done this yet, please refer to the [OpenTelemetry](https://opentelemetry.io/docs/net/getting-started/) guide.
+
+{{< admonition type="note" >}}
+Currently only [OpenTelemetry manual instrumentation](https://opentelemetry.io/docs/languages/net/instrumentation/) is supported for span profiles in .NET.
+This limitation is there because Pyroscope's .NET profiler and OpenTelemetry's auto instrumentation are based on separate .NET CLR profilers.
+{{< /admonition >}}
+
+## OpenTelemetry support
+
+Pyroscope can integrate with distributed tracing systems supporting the [**OpenTelemetry**](https://opentelemetry.io/docs/instrumentation/net/getting-started/) standard which allows you to
+link traces with the profiling data, and find resource usage for specific lines of code for your trace spans
+
+{{< admonition type="note" >}}
+* Only CPU profiling is supported at the moment.
+* Because of how sampling profilers work, spans shorter than the sample interval may not be captured.
+{{< /admonition >}}
+
+
+## Configure the `Pyroscope.Tracing.OpenTelemetry` package
+
+To start collecting Span Profiles for your .NET application, you need to include [Pyroscope.Tracing.OpenTelemetry](https://github.com/grafana/pyroscope-dotnet/tree/main/Pyroscope/Pyroscope.Tracing/Pyroscope.Tracing.OpenTelemetry) in your code.
+
+This package provides a [`SpanProcessor`](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry/BaseProcessor.cs) implementation, which connects the two telemetry signals (traces and profiles) together.
+
+```shell
+dotnet add package Pyroscope.Tracing.OpenTelemetry
+```
+
+Next, we need to create and register the `PyroscopeSpanProcessor`:
+```csharp
+builder.Services.AddOpenTelemetry()
+    .WithTracing(b =>
+    {
+        b
+        .AddAspNetCoreInstrumentation()
+        .AddConsoleExporter()
+        .AddOtlpExporter()
+        .AddProcessor(new PyroscopeSpanProcessor.Builder()
+            .WithRootSpanOnly(true)
+            .Build());
+    });
+```
+
+With the span processor registered, spans created automatically (e.g., for our HTTP handlers) and manually (`ActivitySource.StartActivity()`) will have profiling data associated with them.
+
+```
+
+## View the span profiles in Grafana Tempo
+
+To view the span profiles in Grafana Tempo, you need to have a Grafana instance running and a data source configured to link traces and profiles.
+
+Refer to the [data source configuration documentation](/docs/grafana/datasources/tempo/configure-tempo-data-source) to see how to configure the visualization to link traces with profiles.
+
+## Examples
+
+Check out the [examples](https://github.com/grafana/pyroscope/tree/main/examples/tracing/tempo) directory for a complete demo application of span profiles in multiple languages.

docs/sources/configure-client/trace-span-profiles/java-span-profiles.md

@@ -2,7 +2,7 @@
 title: Span profiles with Traces to profiles for Java
 menuTitle: Span profiles with Traces to profiles (Java)
 description: Learn about and configure Span profiles with Traces to profiles in Grafana for the Java language.
-weight: 100
+weight: 101
 ---
 
 # Span profiles with Traces to profiles for Java
@@ -13,7 +13,7 @@ weight: 100
 
 Your applications must be instrumented for profiling and tracing before you can use span profiles.
 
-* Profiling: Your application must be instrumented with Pyroscope's Java client SDK. If you haven't done this yet, please refer to the [Java ()]({{< relref "../language-sdks/java" >}}) guide.
+* Profiling: Your application must be instrumented with Pyroscope's Java client SDK. If you haven't done this yet, please refer to the [Java]({{< relref "../language-sdks/java" >}}) guide.
 * Tracing: Your application must be instrumented with OpenTelemetry traces. If you haven't done this yet, please refer to the [OpenTelemetry](https://opentelemetry.io/docs/java/getting-started/) guide.
 
 ## OpenTelemetry support

docs/sources/configure-client/trace-span-profiles/ruby-span-profiles.md

@@ -2,7 +2,7 @@
 title: Span profiles with Traces to profiles for Ruby
 menuTitle: Span profiles with Traces to profiles (Ruby)
 description: Learn about and configure Span profiles with Traces to profiles in Grafana for the Ruby language.
-weight: 100
+weight: 102
 ---
 
 # Span profiles with Traces to profiles for Ruby
@@ -13,7 +13,7 @@ weight: 100
 
 Your applications must be instrumented for profiling and tracing before you can use span profiles.
 
-* Profiling: Your application must be instrumented with Pyroscope's Ruby SDK. If you haven't done this yet, please refer to the [Ruby (push mode)]({{< relref "../language-sdks/ruby" >}}) guide.
+* Profiling: Your application must be instrumented with Pyroscope's Ruby SDK. If you haven't done this yet, please refer to the [Ruby]({{< relref "../language-sdks/ruby" >}}) guide.
 * Tracing: Your application must be instrumented with OpenTelemetry traces. If you haven't done this yet, please refer to the [OpenTelemetry](https://opentelemetry.io/docs/ruby/getting-started/) guide.
 
 ## OpenTelemetry support

examples/language-sdk-instrumentation/dotnet/rideshare/docker-compose.yml

@@ -59,4 +59,9 @@ services:
     build:
       context: .
       dockerfile: Dockerfile.load-generator
-
+    depends_on:
+      - pyroscope
+      - us-east
+      - eu-north
+      - ap-south
+      - ap-south-alpine

examples/language-sdk-instrumentation/dotnet/rideshare/example/Example.csproj

@@ -7,6 +7,11 @@
     <Nullable>enable</Nullable>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Pyroscope" Version="0.8.0" />
+    <PackageReference Include="OpenTelemetry.Exporter.Console" Version="1.8.0" />
+    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.8.0" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.8.0" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.8.1" />
+    <PackageReference Include="Pyroscope.Tracing.OpenTelemetry" Version="0.1.0" />
+    <PackageReference Include="System.Diagnostics.DiagnosticSource" Version="8.0.1" />
   </ItemGroup>
 </Project>

examples/language-sdk-instrumentation/dotnet/rideshare/example/Program.cs

@@ -2,16 +2,22 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Threading;
+using System.Collections;
+
 using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.Extensions.DependencyInjection;
 
-namespace Example;
+using OpenTelemetry.Trace;
 
-using System.Collections;
-using Microsoft.AspNetCore.Builder;
+using Pyroscope.Tracing.OpenTelemetry;
+
+namespace Example;
 
 public static class Program
 {
     private static readonly List<FileStream> Files = new();
+    public const string CustomActivitySourceName = "Example.ScooterService";
     public static void Main(string[] args)
     {
         for (int i = 0; i < 1024; i++)
@@ -20,12 +26,28 @@ public static void Main(string[] args)
         }
         object globalLock = new();
         var strings = new List<string>();
+
         var orderService = new OrderService();
         var bikeService = new BikeService(orderService);
         var scooterService = new ScooterService(orderService);
         var carService = new CarService(orderService);
 
-        var app = WebApplication.CreateBuilder(args).Build();
+        var builder = WebApplication.CreateBuilder(args);
+        builder.Services.AddOpenTelemetry()
+            .WithTracing(b =>
+            {
+                b
+                .AddAspNetCoreInstrumentation()
+                .AddSource(CustomActivitySourceName)
+                .AddConsoleExporter()
+                .AddOtlpExporter()
+                .AddProcessor(
+                    new PyroscopeSpanProcessor.Builder()
+                        .WithRootSpanOnly(true)
+                        .Build());
+            });
+        var app = builder.Build();
+
         app.MapGet("/bike", () =>
         {
             bikeService.Order(1);
@@ -99,7 +121,7 @@ public static void Main(string[] args)
                 {
                     throw new Exception("foobar" + i);
                 }
-                catch (Exception e)
+                catch (Exception)
                 {
                 }
             }
@@ -125,4 +147,4 @@ public static void Main(string[] args)
 
         app.Run();
     }
-}
+}

examples/language-sdk-instrumentation/dotnet/rideshare/example/ScooterService.cs

@@ -1,7 +1,11 @@
+using System.Diagnostics;
+
 namespace Example;
 
 internal class ScooterService
 {
+    private static readonly ActivitySource CustomActivity = new(Program.CustomActivitySourceName);
+
     private readonly OrderService _orderService;
 
     public ScooterService(OrderService orderService)
@@ -11,6 +15,25 @@ public ScooterService(OrderService orderService)
 
     public void Order(int searchRadius)
     {
+        using var activity = CustomActivity.StartActivity("OrderScooter");
+        activity?.SetTag("type", "scooter");
+        for (long i = 0; i < 2000000000; i++)
+        {
+        }
+        OrderInternal(searchRadius);
+        DoSomeOtherWork();
+    }
+
+    private void OrderInternal(int searchRadius)
+    {
+        using var activity = CustomActivity.StartActivity("OrderScooterInternal");
         _orderService.FindNearestVehicle(searchRadius, "scooter");
     }
-}
+
+    private void DoSomeOtherWork()
+    {
+        for (long i = 0; i < 1000000000; i++)
+        {
+        }
+    }
+}

examples/language-sdk-instrumentation/dotnet/rideshare/musl.Dockerfile

@@ -22,6 +22,6 @@ ENV PYROSCOPE_PROFILING_ENABLED=1
 ENV PYROSCOPE_PROFILING_ALLOCATION_ENABLED=true
 ENV PYROSCOPE_PROFILING_CONTENTION_ENABLED=true
 ENV PYROSCOPE_PROFILING_EXCEPTION_ENABLED=true
+ENV RIDESHARE_LISTEN_PORT=5000
 
-
-CMD ["dotnet", "/dotnet/example.dll"]
+CMD sh -c "ASPNETCORE_URLS=http://*:${RIDESHARE_LISTEN_PORT} exec dotnet /dotnet/example.dll"

examples/tracing/tempo/docker-compose.yml

@@ -42,6 +42,26 @@ services:
       context: ../../language-sdk-instrumentation/java/rideshare
       dockerfile: Dockerfile.otel-instrumentation
 
+  rideshare-dotnet-eu-west:
+    platform: linux/amd64
+    ports:
+      - 5000
+    hostname: rideshare-dotnet-eu-west
+    environment:
+      <<: *env
+      OTEL_TRACES_EXPORTER: otlp
+      OTEL_EXPORTER_OTLP_ENDPOINT: http://tempo:4317
+      OTEL_SERVICE_NAME: rideshare.dotnet.push.app
+      OTEL_METRICS_EXPORTER: none
+      OTEL_TRACES_SAMPLER: always_on
+      OTEL_PROPAGATORS: tracecontext
+      OTEL_RESOURCE_ATTRIBUTES: host.name=rideshare-dotnet-eu-west
+      PYROSCOPE_LABELS: hostname=rideshare-dotnet-eu-west
+      REGION: eu-west
+    build:
+      context: ../../language-sdk-instrumentation/dotnet/rideshare
+      dockerfile: Dockerfile
+
   load-generator:
     environment: *env
     build:
@@ -52,6 +72,7 @@ services:
       - http://rideshare-go-ap-south:5000
       - http://rideshare-go-eu-north:5000
       - http://rideshare-java-us-east:5000
+      - http://rideshare-dotnet-eu-west:5000
 
   grafana:
     image: grafana/grafana-dev:10.3.0-151740