Skip to content
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

[OpenTracing] allow setting service name after span is created #229

Merged
merged 4 commits into from
Dec 6, 2018
Merged

[OpenTracing] allow setting service name after span is created #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9abc3f2
add unit tests for setting service name with OpenTracing
lucaspimentel Dec 5, 2018
c4432be
fix indentation
lucaspimentel Dec 5, 2018
ded7daa
reorder and rename tests, add more tests
lucaspimentel Dec 5, 2018
d143bb2
add internal set for ServiceName so it can be set from `OpenTracing.I…
lucaspimentel Dec 5, 2018
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
20 changes: 11 additions & 9 deletions src/Datadog.Trace.OpenTracing/OpenTracingSpan.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,18 @@ public ISpan SetTag(StringTag tag, string value)
public ISpan SetTag(string key, string value)
{
// TODO:bertrand do we want this behavior on the Span object too ?
if (key == DatadogTags.ResourceName)

switch (key)
{
Span.ResourceName = value;
return this;
case DatadogTags.ResourceName:
Span.ResourceName = value;
return this;
case DatadogTags.SpanType:
Span.Type = value;
return this;
case DatadogTags.ServiceName:
Span.ServiceName = value;
return this;
}

if (key == global::OpenTracing.Tag.Tags.Error.Key)
Expand All @@ -128,12 +136,6 @@ public ISpan SetTag(string key, string value)
return this;
}

if (key == DatadogTags.SpanType)
{
Span.Type = value;
return this;
}

Span.SetTag(key, value);
return this;
}
Expand Down
6 changes: 5 additions & 1 deletion src/Datadog.Trace/Span.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,11 @@ internal Span(IDatadogTracer tracer, SpanContext parent, string operationName, s
/// <summary>
/// Gets the service name
/// </summary>
public string ServiceName => _context.ServiceName;
public string ServiceName
{
get { return _context.ServiceName; }
internal set { _context.ServiceName = value; }
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm late to the party sorry, but why not let the non opentracing tracer change the service name too?

Copy link
Member Author

Choose a reason for hiding this comment

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

You're right, there's nothing stopping us from allowing that as well. We just need to drop internal here. I was trying to fix the blocking issue only without changing anything else.

}

/// <summary>
/// Gets the trace's unique identifier.
Expand Down
4 changes: 2 additions & 2 deletions src/Datadog.Trace/SpanContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using System;
using System;
using System.Threading;
using Datadog.Trace.ExtensionMethods;
using Datadog.Trace.Logging;
Expand Down Expand Up @@ -73,7 +73,7 @@ internal SpanContext(SpanContext spanContext)
/// </summary>
public ulong SpanId { get; }

internal string ServiceName { get; }
internal string ServiceName { get; set; }

// This may be null if SpanContext was extracted from another process context
internal TraceContext TraceContext { get; }
Expand Down
156 changes: 156 additions & 0 deletions test/Datadog.Trace.OpenTracing.Tests/OpenTracingTracerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,5 +156,161 @@ public void Extract_HeadersProperlySet_SpanContext()
Assert.Equal(parentId, otSpanContext.Context.SpanId);
Assert.Equal(traceId, otSpanContext.Context.TraceId);
}

[Fact]
public void StartActive_NoServiceName_DefaultServiceName()
{
var scope = _tracer.BuildSpan("Operation")
.StartActive();

var otSpan = (OpenTracingSpan)scope.Span;
var ddSpan = otSpan.Span;

Assert.Contains(ddSpan.ServiceName, TestRunners.ValidNames);
}

[Fact]
public void SetDefaultServiceName()
{
ITracer tracer = OpenTracingTracerFactory.CreateTracer(defaultServiceName: "DefaultServiceName");

var scope = tracer.BuildSpan("Operation")
.StartActive();

var otSpan = (OpenTracingSpan)scope.Span;
var ddSpan = otSpan.Span;

Assert.Equal("DefaultServiceName", ddSpan.ServiceName);
}

[Fact]
public void SetServiceName_WithTag()
{
var scope = _tracer.BuildSpan("Operation")
.WithTag(DatadogTags.ServiceName, "MyAwesomeService")
.StartActive();

var otSpan = (OpenTracingSpan)scope.Span;
var ddSpan = otSpan.Span;

Assert.Equal("MyAwesomeService", ddSpan.ServiceName);
}

[Fact]
public void SetServiceName_SetTag()
{
var scope = _tracer.BuildSpan("Operation")
.StartActive();

scope.Span.SetTag(DatadogTags.ServiceName, "MyAwesomeService");
var otSpan = (OpenTracingSpan)scope.Span;
var ddSpan = otSpan.Span;

Assert.Equal("MyAwesomeService", ddSpan.ServiceName);
}

[Fact]
public void OverrideDefaultServiceName_WithTag()
{
ITracer tracer = OpenTracingTracerFactory.CreateTracer(defaultServiceName: "DefaultServiceName");

var scope = tracer.BuildSpan("Operation")
.WithTag(DatadogTags.ServiceName, "MyAwesomeService")
.StartActive();

var otSpan = (OpenTracingSpan)scope.Span;
var ddSpan = otSpan.Span;

Assert.Equal("MyAwesomeService", ddSpan.ServiceName);
}

[Fact]
public void OverrideDefaultServiceName_SetTag()
{
ITracer tracer = OpenTracingTracerFactory.CreateTracer(defaultServiceName: "DefaultServiceName");

var scope = tracer.BuildSpan("Operation")
.StartActive();

scope.Span.SetTag(DatadogTags.ServiceName, "MyAwesomeService");
var otSpan = (OpenTracingSpan)scope.Span;
var ddSpan = otSpan.Span;

Assert.Equal("MyAwesomeService", ddSpan.ServiceName);
}

[Fact]
public void InheritParentServiceName_WithTag()
{
var parentScope = _tracer.BuildSpan("ParentOperation")
.WithTag(DatadogTags.ServiceName, "MyAwesomeService")
.StartActive();

var childScope = _tracer.BuildSpan("ChildOperation")
.AsChildOf(parentScope.Span)
.StartActive();

var otSpan = (OpenTracingSpan)childScope.Span;
var ddSpan = otSpan.Span;

Assert.Equal("MyAwesomeService", ddSpan.ServiceName);
}

[Fact]
public void InheritParentServiceName_SetTag()
{
var parentScope = _tracer.BuildSpan("ParentOperation")
.StartActive();

parentScope.Span.SetTag(DatadogTags.ServiceName, "MyAwesomeService");

var childScope = _tracer.BuildSpan("ChildOperation")
.AsChildOf(parentScope.Span)
.StartActive();

var otSpan = (OpenTracingSpan)childScope.Span;
var ddSpan = otSpan.Span;

Assert.Equal("MyAwesomeService", ddSpan.ServiceName);
}

[Fact]
public void Parent_OverrideDefaultServiceName_WithTag()
{
ITracer tracer = OpenTracingTracerFactory.CreateTracer(defaultServiceName: "DefaultServiceName");

var parentScope = tracer.BuildSpan("ParentOperation")
.WithTag(DatadogTags.ServiceName, "MyAwesomeService")
.StartActive();

var childScope = tracer.BuildSpan("ChildOperation")
.AsChildOf(parentScope.Span)
.StartActive();

var otSpan = (OpenTracingSpan)childScope.Span;
var ddSpan = otSpan.Span;

Assert.Equal("MyAwesomeService", ddSpan.ServiceName);
}

[Fact]
public void Parent_OverrideDefaultServiceName_SetTag()
{
ITracer tracer = OpenTracingTracerFactory.CreateTracer(defaultServiceName: "DefaultServiceName");

var parentScope = tracer.BuildSpan("ParentOperation")
.StartActive();

parentScope.Span.SetTag(DatadogTags.ServiceName, "MyAwesomeService");

var childScope = tracer.BuildSpan("ChildOperation")
.AsChildOf(parentScope.Span)
.StartActive();

var otSpan = (OpenTracingSpan)childScope.Span;
var ddSpan = otSpan.Span;

Assert.Equal("MyAwesomeService", ddSpan.ServiceName);
}
}
}