Update metrics sample to use OTLP and OTEL collector

samples/Metrics/MetricsApp.AppHost/MetricsApp.AppHost.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <Sdk Name="Aspire.AppHost.Sdk" Version="9.0.0" />
 
@@ -11,6 +11,8 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <Compile Include="..\..\Shared\DevCertHostingExtensions.cs" Link="DevCertHostingExtensions.cs" />
+
     <PackageReference Include="Aspire.Hosting.AppHost" Version="9.0.0" />
 
     <ProjectReference Include="..\MetricsApp\MetricsApp.csproj" />

samples/Metrics/MetricsApp.AppHost/OpenTelemetryCollector/OpenTelemetryCollectorLifecycleHook.cs

@@ -0,0 +1,43 @@
+using Aspire.Hosting.Lifecycle;
+using Microsoft.Extensions.Logging;
+
+namespace MetricsApp.AppHost.OpenTelemetryCollector;
+
+internal sealed class OpenTelemetryCollectorLifecycleHook : IDistributedApplicationLifecycleHook
+{
+    private readonly ILogger<OpenTelemetryCollectorLifecycleHook> _logger;
+
+    public OpenTelemetryCollectorLifecycleHook(ILogger<OpenTelemetryCollectorLifecycleHook> logger)
+    {
+        _logger = logger;
+    }
+
+    public Task AfterEndpointsAllocatedAsync(DistributedApplicationModel appModel, CancellationToken cancellationToken)
+    {
+        var collectorResource = appModel.Resources.OfType<OpenTelemetryCollectorResource>().FirstOrDefault();
+        if (collectorResource == null)
+        {
+            _logger.LogWarning($"No {nameof(OpenTelemetryCollectorResource)} resource found.");
+            return Task.CompletedTask;
+        }
+
+        var endpoint = collectorResource.GetEndpoint(OpenTelemetryCollectorResource.OtlpGrpcEndpointName);
+        if (!endpoint.Exists)
+        {
+            _logger.LogWarning($"No {OpenTelemetryCollectorResource.OtlpGrpcEndpointName} endpoint for the collector.");
+            return Task.CompletedTask;
+        }
+
+        foreach (var resource in appModel.GetProjectResources())
+        {
+            _logger.LogDebug("Forwarding telemetry for {ResourceName} to the collector.", resource.Name);
+
+            resource.Annotations.Add(new EnvironmentCallbackAnnotation((EnvironmentCallbackContext context) =>
+            {
+                context.EnvironmentVariables["OTEL_EXPORTER_OTLP_ENDPOINT"] = endpoint;
+            }));
+        }
+
+        return Task.CompletedTask;
+    }
+}

samples/Metrics/MetricsApp.AppHost/OpenTelemetryCollector/OpenTelemetryCollectorResource.cs

@@ -0,0 +1,7 @@
+namespace MetricsApp.AppHost.OpenTelemetryCollector;
+
+public class OpenTelemetryCollectorResource(string name) : ContainerResource(name)
+{
+    internal const string OtlpGrpcEndpointName = "grpc";
+    internal const string OtlpHttpEndpointName = "http";
+}

samples/Metrics/MetricsApp.AppHost/OpenTelemetryCollector/OpenTelemetryCollectorResourceBuilderExtensions.cs

@@ -0,0 +1,45 @@
+using Microsoft.Extensions.Hosting;
+
+namespace MetricsApp.AppHost.OpenTelemetryCollector;
+
+public static class OpenTelemetryCollectorResourceBuilderExtensions
+{
+    private const string DashboardOtlpUrlVariableName = "DOTNET_DASHBOARD_OTLP_ENDPOINT_URL";
+    private const string DashboardOtlpApiKeyVariableName = "AppHost:OtlpApiKey";
+    private const string DashboardOtlpUrlDefaultValue = "http://localhost:18889";
+
+    public static IResourceBuilder<OpenTelemetryCollectorResource> AddOpenTelemetryCollector(this IDistributedApplicationBuilder builder, string name, string configFileLocation)
+    {
+        builder.AddOpenTelemetryCollectorInfrastructure();
+
+        var url = builder.Configuration[DashboardOtlpUrlVariableName] ?? DashboardOtlpUrlDefaultValue;
+        var isHttpsEnabled = url.StartsWith("https", StringComparison.OrdinalIgnoreCase);
+
+        var dashboardOtlpEndpoint = new HostUrl(url);
+
+        var resource = new OpenTelemetryCollectorResource(name);
+        var resourceBuilder = builder.AddResource(resource)
+            .WithImage("ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib", "latest")
+            .WithEndpoint(targetPort: 4317, name: OpenTelemetryCollectorResource.OtlpGrpcEndpointName, scheme: isHttpsEnabled ? "https" : "http")
+            .WithEndpoint(targetPort: 4318, name: OpenTelemetryCollectorResource.OtlpHttpEndpointName, scheme: isHttpsEnabled ? "https" : "http")
+            .WithBindMount(configFileLocation, "/etc/otelcol-contrib/config.yaml")
+            .WithEnvironment("ASPIRE_ENDPOINT", $"{dashboardOtlpEndpoint}")
+            .WithEnvironment("ASPIRE_API_KEY", builder.Configuration[DashboardOtlpApiKeyVariableName])
+            .WithEnvironment("ASPIRE_INSECURE", isHttpsEnabled ? "false" : "true");
+
+        if (isHttpsEnabled && builder.ExecutionContext.IsRunMode && builder.Environment.IsDevelopment())
+        {
+            DevCertHostingExtensions.RunWithHttpsDevCertificate(resourceBuilder, "HTTPS_CERT_FILE", "HTTPS_CERT_KEY_FILE", (certFilePath, certKeyPath) =>
+            {
+                // Set TLS details using YAML path via the command line. This allows the values to be added to the existing config file.
+                // Setting the values in the config file doesn't work because adding the "tls" section always enables TLS, even if there is no cert provided.
+                resourceBuilder.WithArgs(
+                    @"--config=yaml:receivers::otlp::protocols::grpc::tls::cert_file: ""dev-certs/dev-cert.pem""",
+                    @"--config=yaml:receivers::otlp::protocols::grpc::tls::key_file: ""dev-certs/dev-cert.key""",
+                    @"--config=/etc/otelcol-contrib/config.yaml");
+            });
+        }
+
+        return resourceBuilder;
+    }
+}

samples/Metrics/MetricsApp.AppHost/OpenTelemetryCollector/OpenTelemetryCollectorServiceExtensions.cs

@@ -0,0 +1,13 @@
+using Aspire.Hosting.Lifecycle;
+
+namespace MetricsApp.AppHost.OpenTelemetryCollector;
+
+internal static class OpenTelemetryCollectorServiceExtensions
+{
+    public static IDistributedApplicationBuilder AddOpenTelemetryCollectorInfrastructure(this IDistributedApplicationBuilder builder)
+    {
+        builder.Services.TryAddLifecycleHook<OpenTelemetryCollectorLifecycleHook>();
+
+        return builder;
+    }
+}

samples/Metrics/MetricsApp.AppHost/OpenTelemetryCollector/README.md

@@ -0,0 +1,3 @@
+# Aspire Hosting extension for the OpenTelemetry Collector
+
+Based on source from https://github.com/practical-otel/opentelemetry-aspire-collector by @martinjt.

samples/Metrics/MetricsApp.AppHost/Program.cs

@@ -1,17 +1,24 @@
-var builder = DistributedApplication.CreateBuilder(args);
+using MetricsApp.AppHost.OpenTelemetryCollector;
+
+var builder = DistributedApplication.CreateBuilder(args);
+
+var prometheus = builder.AddContainer("prometheus", "prom/prometheus")
+       .WithBindMount("../prometheus", "/etc/prometheus", isReadOnly: true)
+       .WithArgs("--web.enable-otlp-receiver", "--config.file=/etc/prometheus/prometheus.yml")
+       .WithHttpEndpoint(targetPort: 9090, name: "http");
 
 var grafana = builder.AddContainer("grafana", "grafana/grafana")
                      .WithBindMount("../grafana/config", "/etc/grafana", isReadOnly: true)
                      .WithBindMount("../grafana/dashboards", "/var/lib/grafana/dashboards", isReadOnly: true)
+                     .WithEnvironment("PROMETHEUS_ENDPOINT", prometheus.GetEndpoint("http"))
                      .WithHttpEndpoint(targetPort: 3000, name: "http");
 
+builder.AddOpenTelemetryCollector("otelcollector", "../otelcollector/config.yaml")
+       .WithEnvironment("PROMETHEUS_ENDPOINT", $"{prometheus.GetEndpoint("http")}/api/v1/otlp");
+
 builder.AddProject<Projects.MetricsApp>("app")
        .WithEnvironment("GRAFANA_URL", grafana.GetEndpoint("http"));
 
-builder.AddContainer("prometheus", "prom/prometheus")
-       .WithBindMount("../prometheus", "/etc/prometheus", isReadOnly: true)
-       .WithHttpEndpoint(/* This port is fixed as it's referenced from the Grafana config */ port: 9090, targetPort: 9090);
-
 using var app = builder.Build();
 
 await app.RunAsync();

samples/Metrics/MetricsApp.AppHost/Properties/launchSettings.json

@@ -22,7 +22,8 @@
         "ASPNETCORE_ENVIRONMENT": "Development",
         "DOTNET_ENVIRONMENT": "Development",
         "DOTNET_DASHBOARD_OTLP_ENDPOINT_URL": "http://localhost:19032",
-        "DOTNET_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:20132"
+        "DOTNET_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:20132",
+        "ASPIRE_ALLOW_UNSECURED_TRANSPORT": "true"
       }
     },
     "generate-manifest": {

samples/Metrics/MetricsApp/MetricsApp.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
@@ -11,7 +11,7 @@
     <PackageReference Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" Version="8.0.11" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.11" />
 
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="7.0.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="7.1.0" />
   </ItemGroup>
 
   <ItemGroup>

samples/Metrics/ServiceDefaults/Extensions.cs

@@ -66,11 +66,6 @@ private static IHostApplicationBuilder AddOpenTelemetryExporters(this IHostAppli
             builder.Services.AddOpenTelemetry().UseOtlpExporter();
         }
 
-        // The following lines enable the Prometheus exporter (requires the OpenTelemetry.Exporter.Prometheus.AspNetCore package)
-        builder.Services.AddOpenTelemetry()
-            // BUG: Part of the workaround for https://github.com/open-telemetry/opentelemetry-dotnet-contrib/issues/1617
-           .WithMetrics(metrics => metrics.AddPrometheusExporter(options => options.DisableTotalNameSuffixForCounters = true));
-
         return builder;
     }
 
@@ -85,9 +80,6 @@ public static IHostApplicationBuilder AddDefaultHealthChecks(this IHostApplicati
 
     public static WebApplication MapDefaultEndpoints(this WebApplication app)
     {
-        // The following line enables the Prometheus endpoint (requires the OpenTelemetry.Exporter.Prometheus.AspNetCore package)
-        app.MapPrometheusScrapingEndpoint();
-
         // Adding health checks endpoints to applications in non-development environments has security implications.
         // See https://aka.ms/dotnet/aspire/healthchecks for details before enabling these endpoints in non-development environments.
         if (app.Environment.IsDevelopment())

samples/Metrics/ServiceDefaults/ServiceDefaults.csproj

@@ -13,11 +13,9 @@
     <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="9.0.0" />
     <PackageReference Include="Microsoft.Extensions.ServiceDiscovery" Version="9.0.0" />
     <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.10.0" />
-    <!-- BUG: 1.8.0-rc.1 breaks prometheus exporter so sticking to 1.8.0-beta.1 for now https://github.com/open-telemetry/opentelemetry-dotnet-contrib/issues/1617 -->
-    <PackageReference Include="OpenTelemetry.Exporter.Prometheus.AspNetCore" Version="1.8.0-rc.1" />
     <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.10.0" />
     <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.9.0" />
-    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.9.0" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.10.0" />
     <PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.9.0" />
   </ItemGroup>
 

samples/Metrics/grafana/config/provisioning/datasources/default.yaml

@@ -5,5 +5,5 @@ datasources:
     type: prometheus
     access: proxy
     # Access mode - proxy (server in the UI) or direct (browser in the UI).
-    url: http://host.docker.internal:9090
+    url: $PROMETHEUS_ENDPOINT
     uid: PBFA97CFB590B2093

samples/Metrics/otelcollector/config.yaml

@@ -0,0 +1,42 @@
+receivers:
+  otlp:
+    protocols:
+      grpc:
+        endpoint: 0.0.0.0:4317
+      http:
+        endpoint: 0.0.0.0:4318
+
+processors:
+  batch:
+
+exporters:
+  debug:
+    verbosity: detailed
+  otlp/aspire:
+    endpoint: ${env:ASPIRE_ENDPOINT}
+    headers:
+      x-otlp-api-key: ${env:ASPIRE_API_KEY}
+    tls:
+        insecure: ${env:ASPIRE_INSECURE}
+        insecure_skip_verify: true # Required in local development because cert is localhost and the endpoint is host.docker.internal
+  otlphttp/prometheus:
+    endpoint: ${env:PROMETHEUS_ENDPOINT}
+    tls:
+        insecure: true
+
+service:
+  pipelines:
+    traces:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [otlp/aspire]
+    logs:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [otlp/aspire]
+    metrics:
+      receivers: [otlp]
+      processors: [batch]
+      exporters:
+        - otlp/aspire
+        - otlphttp/prometheus

samples/Metrics/prometheus/prometheus.yml

@@ -1,7 +1,5 @@
-global:
-  scrape_interval: 1s # makes for a good demo
+storage:
+  tsdb:
+    out_of_order_time_window: 30m
 
-scrape_configs:
-  - job_name: 'metricsapp'
-    static_configs:
-      - targets: ['host.docker.internal:5048'] # hard-coded port matches launchSettings.json
+otlp:

samples/Shared/DevCertHostingExtensions.cs

@@ -46,8 +46,8 @@ public static IResourceBuilder<TResource> RunWithHttpsDevCertificate<TResource>(
 
                     var bindSource = Path.GetDirectoryName(certPath) ?? throw new UnreachableException();
 
-                    var certFileDest = Path.Combine(DEV_CERT_BIND_MOUNT_DEST_DIR, certFileName);
-                    var certKeyFileDest = Path.Combine(DEV_CERT_BIND_MOUNT_DEST_DIR, certKeyFileName);
+                    var certFileDest = $"{DEV_CERT_BIND_MOUNT_DEST_DIR}/{certFileName}";
+                    var certKeyFileDest = $"{DEV_CERT_BIND_MOUNT_DEST_DIR}/{certKeyFileName}";
 
                     builder.ApplicationBuilder.CreateResourceBuilder(containerResource)
                         .WithBindMount(bindSource, DEV_CERT_BIND_MOUNT_DEST_DIR, isReadOnly: true)