Skip to content

feat(csharp/src/Apache.Arrow.Adbc/Tracing): allow ActivitySource tags to be set from TracingConnection #3218

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 1 commit into from
Jul 31, 2025
Merged

feat(csharp/src/Apache.Arrow.Adbc/Tracing): allow ActivitySource tags to be set from TracingConnection #3218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions csharp/src/Apache.Arrow.Adbc/Tracing/ActivityTrace.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
*/

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Threading.Tasks;

Expand All @@ -33,8 +33,11 @@ public sealed class ActivityTrace : IDisposable
/// Constructs a new <see cref="ActivityTrace"/> object. If <paramref name="activitySourceName"/> is set, it provides the
/// activity source name, otherwise the current assembly name is used as the activity source name.
/// </summary>
/// <param name="activitySourceName"></param>
public ActivityTrace(string? activitySourceName = default, string? activitySourceVersion = default, string? traceParent = default)
/// <param name="activitySourceName">The name of the ActivitySource object</param>
/// <param name="activitySourceVersion">The version of the component publishing the tracing info.</param>
/// <param name="traceParent">The trace parent context, which is used to link the activity to a distributed trace.</param>
/// <param name="tags">The tags associated with the activity.</param>
public ActivityTrace(string? activitySourceName = default, string? activitySourceVersion = default, string? traceParent = default, IEnumerable<KeyValuePair<string, object?>>? tags = default)
Copy link
Contributor

@CurtHagenlocher CurtHagenlocher Jul 31, 2025

Choose a reason for hiding this comment

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

This is a binary breaking change. Was this class already part of the last release? If we had "declared 1.0" and already included this class in a public release then we'd want to add an overload instead of changing the signature. (As we are not yet at 1.0, I think it's probably okay not to worry about binary compatibility in this case.)

{
activitySourceName ??= GetType().Assembly.GetName().Name!;
// It's okay to have a null version.
Expand All @@ -46,7 +49,7 @@ public ActivityTrace(string? activitySourceName = default, string? activitySourc

TraceParent = traceParent;
// This is required to be disposed
ActivitySource = new(activitySourceName, activitySourceVersion);
ActivitySource = new(activitySourceName, activitySourceVersion, tags);
}

/// <summary>
Expand Down
9 changes: 8 additions & 1 deletion csharp/src/Apache.Arrow.Adbc/Tracing/TracingConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public abstract class TracingConnection : AdbcConnection, IActivityTracer
protected TracingConnection(IReadOnlyDictionary<string, string> properties)
{
properties.TryGetValue(AdbcOptions.Telemetry.TraceParent, out string? traceParent);
_trace = new ActivityTrace(this.AssemblyName, this.AssemblyVersion, traceParent);
_trace = new ActivityTrace(AssemblyName, AssemblyVersion, traceParent, GetActivitySourceTags(properties));
}

string? IActivityTracer.TraceParent => _trace.TraceParent;
Expand All @@ -38,6 +38,13 @@ protected TracingConnection(IReadOnlyDictionary<string, string> properties)

public abstract string AssemblyName { get; }

public string ActivitySourceName => _trace.ActivitySourceName;

public virtual IEnumerable<KeyValuePair<string, object?>>? GetActivitySourceTags(IReadOnlyDictionary<string, string> properties)
{
return null;
}

protected void SetTraceParent(string? traceParent)
{
_trace.TraceParent = traceParent;
Expand Down
9 changes: 9 additions & 0 deletions csharp/src/Drivers/Databricks/DatabricksConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,15 @@ public DatabricksConnection(IReadOnlyDictionary<string, string> properties) : ba
ValidateProperties();
}

public override IEnumerable<KeyValuePair<string, object?>>? GetActivitySourceTags(IReadOnlyDictionary<string, string> properties)
{
IEnumerable<KeyValuePair<string, object?>>? tags = base.GetActivitySourceTags(properties);
// TODO: Add any additional tags specific to Databricks connection
//tags ??= [];
//tags.Concat([new("key", "value")]);
return tags;
}

protected override TCLIService.IAsync CreateTCLIServiceClient(TProtocol protocol)
{
return new ThreadSafeClient(new TCLIService.Client(protocol));
Expand Down
89 changes: 84 additions & 5 deletions csharp/test/Apache.Arrow.Adbc.Tests/Tracing/TracingTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
using System.Diagnostics;
using System.Linq;
using Apache.Arrow.Adbc.Tracing;
using Apache.Arrow.Ipc;
using OpenTelemetry;
using OpenTelemetry.Trace;
using Xunit;
Expand All @@ -29,6 +30,10 @@ namespace Apache.Arrow.Adbc.Tests.Tracing
{
public class TracingTests(ITestOutputHelper? outputHelper) : IDisposable
{
private const string SourceTagName = "sourceTagName";
private const string SourceTagValue = "sourceTagValue";
private const string TraceParent = "00-3236da27af79882bd317c4d1c3776982-a3cc9bd52ccd58e6-01";

private readonly ITestOutputHelper? _outputHelper = outputHelper;
private bool _disposed;

Expand Down Expand Up @@ -143,12 +148,10 @@ internal void CanAddTraceParent()
testClass.MethodWithActivity(eventNameWithoutParent);
Assert.True(exportedActivities.Count() > 0);

const string traceParent = "00-3236da27af79882bd317c4d1c3776982-a3cc9bd52ccd58e6-01";

const int withParentCountExpected = 10;
for (int i = 0; i < withParentCountExpected; i++)
{
testClass.MethodWithActivity(eventNameWithParent, traceParent);
testClass.MethodWithActivity(eventNameWithParent, TraceParent);
}

testClass.MethodWithActivity(eventNameWithoutParent);
Expand All @@ -169,13 +172,61 @@ internal void CanAddTraceParent()
else if (exportedActivity.OperationName.Contains(eventNameWithParent))
{
withParentCount++;
Assert.Equal(traceParent, exportedActivity.ParentId);
Assert.Equal(TraceParent, exportedActivity.ParentId);
}
}
Assert.Equal(2, withoutParentCount);
Assert.Equal(withParentCountExpected, withParentCount);
}

[Fact]
internal void CanListenAndFilterActivitySourceTagsUsingActivityTrace()
{
string activitySourceName = NewName();
Queue<Activity> exportedActivities = new();
using (ActivityListener activityListener = new()
{
ShouldListenTo = source =>
{
return source.Name == activitySourceName
&& source.Tags?.Any(t => t.Key == SourceTagName && t.Value?.Equals(SourceTagValue) == true) == true;
},
Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllDataAndRecorded,
ActivityStopped = activity => exportedActivities.Enqueue(activity)
})
{
ActivitySource.AddActivityListener(activityListener);

var testClass = new TraceProducer(activitySourceName);
testClass.MethodWithActivity();
}
Assert.Single(exportedActivities);
}

[Fact]
internal void CanListenAndFilterActivitySourceTagsUsingTracingConnection()
{
string activitySourceName = NewName();
Queue<Activity> exportedActivities = new();
var testClass = new MyTracingConnection(new Dictionary<string, string>(), activitySourceName);
using (ActivityListener activityListener = new()
{
ShouldListenTo = source =>
{
return source.Name == testClass.ActivitySourceName
&& source.Tags?.Any(t => t.Key == SourceTagName && t.Value?.Equals(SourceTagValue) == true) == true;
},
Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllDataAndRecorded,
ActivityStopped = activity => exportedActivities.Enqueue(activity)
})
{
ActivitySource.AddActivityListener(activityListener);

testClass.MethodWithActivity();
}
Assert.Single(exportedActivities);
}

internal static string NewName() => Guid.NewGuid().ToString().Replace("-", "").ToLower();

protected virtual void Dispose(bool disposing)
Expand Down Expand Up @@ -203,7 +254,8 @@ private class TraceProducer : IDisposable

internal TraceProducer(string? activitySourceName = default, string? traceParent = default)
{
_trace = new ActivityTrace(activitySourceName, traceParent: traceParent);
IEnumerable<KeyValuePair<string, object?>>? tags = [new(SourceTagName, SourceTagValue)];
_trace = new ActivityTrace(activitySourceName, traceParent: traceParent, tags: tags);
}

internal void MethodWithNoInstrumentation()
Expand Down Expand Up @@ -273,6 +325,33 @@ public void Dispose()
}
}

private class MyTracingConnection(IReadOnlyDictionary<string, string> properties, string assemblyName) : TracingConnection(properties)
{
public override string AssemblyVersion => "1.0.0";
public override string AssemblyName { get; } = assemblyName;

public override IEnumerable<KeyValuePair<string, object?>>? GetActivitySourceTags(IReadOnlyDictionary<string, string> properties)
{
return [new KeyValuePair<string, object?>(SourceTagName, SourceTagValue)];
}

public void MethodWithActivity()
{
this.TraceActivity(activity =>
{
activity?.AddTag("exampleTag", "exampleValue")
.AddBaggage("exampleBaggage", "exampleBaggageValue")
.AddEvent("exampleEvent", [new KeyValuePair<string, object?>("eventTag", "eventValue")])
.AddLink(TraceParent, [new KeyValuePair<string, object?>("linkTag", "linkValue")]);
});
}

public override AdbcStatement CreateStatement() => throw new NotImplementedException();
public override IArrowArrayStream GetObjects(GetObjectsDepth depth, string? catalogPattern, string? dbSchemaPattern, string? tableNamePattern, IReadOnlyList<string>? tableTypes, string? columnNamePattern) => throw new NotImplementedException();
public override Schema GetTableSchema(string? catalog, string? dbSchema, string tableName) => throw new NotImplementedException();
public override IArrowArrayStream GetTableTypes() => throw new NotImplementedException();
}

internal class ActivityQueueExporter(Queue<Activity> exportedActivities) : BaseExporter<Activity>
{
private Queue<Activity> ExportedActivities { get; } = exportedActivities;
Expand Down
Loading