open-telemetry
/
opentelemetry-dotnet
mirror of https://github.com/open-telemetry/opentelemetry-dotnet.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix OpenTracing shim under legacy AspNetCore activities (#3506)

This commit is contained in:
Paulo Janotti 2022-08-02 17:38:10 -07:00 committed by GitHub
parent 2821898b8a
commit 3929727675
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 31 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/OpenTelemetry.Shims.OpenTracing/CHANGELOG.md
View File

@ -2,6 +2,10 @@
## Unreleased
* Fix: Handling of OpenTracing spans when used in conjunction
with legacy "Microsoft.AspNetCore.Hosting.HttpRequestIn" activities.
([#3509](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3506))
## 1.0.0-rc9.4
Released 2022-Jun-03

19
src/OpenTelemetry.Shims.OpenTracing/SpanBuilderShim.cs
View File

@ -16,7 +16,6 @@
using System;
using System.Collections.Generic;
using System.Diagnostics;
using OpenTelemetry.Internal;
using OpenTelemetry.Trace;
using OpenTracing;
@ -50,14 +49,6 @@ namespace OpenTelemetry.Shims.OpenTracing
/// </summary>
private readonly List<KeyValuePair<string, object>> attributes = new();
/// <summary>
/// The set of operation names for System.Diagnostics.Activity based automatic instrumentations that indicate a root span.
/// </summary>
private readonly IList<string> rootOperationNamesForActivityBasedAutoInstrumentations = new List<string>
{
"Microsoft.AspNetCore.Hosting.HttpRequestIn",
};
/// <summary>
/// The parent as an TelemetrySpan, if any.
/// </summary>
@ -79,7 +70,7 @@ namespace OpenTelemetry.Shims.OpenTracing
private bool error;
public SpanBuilderShim(Tracer tracer, string spanName, IList<string> rootOperationNamesForActivityBasedAutoInstrumentations = null)
public SpanBuilderShim(Tracer tracer, string spanName)
{
Guard.ThrowIfNull(tracer);
Guard.ThrowIfNull(spanName);
@ -87,7 +78,6 @@ namespace OpenTelemetry.Shims.OpenTracing
this.tracer = tracer;
this.spanName = spanName;
this.ScopeManager = new ScopeManagerShim(this.tracer);
this.rootOperationNamesForActivityBasedAutoInstrumentations = rootOperationNamesForActivityBasedAutoInstrumentations ?? this.rootOperationNamesForActivityBasedAutoInstrumentations;
}
private IScopeManager ScopeManager { get; }
@ -172,13 +162,6 @@ namespace OpenTelemetry.Shims.OpenTracing
{
span = this.tracer.StartSpan(this.spanName, this.spanKind, this.parentSpanContext, default, this.links, this.explicitStartTime ?? default);
}
else if (this.parentSpan == null && !this.parentSpanContext.IsValid && Activity.Current != null && Activity.Current.IdFormat == ActivityIdFormat.W3C)
{
if (this.rootOperationNamesForActivityBasedAutoInstrumentations.Contains(Activity.Current.OperationName))
{
span = Tracer.CurrentSpan;
}
}
if (span == null)
{

28
test/OpenTelemetry.Shims.OpenTracing.Tests/SpanBuilderShimTests.cs
View File

@ -127,13 +127,13 @@ namespace OpenTelemetry.Shims.OpenTracing.Tests
// matching root operation name
var tracer = TracerProvider.Default.GetTracer(TracerName);
var shim = new SpanBuilderShim(tracer, "foo", new List<string> { "foo" });
var shim = new SpanBuilderShim(tracer, "foo");
var spanShim1 = (SpanShim)shim.Start();
Assert.Equal("foo", spanShim1.Span.Activity.OperationName);
// mis-matched root operation name
shim = new SpanBuilderShim(tracer, "foo", new List<string> { "bar" });
shim = new SpanBuilderShim(tracer, "foo");
var spanShim2 = (SpanShim)shim.Start();
Assert.Equal("foo", spanShim2.Span.Activity.OperationName);
@ -330,5 +330,29 @@ namespace OpenTelemetry.Shims.OpenTracing.Tests
Assert.NotNull(span);
Assert.Equal("foo", span.Span.Activity.OperationName);
}
[Fact]
public void Start_UnderAspNetCoreInstrumentation()
{
// Simulate a span from AspNetCore instrumentation as parent.
using var source = new ActivitySource("Microsoft.AspNetCore.Hosting.HttpRequestIn");
using var parentSpan = source.StartActivity("OTelParent");
Assert.NotNull(parentSpan);
// Start the OpenTracing span.
var tracer = TracerProvider.Default.GetTracer(TracerName);
var builderShim = new SpanBuilderShim(tracer, "foo");
var spanShim = builderShim.StartActive().Span as SpanShim;
Assert.NotNull(spanShim);
var telemetrySpan = spanShim.Span;
Assert.Same(telemetrySpan.Activity, Activity.Current);
Assert.Same(parentSpan, telemetrySpan.Activity.Parent);
// Dispose the spanShim.Span and ensure correct state for Activity.Current
spanShim.Span.Dispose();
Assert.Same(parentSpan, Activity.Current);
}
}
}