Skip to content

Add OpenTelemetry Collector extension/component #603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aaronpowell merged 22 commits into from
Sep 5, 2025
Merged

Add OpenTelemetry Collector extension/component #603

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
ef60fdf
Added OpenTelemetry Collector component
martinjt Aug 7, 2025
5401d2d
Fixed DevCertHostingExtensions
martinjt Aug 7, 2025
68d4102
Update src/Shared/DevCertHostingExtensions.cs
martinjt Aug 7, 2025
81ffb8d
Apply suggestions from code review
martinjt Aug 7, 2025
790c37a
Renames
martinjt Aug 11, 2025
84a0ecf
Switch the image syntax
martinjt Aug 11, 2025
bd8de8a
Move to OnBeforeStart for DevCerts
martinjt Aug 11, 2025
0240f5c
Updated Devcerts code
martinjt Aug 22, 2025
8b54668
Updates to devcerts to check for duplicate mounts.
martinjt Aug 29, 2025
19be5ba
Added an example of the collector usage
martinjt Aug 29, 2025
5f9f442
Moved to eventing and made all other resources wait for this collector
martinjt Aug 29, 2025
f908dda
made the extension methods internal
martinjt Aug 31, 2025
26c32d4
Added a basic test
martinjt Aug 31, 2025
11d3af2
Reworked Extensions and added README with examples
martinjt Sep 1, 2025
267b291
Added tests to workflow
martinjt Sep 1, 2025
2b48b7a
Added more tests
martinjt Sep 1, 2025
abd19d4
object has a null guard earlier so we don't have to force it
aaronpowell Sep 4, 2025
446c6a8
Fixing a CA1853 - Dictionary.Remove does its own guard check
aaronpowell Sep 4, 2025
53e2270
Tightening up resource access
aaronpowell Sep 4, 2025
760a610
Expanding the unit tests
aaronpowell Sep 4, 2025
0c69e58
More tests
aaronpowell Sep 4, 2025
52f1159
Adding martinjt as codeowner
aaronpowell Sep 4, 2025
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
21 changes: 4 additions & 17 deletions ...ommunityToolkit.Aspire.Hosting.OpenTelemetryCollector/OpenTelemetryCollectorExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,18 +113,12 @@ public static IResourceBuilder<OpenTelemetryCollectorResource> WithConfig(this I
/// <returns></returns>
private static IResourceBuilder<OpenTelemetryCollectorResource> WithFirstStartup(this IResourceBuilder<OpenTelemetryCollectorResource> builder)
{
builder.OnBeforeResourceStarted((resource, beforeStartedEvent, cancellationToken) =>
builder.OnBeforeResourceStarted((collectorResource, beforeStartedEvent, cancellationToken) =>
{
var logger = beforeStartedEvent.Services.GetRequiredService<ResourceLoggerService>().GetLogger(resource);
var logger = beforeStartedEvent.Services.GetRequiredService<ResourceLoggerService>().GetLogger(collectorResource);
var appModel = beforeStartedEvent.Services.GetRequiredService<DistributedApplicationModel>();
var resources = appModel.GetProjectResources();
var collectorResource = appModel.Resources.OfType<OpenTelemetryCollectorResource>().FirstOrDefault();

if (collectorResource is null)
{
logger.LogWarning("No collector resource found");
return Task.CompletedTask;
}
foreach (var resourceItem in resources.Where(r => r.HasAnnotationOfType<OtlpExporterAnnotation>()))
{
resourceItem.Annotations.Add(new WaitAnnotation(collectorResource, WaitType.WaitUntilHealthy));
Expand All @@ -140,18 +134,11 @@ private static IResourceBuilder<OpenTelemetryCollectorResource> WithFirstStartup
/// <param name="builder"></param>
private static IResourceBuilder<OpenTelemetryCollectorResource> AddEnvironmentVariablesEventHook(this IResourceBuilder<OpenTelemetryCollectorResource> builder)
{
builder.OnResourceEndpointsAllocated((resource, allocatedEvent, cancellationToken) =>
builder.OnResourceEndpointsAllocated((collectorResource, allocatedEvent, cancellationToken) =>
{
var logger = allocatedEvent.Services.GetRequiredService<ResourceLoggerService>().GetLogger(resource);
var logger = allocatedEvent.Services.GetRequiredService<ResourceLoggerService>().GetLogger(collectorResource);
var appModel = allocatedEvent.Services.GetRequiredService<DistributedApplicationModel>();
var resources = appModel.GetProjectResources();
var collectorResource = appModel.Resources.OfType<OpenTelemetryCollectorResource>().FirstOrDefault();

if (collectorResource is null)
{
logger.LogWarning("No collector resource found");
return Task.CompletedTask;
}

var grpcEndpoint = collectorResource.GetEndpoint(collectorResource.GrpcEndpoint.EndpointName);
var httpEndpoint = collectorResource.GetEndpoint(collectorResource.HttpEndpoint.EndpointName);
Expand Down
6 changes: 2 additions & 4 deletions src/Shared/DevCertHostingExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public static IResourceBuilder<TResource> RunWithHttpsDevCertificate<TResource>(
{
throw new InvalidOperationException("RunWithHttpsDevCertificate needs environment variables only for Resources that aren't Containers.");
}

// Create temp directory for certificate export
var tempDir = Directory.CreateTempSubdirectory("aspire-dev-certs");
var certExportPath = Path.Combine(tempDir.FullName, "dev-cert.pem");
Expand All @@ -58,7 +58,7 @@ public static IResourceBuilder<TResource> RunWithHttpsDevCertificate<TResource>(
var existingResource = builder.ApplicationBuilder.Resources.FirstOrDefault(r => r.Name == exportResourceName);
IResourceBuilder<ExecutableResource> exportExecutable;

if (existingResource == null)
if (existingResource is null)
{
// Create the executable resource to export the certificate
exportExecutable = builder.ApplicationBuilder
Expand All @@ -85,8 +85,6 @@ public static IResourceBuilder<TResource> RunWithHttpsDevCertificate<TResource>(
// Configure the current resource with the certificate paths
if (builder.Resource is ContainerResource containerResource)
{


var certFileDest = $"{DEV_CERT_BIND_MOUNT_DEST_DIR}/{CERT_FILE_NAME}";
var certKeyFileDest = $"{DEV_CERT_BIND_MOUNT_DEST_DIR}/{CERT_KEY_FILE_NAME}";

Expand Down
1 change: 1 addition & 0 deletions ...emetryCollector.Tests/CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
</PropertyGroup>

<ItemGroup>
<ProjectReference Include="../CommunityToolkit.Aspire.Testing/CommunityToolkit.Aspire.Testing.csproj" />
Copy link
Contributor

@davidfowl davidfowl Sep 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

..\
../

😄

Copy link
Member

@aaronpowell aaronpowell Sep 4, 2025

Choose a reason for hiding this comment

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

Go complain to the editor teams - I added the reference via devkit on my devcontainer 😝

<ProjectReference Include="..\..\src\CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector\CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector.csproj" />
</ItemGroup>

Expand Down
Loading
Loading