Skip to content

Fix metrics and traces for DocsSync #2205

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

Fix metrics and traces for DocsSync #2205

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7dc0bf
Fix metrics and traces for DocsSync
reakaleek Nov 14, 2025
d61667f
Merge branch 'main' into feature/fix-docssync-metrics-traces
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
46 changes: 20 additions & 26 deletions ...vices/Elastic.Documentation.Assembler/Deploying/Synchronization/AwsS3SyncApplyStrategy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,38 +94,28 @@ public async Task Apply(SyncPlan plan, Cancel ctx = default)
var addCount = plan.AddRequests.Count;
var updateCount = plan.UpdateRequests.Count;
var deleteCount = plan.DeleteRequests.Count;
var skipCount = plan.SkipRequests.Count;
var totalFiles = addCount + updateCount + deleteCount;

// Add aggregate metrics to span
_ = applyActivity?.SetTag("docs.sync.files.added", addCount);
_ = applyActivity?.SetTag("docs.sync.files.updated", updateCount);
_ = applyActivity?.SetTag("docs.sync.files.deleted", deleteCount);
_ = applyActivity?.SetTag("docs.sync.files.skipped", skipCount);
_ = applyActivity?.SetTag("docs.sync.files.total", totalFiles);

// Record deployment-level metrics
// Record deployment-level metrics (always emit, even if 0)
FilesPerDeploymentHistogram.Record(totalFiles);

if (addCount > 0)
{
FilesPerDeploymentHistogram.Record(addCount,
[new("operation", "add")]);
}

if (updateCount > 0)
{
FilesPerDeploymentHistogram.Record(updateCount,
[new("operation", "update")]);
}

if (deleteCount > 0)
{
FilesPerDeploymentHistogram.Record(deleteCount,
[new("operation", "delete")]);
}
// Always record per-operation counts (even if 0) so metrics show consistent data
FilesPerDeploymentHistogram.Record(addCount, [new("operation", "add")]);
FilesPerDeploymentHistogram.Record(updateCount, [new("operation", "update")]);
FilesPerDeploymentHistogram.Record(deleteCount, [new("operation", "delete")]);
FilesPerDeploymentHistogram.Record(skipCount, [new("operation", "skip")]);

_logger.LogInformation(
"Deployment sync: {TotalFiles} files ({AddCount} added, {UpdateCount} updated, {DeleteCount} deleted) in {Environment}",
totalFiles, addCount, updateCount, deleteCount, context.Environment.Name);
"Deployment sync: {TotalFiles} files ({AddCount} added, {UpdateCount} updated, {DeleteCount} deleted, {SkipCount} skipped) in {Environment}",
totalFiles, addCount, updateCount, deleteCount, skipCount, context.Environment.Name);

await Upload(plan, ctx);
await Delete(plan, ctx);
Expand All @@ -138,11 +128,13 @@ public async Task Apply(SyncPlan plan, Cancel ctx = default)
private async Task Upload(SyncPlan plan, Cancel ctx)
{
var uploadRequests = plan.AddRequests.Cast<UploadRequest>().Concat(plan.UpdateRequests).ToList();

// Always create activity span (even if 0 files) for consistent tracing
using var uploadActivity = ApplyStrategyActivitySource.StartActivity("upload files", ActivityKind.Client);
_ = uploadActivity?.SetTag("docs.sync.upload.count", uploadRequests.Count);

if (uploadRequests.Count > 0)
{
using var uploadActivity = ApplyStrategyActivitySource.StartActivity("upload files", ActivityKind.Client);
_ = uploadActivity?.SetTag("docs.sync.upload.count", uploadRequests.Count);

var addCount = plan.AddRequests.Count;
var updateCount = plan.UpdateRequests.Count;

Expand Down Expand Up @@ -216,11 +208,13 @@ private async Task Delete(SyncPlan plan, Cancel ctx)
{
var deleteCount = 0;
var deleteRequests = plan.DeleteRequests.ToList();

// Always create activity span (even if 0 files) for consistent tracing
using var deleteActivity = ApplyStrategyActivitySource.StartActivity("delete files", ActivityKind.Client);
_ = deleteActivity?.SetTag("docs.sync.delete.count", deleteRequests.Count);

if (deleteRequests.Count > 0)
{
using var deleteActivity = ApplyStrategyActivitySource.StartActivity("delete files", ActivityKind.Client);
_ = deleteActivity?.SetTag("docs.sync.delete.count", deleteRequests.Count);

_logger.LogInformation("Starting to delete {Count} files from S3 bucket {BucketName}", deleteRequests.Count, bucketName);

// Emit file-level metrics (low cardinality) and logs for each file
Expand Down
Loading