Skip to content

Add tests to verify OTel setup in DocsSync #2204

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
merged 2 commits into from
Nov 14, 2025
Merged

Add tests to verify OTel setup in DocsSync #2204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c02635
Add tests to verify OTel setup in DocsSync
reakaleek Nov 14, 2025
bcbd0d0
Merge branch 'main' into feature/test-otel-docs-sync-setup
reakaleek Nov 14, 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
4 changes: 3 additions & 1 deletion Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@
<ItemGroup>
<PackageVersion Include="Microsoft.Extensions.Http.Resilience" Version="9.7.0" />
<PackageVersion Include="Microsoft.Extensions.ServiceDiscovery" Version="9.4.0" />
<PackageVersion Include="OpenTelemetry" Version="1.13.1" />
<PackageVersion Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.13.1" />
<PackageVersion Include="OpenTelemetry.Extensions.Hosting" Version="1.13.1" />
<PackageVersion Include="OpenTelemetry.Instrumentation.Http" Version="1.13.0" />
Expand All @@ -94,6 +95,7 @@
<PackageVersion Include="GitHubActionsTestLogger" Version="2.4.1" />
<PackageVersion Include="JetBrains.Annotations" Version="2024.3.0" />
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
<PackageVersion Include="OpenTelemetry.Exporter.InMemory" Version="1.13.0" />
<PackageVersion Include="System.IO.Abstractions.TestingHelpers" Version="22.0.16" />
<PackageVersion Include="Unquote" Version="7.0.1" />
<PackageVersion Include="xunit.runner.visualstudio" Version="3.1.0">
Expand All @@ -102,4 +104,4 @@
</PackageVersion>
<PackageVersion Include="xunit.v3" Version="2.0.2" />
</ItemGroup>
</Project>
</Project>
27 changes: 26 additions & 1 deletion tests-integration/Elastic.Assembler.IntegrationTests/DocsSyncTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information

using System.Diagnostics;
using System.IO.Abstractions.TestingHelpers;
using Amazon.S3;
using Amazon.S3.Model;
Expand All @@ -11,9 +12,12 @@
using Elastic.Documentation.Configuration;
using Elastic.Documentation.Configuration.Assembler;
using Elastic.Documentation.Diagnostics;
using Elastic.Documentation.ServiceDefaults.Telemetry;
using FakeItEasy;
using FluentAssertions;
using Microsoft.Extensions.Logging;
using OpenTelemetry;
using OpenTelemetry.Trace;

namespace Elastic.Assembler.IntegrationTests;

Expand Down Expand Up @@ -268,12 +272,20 @@ public async Task TestApply()
{
transferredFiles = fileSystem.Directory.GetFiles(request.Directory, request.SearchPattern, request.SearchOption);
});

// Configure OpenTelemetry to capture telemetry
var exportedActivities = new List<Activity>();
using var tracerProvider = Sdk.CreateTracerProviderBuilder()
.AddSource(TelemetryConstants.AssemblerSyncInstrumentationName)
.AddInMemoryExporter(exportedActivities)
.Build();

var applier = new AwsS3SyncApplyStrategy(new LoggerFactory(), moxS3Client, moxTransferUtility, "fake", context, collector);

// Act
await applier.Apply(plan, Cancel.None);

// Assert
// Assert - File operations
transferredFiles.Length.Should().Be(4); // 3 add requests + 1 update request
transferredFiles.Should().NotContain("docs/skip.md");

Expand All @@ -282,5 +294,18 @@ public async Task TestApply()

A.CallTo(() => moxTransferUtility.UploadDirectoryAsync(A<TransferUtilityUploadDirectoryRequest>._, A<Cancel>._))
.MustHaveHappenedOnceExactly();

// Assert - Telemetry spans are created
exportedActivities.Should().Contain(a => a.DisplayName == "sync apply");
exportedActivities.Should().Contain(a => a.DisplayName == "upload files");
exportedActivities.Should().Contain(a => a.DisplayName == "delete files");

// Assert - Telemetry tags contain correct aggregate counts
var syncActivity = exportedActivities.First(a => a.DisplayName == "sync apply");
var tagObjects = syncActivity.TagObjects.ToList();
tagObjects.Should().Contain(t => t.Key == "docs.sync.files.added" && Convert.ToInt64(t.Value, System.Globalization.CultureInfo.InvariantCulture) == 3);
tagObjects.Should().Contain(t => t.Key == "docs.sync.files.updated" && Convert.ToInt64(t.Value, System.Globalization.CultureInfo.InvariantCulture) == 1);
tagObjects.Should().Contain(t => t.Key == "docs.sync.files.deleted" && Convert.ToInt64(t.Value, System.Globalization.CultureInfo.InvariantCulture) == 1);
tagObjects.Should().Contain(t => t.Key == "docs.sync.files.total" && Convert.ToInt64(t.Value, System.Globalization.CultureInfo.InvariantCulture) == 5);
}
}
3 changes: 3 additions & 0 deletions ...-integration/Elastic.Assembler.IntegrationTests/Elastic.Assembler.IntegrationTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,15 @@
<ProjectReference Include="$(SolutionRoot)\src\Elastic.Documentation\Elastic.Documentation.csproj"/>
<ProjectReference Include="$(SolutionRoot)\src\tooling\docs-builder\docs-builder.csproj"/>
<ProjectReference Include="$(SolutionRoot)\aspire\aspire.csproj" />
<ProjectReference Include="$(SolutionRoot)\src\Elastic.Documentation.ServiceDefaults\Elastic.Documentation.ServiceDefaults.csproj" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="FakeItEasy" />
<PackageReference Include="AngleSharp" />
<PackageReference Include="Aspire.Hosting.Testing"/>
<PackageReference Include="InMemoryLogger"/>
<PackageReference Include="OpenTelemetry" />
<PackageReference Include="OpenTelemetry.Exporter.InMemory" />
</ItemGroup>

</Project>
Loading