Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion eng/Signing.props
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<Project>
<!-- Arcade currently requires this file, though it doesn't require any content in it I believe. -->
<ItemGroup Label="File signing information">
<!-- Third-party components which should be signed. -->
<FileSignInfo Include="HealthChecks.ApplicationStatus.dll" CertificateName="3PartySHA2" />
<FileSignInfo Include="OpenTelemetry.dll" CertificateName="3PartySHA2" />
<FileSignInfo Include="OpenTelemetry.Api.dll" CertificateName="3PartySHA2" />
<FileSignInfo Include="OpenTelemetry.Api.ProviderBuilderExtensions.dll" CertificateName="3PartySHA2" />
<FileSignInfo Include="OpenTelemetry.Exporter.OpenTelemetryProtocol.dll" CertificateName="3PartySHA2" />
<FileSignInfo Include="OpenTelemetry.Extensions.Hosting.dll" CertificateName="3PartySHA2" />
<FileSignInfo Include="OpenTelemetry.Instrumentation.AspNetCore.dll" CertificateName="3PartySHA2" />
<FileSignInfo Include="OpenTelemetry.Instrumentation.GrpcNetClient.dll" CertificateName="3PartySHA2" />
<FileSignInfo Include="OpenTelemetry.Instrumentation.Http.dll" CertificateName="3PartySHA2" />
<FileSignInfo Include="OpenTelemetry.Instrumentation.Runtime.dll" CertificateName="3PartySHA2" />
</ItemGroup>
</Project>
12 changes: 10 additions & 2 deletions eng/Versions.props
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,15 @@
<JsonSchemaNetVersion>7.0.2</JsonSchemaNetVersion>
<!-- Container app dependencies -->
<YarpNugetVersion>2.2.0</YarpNugetVersion>
<MicrosoftExtensionsServiceDiscovery>8.2.2</MicrosoftExtensionsServiceDiscovery>
<MicrosoftExtensionsServiceDiscoveryYarp>8.2.2</MicrosoftExtensionsServiceDiscoveryYarp>
<MicrosoftExtensionsServiceDiscovery>9.0.0</MicrosoftExtensionsServiceDiscovery>
<MicrosoftExtensionsServiceDiscoveryYarp>9.0.0</MicrosoftExtensionsServiceDiscoveryYarp>
<OpenTelemetryExporterOpenTelemetryProtocol>1.9.0 </OpenTelemetryExporterOpenTelemetryProtocol>
<OpenTelemetryExtensionsHosting>1.9.0</OpenTelemetryExtensionsHosting>
<OpenTelemetryInstrumentationAspNetCore>1.9.0</OpenTelemetryInstrumentationAspNetCore>
<OpenTelemetryInstrumentationGrpcNetClient>1.9.0-beta.1</OpenTelemetryInstrumentationGrpcNetClient>
<OpenTelemetryInstrumentationHttp>1.9.0</OpenTelemetryInstrumentationHttp>
<OpenTelemetryInstrumentationRuntime>1.9.0</OpenTelemetryInstrumentationRuntime>
<MicrosoftExtensionsHttpResilience>9.1.0</MicrosoftExtensionsHttpResilience>
<AspNetCoreHealthChecksApplicationStatus>9.0.0</AspNetCoreHealthChecksApplicationStatus>
</PropertyGroup>
</Project>
117 changes: 117 additions & 0 deletions src/Application/Extensions.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
using System.Net;
using System.Security.Cryptography;
using System.Security.Cryptography.X509Certificates;
using HealthChecks.ApplicationStatus.DependencyInjection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using OpenTelemetry;
using OpenTelemetry.Exporter;
using OpenTelemetry.Logs;
using OpenTelemetry.Metrics;
using OpenTelemetry.Trace;
using static System.Net.WebRequestMethods;

namespace Microsoft.Extensions.Hosting;

// Adds common .NET Aspire services: service discovery, resilience, health checks, and OpenTelemetry.
// This project should be referenced by each service project in your solution.
// To learn more about using this project, see https://aka.ms/dotnet/aspire/service-defaults
public static class Extensions
{
public static TBuilder AddServiceDefaults<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
{
builder.ConfigureOpenTelemetry();

builder.AddDefaultHealthChecks();

builder.Services.AddServiceDiscovery();

builder.Services.ConfigureHttpClientDefaults(http =>
{
// Turn on resilience by default
http.AddStandardResilienceHandler();

// Turn on service discovery by default
http.AddServiceDiscovery();
});

return builder;
}

public static TBuilder ConfigureOpenTelemetry<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
{
builder.Logging.AddOpenTelemetry(logging =>
{
logging.IncludeFormattedMessage = true;
logging.IncludeScopes = true;
});

builder.Services.AddOpenTelemetry()
.WithMetrics(metrics =>
{
metrics.AddAspNetCoreInstrumentation()
.AddHttpClientInstrumentation()
.AddRuntimeInstrumentation()
.SetExemplarFilter(ExemplarFilterType.TraceBased);
})
.WithTracing(tracing =>
{
tracing.AddAspNetCoreInstrumentation()
.AddGrpcClientInstrumentation()
.AddHttpClientInstrumentation()
.AddOtlpExporter();
});

builder.AddOpenTelemetryExporters();

return builder;
}

private static TBuilder AddOpenTelemetryExporters<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
{
var useOtlpExporter = !string.IsNullOrWhiteSpace(builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]);

if (useOtlpExporter)
{

if (string.Equals(Environment.GetEnvironmentVariable("YARP_UNSAFE_SKIP_OLTP_CERT_VALIDATION"), "true", StringComparison.InvariantCultureIgnoreCase))
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: If this is otherwise equivalent, can we change this to something like?

builder.Services.Configure<OtlpExporterOptions>(options =>
{
    options.HttpClientFactory = () =>
    {
        var handler = new HttpClientHandler();
    
        if (string.Equals(Environment.GetEnvironmentVariable("YARP_UNSAFE_SKIP_OLTP_CERT_VALIDATION"), "true", StringComparison.InvariantCultureIgnoreCase))
        {
            handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousAcceptAnyServerCertificateValidator;
        }
    
        return new HttpClient(handler);
    }
});

builder.Services.AddOpenTelemetry()
    .WithLogging(logging => logging.AddOtlpExporter())
    .WithMetrics(metrics => metrics.AddOtlpExporter())
    .WithTracing(tracing => tracing.AddOtlpExporter());

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My comment here was more so about potential subtle differenes in behavior between the two (is the handler configured the same?), not just DangerousAcceptAnyServerCertificateValidator.

Right now it's not obvious that the environment variable will only change the cert validation.

{
// We cannot use UseOtlpExporter() since it doesn't support configuration via OtlpExporterOptions
// https://github.com/open-telemetry/opentelemetry-dotnet/issues/5802
builder.Services.Configure<OtlpExporterOptions>(ConfigureOtlpExporterOptions);
builder.Services.AddOpenTelemetry()
.WithLogging(logging => logging.AddOtlpExporter())
.WithMetrics(metrics => metrics.AddOtlpExporter())
.WithTracing(tracing => tracing.AddOtlpExporter());
}
else
{
builder.Services.AddOpenTelemetry().UseOtlpExporter();
}
}

static void ConfigureOtlpExporterOptions(OtlpExporterOptions options)
{
options.HttpClientFactory = () =>
{
var handler = new HttpClientHandler();
handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousAcceptAnyServerCertificateValidator;
var httpClient = new HttpClient(handler);
return httpClient;
};
}

return builder;
}

public static TBuilder AddDefaultHealthChecks<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
{
builder.Services.AddHealthChecks()
// Add a default liveness check on application status.
.AddApplicationStatus(tags: ["live"]);

return builder;
}
}
2 changes: 2 additions & 0 deletions src/Application/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

// Load configuration
if (args.Length != 1)
Expand All @@ -23,6 +24,7 @@
builder.Configuration.AddJsonFile(fileInfo.FullName, optional: false, reloadOnChange: true);

// Configure YARP
builder.AddServiceDefaults();
builder.Services.AddServiceDiscovery();
builder.Services.AddReverseProxy()
.LoadFromConfig(builder.Configuration.GetSection("ReverseProxy"))
Expand Down
9 changes: 9 additions & 0 deletions src/Application/Yarp.Application.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@
<PackageReference Include="Yarp.ReverseProxy" Version="$(YarpNugetVersion)" />
<PackageReference Include="Microsoft.Extensions.ServiceDiscovery" Version="$(MicrosoftExtensionsServiceDiscovery)" />
<PackageReference Include="Microsoft.Extensions.ServiceDiscovery.Yarp" Version="$(MicrosoftExtensionsServiceDiscoveryYarp)" />

<PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="$(OpenTelemetryExporterOpenTelemetryProtocol)" />
<PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="$(OpenTelemetryExtensionsHosting)" />
<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="$(OpenTelemetryInstrumentationAspNetCore)" />
<PackageReference Include="OpenTelemetry.Instrumentation.GrpcNetClient" Version="$(OpenTelemetryInstrumentationGrpcNetClient)" />
<PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="$(OpenTelemetryInstrumentationHttp)" />
<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="$(OpenTelemetryInstrumentationRuntime)" />
<PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="$(MicrosoftExtensionsHttpResilience)" />
<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" Version="$(AspNetCoreHealthChecksApplicationStatus)" />
</ItemGroup>

</Project>
Loading