760 lines
31 KiB
C#
760 lines
31 KiB
C#
// <copyright file="OtlpTraceExporterTests.cs" company="OpenTelemetry Authors">
|
|
// Copyright The OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
// </copyright>
|
|
|
|
using System.Diagnostics;
|
|
using Google.Protobuf.Collections;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Moq;
|
|
using OpenTelemetry.Exporter.OpenTelemetryProtocol.Implementation;
|
|
using OpenTelemetry.Exporter.OpenTelemetryProtocol.Implementation.ExportClient;
|
|
using OpenTelemetry.Metrics;
|
|
using OpenTelemetry.Resources;
|
|
using OpenTelemetry.Tests;
|
|
using OpenTelemetry.Trace;
|
|
using Xunit;
|
|
using OtlpCollector = OpenTelemetry.Proto.Collector.Trace.V1;
|
|
using OtlpCommon = OpenTelemetry.Proto.Common.V1;
|
|
using OtlpTrace = OpenTelemetry.Proto.Trace.V1;
|
|
using Status = OpenTelemetry.Trace.Status;
|
|
|
|
namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests
|
|
{
|
|
[Collection("xUnitCollectionPreventingTestsThatDependOnSdkConfigurationFromRunningInParallel")]
|
|
public class OtlpTraceExporterTests : Http2UnencryptedSupportTests
|
|
{
|
|
private static readonly SdkLimitOptions DefaultSdkLimitOptions = new();
|
|
|
|
static OtlpTraceExporterTests()
|
|
{
|
|
Activity.DefaultIdFormat = ActivityIdFormat.W3C;
|
|
Activity.ForceDefaultIdFormat = true;
|
|
|
|
var listener = new ActivityListener
|
|
{
|
|
ShouldListenTo = _ => true,
|
|
Sample = (ref ActivityCreationOptions<ActivityContext> options) => ActivitySamplingResult.AllData,
|
|
};
|
|
|
|
ActivitySource.AddActivityListener(listener);
|
|
}
|
|
|
|
[Fact]
|
|
public void AddOtlpTraceExporterNamedOptionsSupported()
|
|
{
|
|
int defaultExporterOptionsConfigureOptionsInvocations = 0;
|
|
int namedExporterOptionsConfigureOptionsInvocations = 0;
|
|
|
|
using var tracerProvider = Sdk.CreateTracerProviderBuilder()
|
|
.ConfigureServices(services =>
|
|
{
|
|
services.Configure<OtlpExporterOptions>(o => defaultExporterOptionsConfigureOptionsInvocations++);
|
|
|
|
services.Configure<OtlpExporterOptions>("Exporter2", o => namedExporterOptionsConfigureOptionsInvocations++);
|
|
})
|
|
.AddOtlpExporter()
|
|
.AddOtlpExporter("Exporter2", o => { })
|
|
.Build();
|
|
|
|
Assert.Equal(1, defaultExporterOptionsConfigureOptionsInvocations);
|
|
Assert.Equal(1, namedExporterOptionsConfigureOptionsInvocations);
|
|
}
|
|
|
|
[Fact]
|
|
public void OtlpExporter_BadArgs()
|
|
{
|
|
TracerProviderBuilder builder = null;
|
|
Assert.Throws<ArgumentNullException>(() => builder.AddOtlpExporter());
|
|
}
|
|
|
|
[Fact]
|
|
public void UserHttpFactoryCalled()
|
|
{
|
|
OtlpExporterOptions options = new OtlpExporterOptions();
|
|
|
|
var defaultFactory = options.HttpClientFactory;
|
|
|
|
int invocations = 0;
|
|
options.Protocol = OtlpExportProtocol.HttpProtobuf;
|
|
options.HttpClientFactory = () =>
|
|
{
|
|
invocations++;
|
|
return defaultFactory();
|
|
};
|
|
|
|
using (var exporter = new OtlpTraceExporter(options))
|
|
{
|
|
Assert.Equal(1, invocations);
|
|
}
|
|
|
|
using (var provider = Sdk.CreateTracerProviderBuilder()
|
|
.AddOtlpExporter(o =>
|
|
{
|
|
o.Protocol = OtlpExportProtocol.HttpProtobuf;
|
|
o.HttpClientFactory = options.HttpClientFactory;
|
|
})
|
|
.Build())
|
|
{
|
|
Assert.Equal(2, invocations);
|
|
}
|
|
|
|
options.HttpClientFactory = null;
|
|
Assert.Throws<InvalidOperationException>(() =>
|
|
{
|
|
using var exporter = new OtlpTraceExporter(options);
|
|
});
|
|
|
|
options.HttpClientFactory = () => null;
|
|
Assert.Throws<InvalidOperationException>(() =>
|
|
{
|
|
using var exporter = new OtlpTraceExporter(options);
|
|
});
|
|
}
|
|
|
|
[Fact]
|
|
public void ServiceProviderHttpClientFactoryInvoked()
|
|
{
|
|
IServiceCollection services = new ServiceCollection();
|
|
|
|
services.AddHttpClient();
|
|
|
|
int invocations = 0;
|
|
|
|
services.AddHttpClient("OtlpTraceExporter", configureClient: (client) => invocations++);
|
|
|
|
services.AddOpenTelemetry().WithTracing(builder => builder
|
|
.AddOtlpExporter(o => o.Protocol = OtlpExportProtocol.HttpProtobuf));
|
|
|
|
using var serviceProvider = services.BuildServiceProvider();
|
|
|
|
var tracerProvider = serviceProvider.GetRequiredService<TracerProvider>();
|
|
|
|
Assert.Equal(1, invocations);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData(true)]
|
|
[InlineData(false)]
|
|
public void ToOtlpResourceSpansTest(bool includeServiceNameInResource)
|
|
{
|
|
var evenTags = new[] { new KeyValuePair<string, object>("k0", "v0") };
|
|
var oddTags = new[] { new KeyValuePair<string, object>("k1", "v1") };
|
|
var sources = new[]
|
|
{
|
|
new ActivitySource("even", "2.4.6"),
|
|
new ActivitySource("odd", "1.3.5"),
|
|
};
|
|
|
|
var resourceBuilder = ResourceBuilder.CreateEmpty();
|
|
if (includeServiceNameInResource)
|
|
{
|
|
resourceBuilder.AddService("service-name", "ns1");
|
|
}
|
|
|
|
var exportedItems = new List<Activity>();
|
|
var builder = Sdk.CreateTracerProviderBuilder()
|
|
.SetResourceBuilder(resourceBuilder)
|
|
.AddSource(sources[0].Name)
|
|
.AddSource(sources[1].Name)
|
|
.AddProcessor(new SimpleActivityExportProcessor(new InMemoryExporter<Activity>(exportedItems)));
|
|
|
|
using var openTelemetrySdk = builder.Build();
|
|
|
|
const int numOfSpans = 10;
|
|
bool isEven;
|
|
for (var i = 0; i < numOfSpans; i++)
|
|
{
|
|
isEven = i % 2 == 0;
|
|
var source = sources[i % 2];
|
|
var activityKind = isEven ? ActivityKind.Client : ActivityKind.Server;
|
|
var activityTags = isEven ? evenTags : oddTags;
|
|
|
|
using Activity activity = source.StartActivity($"span-{i}", activityKind, parentContext: default, activityTags);
|
|
}
|
|
|
|
Assert.Equal(10, exportedItems.Count);
|
|
var batch = new Batch<Activity>(exportedItems.ToArray(), exportedItems.Count);
|
|
RunTest(DefaultSdkLimitOptions, batch);
|
|
|
|
void RunTest(SdkLimitOptions sdkOptions, Batch<Activity> batch)
|
|
{
|
|
var request = new OtlpCollector.ExportTraceServiceRequest();
|
|
|
|
request.AddBatch(sdkOptions, resourceBuilder.Build().ToOtlpResource(), batch);
|
|
|
|
Assert.Single(request.ResourceSpans);
|
|
var otlpResource = request.ResourceSpans.First().Resource;
|
|
if (includeServiceNameInResource)
|
|
{
|
|
Assert.Contains(otlpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceName && kvp.Value.StringValue == "service-name");
|
|
Assert.Contains(otlpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceNamespace && kvp.Value.StringValue == "ns1");
|
|
}
|
|
else
|
|
{
|
|
Assert.Contains(otlpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceName && kvp.Value.ToString().Contains("unknown_service:"));
|
|
}
|
|
|
|
var scopeSpans = request.ResourceSpans.First().ScopeSpans;
|
|
Assert.Equal(2, scopeSpans.Count);
|
|
foreach (var scope in scopeSpans)
|
|
{
|
|
Assert.Equal(numOfSpans / 2, scope.Spans.Count);
|
|
Assert.NotNull(scope.Scope);
|
|
|
|
var expectedSpanNames = new List<string>();
|
|
var start = scope.Scope.Name == "even" ? 0 : 1;
|
|
for (var i = start; i < numOfSpans; i += 2)
|
|
{
|
|
expectedSpanNames.Add($"span-{i}");
|
|
}
|
|
|
|
var otlpSpans = scope.Spans;
|
|
Assert.Equal(expectedSpanNames.Count, otlpSpans.Count);
|
|
|
|
var kv0 = new OtlpCommon.KeyValue { Key = "k0", Value = new OtlpCommon.AnyValue { StringValue = "v0" } };
|
|
var kv1 = new OtlpCommon.KeyValue { Key = "k1", Value = new OtlpCommon.AnyValue { StringValue = "v1" } };
|
|
|
|
var expectedTag = scope.Scope.Name == "even"
|
|
? kv0
|
|
: kv1;
|
|
|
|
foreach (var otlpSpan in otlpSpans)
|
|
{
|
|
Assert.Contains(otlpSpan.Name, expectedSpanNames);
|
|
Assert.Contains(expectedTag, otlpSpan.Attributes);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void SpanLimitsTest()
|
|
{
|
|
var sdkOptions = new SdkLimitOptions()
|
|
{
|
|
AttributeValueLengthLimit = 4,
|
|
AttributeCountLimit = 3,
|
|
SpanEventCountLimit = 1,
|
|
SpanLinkCountLimit = 1,
|
|
};
|
|
|
|
var tags = new ActivityTagsCollection()
|
|
{
|
|
new KeyValuePair<string, object>("TruncatedTag", "12345"),
|
|
new KeyValuePair<string, object>("TruncatedStringArray", new string[] { "12345", "1234", string.Empty, null }),
|
|
new KeyValuePair<string, object>("TruncatedObjectTag", new object()),
|
|
new KeyValuePair<string, object>("OneTagTooMany", 1),
|
|
};
|
|
|
|
var links = new[]
|
|
{
|
|
new ActivityLink(default, tags),
|
|
new ActivityLink(default, tags),
|
|
};
|
|
|
|
using var activitySource = new ActivitySource(nameof(this.SpanLimitsTest));
|
|
using var activity = activitySource.StartActivity("root", ActivityKind.Server, default(ActivityContext), tags, links);
|
|
|
|
var event1 = new ActivityEvent("Event", DateTime.UtcNow, tags);
|
|
var event2 = new ActivityEvent("OneEventTooMany", DateTime.Now, tags);
|
|
|
|
activity.AddEvent(event1);
|
|
activity.AddEvent(event2);
|
|
|
|
var otlpSpan = activity.ToOtlpSpan(sdkOptions);
|
|
|
|
Assert.NotNull(otlpSpan);
|
|
Assert.Equal(3, otlpSpan.Attributes.Count);
|
|
Assert.Equal(1u, otlpSpan.DroppedAttributesCount);
|
|
Assert.Equal("1234", otlpSpan.Attributes[0].Value.StringValue);
|
|
ArrayValueAsserts(otlpSpan.Attributes[1].Value.ArrayValue.Values);
|
|
Assert.Equal(new object().ToString().Substring(0, 4), otlpSpan.Attributes[2].Value.StringValue);
|
|
|
|
Assert.Single(otlpSpan.Events);
|
|
Assert.Equal(1u, otlpSpan.DroppedEventsCount);
|
|
Assert.Equal(3, otlpSpan.Events[0].Attributes.Count);
|
|
Assert.Equal(1u, otlpSpan.Events[0].DroppedAttributesCount);
|
|
Assert.Equal("1234", otlpSpan.Events[0].Attributes[0].Value.StringValue);
|
|
ArrayValueAsserts(otlpSpan.Events[0].Attributes[1].Value.ArrayValue.Values);
|
|
Assert.Equal(new object().ToString().Substring(0, 4), otlpSpan.Events[0].Attributes[2].Value.StringValue);
|
|
|
|
Assert.Single(otlpSpan.Links);
|
|
Assert.Equal(1u, otlpSpan.DroppedLinksCount);
|
|
Assert.Equal(3, otlpSpan.Links[0].Attributes.Count);
|
|
Assert.Equal(1u, otlpSpan.Links[0].DroppedAttributesCount);
|
|
Assert.Equal("1234", otlpSpan.Links[0].Attributes[0].Value.StringValue);
|
|
ArrayValueAsserts(otlpSpan.Links[0].Attributes[1].Value.ArrayValue.Values);
|
|
Assert.Equal(new object().ToString().Substring(0, 4), otlpSpan.Links[0].Attributes[2].Value.StringValue);
|
|
|
|
void ArrayValueAsserts(RepeatedField<OtlpCommon.AnyValue> values)
|
|
{
|
|
var expectedStringArray = new string[] { "1234", "1234", string.Empty, null };
|
|
for (var i = 0; i < expectedStringArray.Length; ++i)
|
|
{
|
|
var expectedValue = expectedStringArray[i];
|
|
var expectedValueCase = expectedValue != null
|
|
? OtlpCommon.AnyValue.ValueOneofCase.StringValue
|
|
: OtlpCommon.AnyValue.ValueOneofCase.None;
|
|
|
|
var actual = values[i];
|
|
Assert.Equal(expectedValueCase, actual.ValueCase);
|
|
if (expectedValueCase != OtlpCommon.AnyValue.ValueOneofCase.None)
|
|
{
|
|
Assert.Equal(expectedValue, actual.StringValue);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void ToOtlpSpanTest()
|
|
{
|
|
using var activitySource = new ActivitySource(nameof(this.ToOtlpSpanTest));
|
|
|
|
using var rootActivity = activitySource.StartActivity("root", ActivityKind.Producer);
|
|
|
|
var attributes = new List<KeyValuePair<string, object>>
|
|
{
|
|
new KeyValuePair<string, object>("bool", true),
|
|
new KeyValuePair<string, object>("long", 1L),
|
|
new KeyValuePair<string, object>("string", "text"),
|
|
new KeyValuePair<string, object>("double", 3.14),
|
|
new KeyValuePair<string, object>("int", 1),
|
|
new KeyValuePair<string, object>("datetime", DateTime.UtcNow),
|
|
new KeyValuePair<string, object>("bool_array", new bool[] { true, false }),
|
|
new KeyValuePair<string, object>("int_array", new int[] { 1, 2 }),
|
|
new KeyValuePair<string, object>("double_array", new double[] { 1.0, 2.09 }),
|
|
new KeyValuePair<string, object>("string_array", new string[] { "a", "b" }),
|
|
};
|
|
|
|
foreach (var kvp in attributes)
|
|
{
|
|
rootActivity.SetTag(kvp.Key, kvp.Value);
|
|
}
|
|
|
|
var startTime = new DateTime(2020, 02, 20, 20, 20, 20, DateTimeKind.Utc);
|
|
|
|
DateTimeOffset dateTimeOffset;
|
|
dateTimeOffset = DateTimeOffset.FromUnixTimeMilliseconds(0);
|
|
|
|
var expectedUnixTimeTicks = (ulong)(startTime.Ticks - dateTimeOffset.Ticks);
|
|
var duration = TimeSpan.FromMilliseconds(1555);
|
|
|
|
rootActivity.SetStartTime(startTime);
|
|
rootActivity.SetEndTime(startTime + duration);
|
|
|
|
Span<byte> traceIdSpan = stackalloc byte[16];
|
|
rootActivity.TraceId.CopyTo(traceIdSpan);
|
|
var traceId = traceIdSpan.ToArray();
|
|
|
|
var otlpSpan = rootActivity.ToOtlpSpan(DefaultSdkLimitOptions);
|
|
|
|
Assert.NotNull(otlpSpan);
|
|
Assert.Equal("root", otlpSpan.Name);
|
|
Assert.Equal(OtlpTrace.Span.Types.SpanKind.Producer, otlpSpan.Kind);
|
|
Assert.Equal(traceId, otlpSpan.TraceId);
|
|
Assert.Empty(otlpSpan.ParentSpanId);
|
|
Assert.Null(otlpSpan.Status);
|
|
Assert.Empty(otlpSpan.Events);
|
|
Assert.Empty(otlpSpan.Links);
|
|
OtlpTestHelpers.AssertOtlpAttributes(attributes, otlpSpan.Attributes);
|
|
|
|
var expectedStartTimeUnixNano = 100 * expectedUnixTimeTicks;
|
|
Assert.Equal(expectedStartTimeUnixNano, otlpSpan.StartTimeUnixNano);
|
|
var expectedEndTimeUnixNano = expectedStartTimeUnixNano + (duration.TotalMilliseconds * 1_000_000);
|
|
Assert.Equal(expectedEndTimeUnixNano, otlpSpan.EndTimeUnixNano);
|
|
|
|
var childLinks = new List<ActivityLink> { new ActivityLink(rootActivity.Context, new ActivityTagsCollection(attributes)) };
|
|
var childActivity = activitySource.StartActivity(
|
|
"child",
|
|
ActivityKind.Client,
|
|
rootActivity.Context,
|
|
links: childLinks);
|
|
|
|
childActivity.SetStatus(Status.Error);
|
|
|
|
var childEvents = new List<ActivityEvent> { new ActivityEvent("e0"), new ActivityEvent("e1", default, new ActivityTagsCollection(attributes)) };
|
|
childActivity.AddEvent(childEvents[0]);
|
|
childActivity.AddEvent(childEvents[1]);
|
|
|
|
Span<byte> parentIdSpan = stackalloc byte[8];
|
|
rootActivity.Context.SpanId.CopyTo(parentIdSpan);
|
|
var parentId = parentIdSpan.ToArray();
|
|
|
|
otlpSpan = childActivity.ToOtlpSpan(DefaultSdkLimitOptions);
|
|
|
|
Assert.NotNull(otlpSpan);
|
|
Assert.Equal("child", otlpSpan.Name);
|
|
Assert.Equal(OtlpTrace.Span.Types.SpanKind.Client, otlpSpan.Kind);
|
|
Assert.Equal(traceId, otlpSpan.TraceId);
|
|
Assert.Equal(parentId, otlpSpan.ParentSpanId);
|
|
|
|
// Assert.Equal(OtlpTrace.Status.Types.StatusCode.NotFound, otlpSpan.Status.Code);
|
|
|
|
Assert.Equal(Status.Error.Description ?? string.Empty, otlpSpan.Status.Message);
|
|
Assert.Empty(otlpSpan.Attributes);
|
|
|
|
Assert.Equal(childEvents.Count, otlpSpan.Events.Count);
|
|
for (var i = 0; i < childEvents.Count; i++)
|
|
{
|
|
Assert.Equal(childEvents[i].Name, otlpSpan.Events[i].Name);
|
|
OtlpTestHelpers.AssertOtlpAttributes(childEvents[i].Tags.ToList(), otlpSpan.Events[i].Attributes);
|
|
}
|
|
|
|
childLinks.Reverse();
|
|
Assert.Equal(childLinks.Count, otlpSpan.Links.Count);
|
|
for (var i = 0; i < childLinks.Count; i++)
|
|
{
|
|
OtlpTestHelpers.AssertOtlpAttributes(childLinks[i].Tags.ToList(), otlpSpan.Links[i].Attributes);
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void ToOtlpSpanActivitiesWithNullArrayTest()
|
|
{
|
|
using var activitySource = new ActivitySource(nameof(this.ToOtlpSpanTest));
|
|
|
|
using var rootActivity = activitySource.StartActivity("root", ActivityKind.Client);
|
|
Assert.NotNull(rootActivity);
|
|
|
|
var stringArr = new string[] { "test", string.Empty, null };
|
|
rootActivity.SetTag("stringArray", stringArr);
|
|
|
|
var otlpSpan = rootActivity.ToOtlpSpan(DefaultSdkLimitOptions);
|
|
|
|
Assert.NotNull(otlpSpan);
|
|
|
|
var stringArray = otlpSpan.Attributes.FirstOrDefault(kvp => kvp.Key == "stringArray");
|
|
|
|
Assert.NotNull(stringArray);
|
|
Assert.Equal("test", stringArray.Value.ArrayValue.Values[0].StringValue);
|
|
Assert.Equal(string.Empty, stringArray.Value.ArrayValue.Values[1].StringValue);
|
|
Assert.Equal(OtlpCommon.AnyValue.ValueOneofCase.None, stringArray.Value.ArrayValue.Values[2].ValueCase);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData(ActivityStatusCode.Unset, "Description will be ignored if status is Unset.")]
|
|
[InlineData(ActivityStatusCode.Ok, "Description will be ignored if status is Okay.")]
|
|
[InlineData(ActivityStatusCode.Error, "Description will be kept if status is Error.")]
|
|
public void ToOtlpSpanNativeActivityStatusTest(ActivityStatusCode expectedStatusCode, string statusDescription)
|
|
{
|
|
using var activitySource = new ActivitySource(nameof(this.ToOtlpSpanTest));
|
|
using var activity = activitySource.StartActivity("Name");
|
|
activity.SetStatus(expectedStatusCode, statusDescription);
|
|
|
|
var otlpSpan = activity.ToOtlpSpan(DefaultSdkLimitOptions);
|
|
|
|
if (expectedStatusCode == ActivityStatusCode.Unset)
|
|
{
|
|
Assert.Null(otlpSpan.Status);
|
|
}
|
|
else
|
|
{
|
|
Assert.NotNull(otlpSpan.Status);
|
|
Assert.Equal((int)expectedStatusCode, (int)otlpSpan.Status.Code);
|
|
if (expectedStatusCode == ActivityStatusCode.Error)
|
|
{
|
|
Assert.Equal(statusDescription, otlpSpan.Status.Message);
|
|
}
|
|
|
|
if (expectedStatusCode == ActivityStatusCode.Ok)
|
|
{
|
|
Assert.Empty(otlpSpan.Status.Message);
|
|
}
|
|
}
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData(StatusCode.Unset, "Unset", "Description will be ignored if status is Unset.")]
|
|
[InlineData(StatusCode.Ok, "Ok", "Description must only be used with the Error StatusCode.")]
|
|
[InlineData(StatusCode.Error, "Error", "Error description.")]
|
|
public void ToOtlpSpanStatusTagTest(StatusCode expectedStatusCode, string statusCodeTagValue, string statusDescription)
|
|
{
|
|
using var activitySource = new ActivitySource(nameof(this.ToOtlpSpanTest));
|
|
using var activity = activitySource.StartActivity("Name");
|
|
activity.SetTag(SpanAttributeConstants.StatusCodeKey, statusCodeTagValue);
|
|
activity.SetTag(SpanAttributeConstants.StatusDescriptionKey, statusDescription);
|
|
|
|
var otlpSpan = activity.ToOtlpSpan(DefaultSdkLimitOptions);
|
|
|
|
Assert.NotNull(otlpSpan.Status);
|
|
Assert.Equal((int)expectedStatusCode, (int)otlpSpan.Status.Code);
|
|
|
|
if (expectedStatusCode == StatusCode.Error)
|
|
{
|
|
Assert.Equal(statusDescription, otlpSpan.Status.Message);
|
|
}
|
|
else
|
|
{
|
|
Assert.Empty(otlpSpan.Status.Message);
|
|
}
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData(StatusCode.Unset, "uNsET")]
|
|
[InlineData(StatusCode.Ok, "oK")]
|
|
[InlineData(StatusCode.Error, "ERROR")]
|
|
public void ToOtlpSpanStatusTagIsCaseInsensitiveTest(StatusCode expectedStatusCode, string statusCodeTagValue)
|
|
{
|
|
using var activitySource = new ActivitySource(nameof(this.ToOtlpSpanTest));
|
|
using var activity = activitySource.StartActivity("Name");
|
|
activity.SetTag(SpanAttributeConstants.StatusCodeKey, statusCodeTagValue);
|
|
|
|
var otlpSpan = activity.ToOtlpSpan(DefaultSdkLimitOptions);
|
|
|
|
Assert.NotNull(otlpSpan.Status);
|
|
Assert.Equal((int)expectedStatusCode, (int)otlpSpan.Status.Code);
|
|
}
|
|
|
|
[Fact]
|
|
public void ToOtlpSpanActivityStatusTakesPrecedenceOverStatusTagsWhenActivityStatusCodeIsOk()
|
|
{
|
|
using var activitySource = new ActivitySource(nameof(this.ToOtlpSpanTest));
|
|
using var activity = activitySource.StartActivity("Name");
|
|
const string TagDescriptionOnError = "Description when TagStatusCode is Error.";
|
|
activity.SetStatus(ActivityStatusCode.Ok);
|
|
activity.SetTag(SpanAttributeConstants.StatusCodeKey, "ERROR");
|
|
activity.SetTag(SpanAttributeConstants.StatusDescriptionKey, TagDescriptionOnError);
|
|
|
|
var otlpSpan = activity.ToOtlpSpan(DefaultSdkLimitOptions);
|
|
|
|
Assert.NotNull(otlpSpan.Status);
|
|
Assert.Equal((int)ActivityStatusCode.Ok, (int)otlpSpan.Status.Code);
|
|
Assert.Empty(otlpSpan.Status.Message);
|
|
}
|
|
|
|
[Fact]
|
|
public void ToOtlpSpanActivityStatusTakesPrecedenceOverStatusTagsWhenActivityStatusCodeIsError()
|
|
{
|
|
using var activitySource = new ActivitySource(nameof(this.ToOtlpSpanTest));
|
|
using var activity = activitySource.StartActivity("Name");
|
|
const string StatusDescriptionOnError = "Description when ActivityStatusCode is Error.";
|
|
activity.SetStatus(ActivityStatusCode.Error, StatusDescriptionOnError);
|
|
activity.SetTag(SpanAttributeConstants.StatusCodeKey, "OK");
|
|
|
|
var otlpSpan = activity.ToOtlpSpan(DefaultSdkLimitOptions);
|
|
|
|
Assert.NotNull(otlpSpan.Status);
|
|
Assert.Equal((int)ActivityStatusCode.Error, (int)otlpSpan.Status.Code);
|
|
Assert.Equal(StatusDescriptionOnError, otlpSpan.Status.Message);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData(true)]
|
|
[InlineData(false)]
|
|
public void ToOtlpSpanTraceStateTest(bool traceStateWasSet)
|
|
{
|
|
using var activitySource = new ActivitySource(nameof(this.ToOtlpSpanTest));
|
|
using var activity = activitySource.StartActivity("Name");
|
|
string tracestate = "a=b;c=d";
|
|
if (traceStateWasSet)
|
|
{
|
|
activity.TraceStateString = tracestate;
|
|
}
|
|
|
|
var otlpSpan = activity.ToOtlpSpan(DefaultSdkLimitOptions);
|
|
|
|
if (traceStateWasSet)
|
|
{
|
|
Assert.NotNull(otlpSpan.TraceState);
|
|
Assert.Equal(tracestate, otlpSpan.TraceState);
|
|
}
|
|
else
|
|
{
|
|
Assert.Equal(string.Empty, otlpSpan.TraceState);
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void ToOtlpSpanPeerServiceTest()
|
|
{
|
|
using var activitySource = new ActivitySource(nameof(this.ToOtlpSpanTest));
|
|
|
|
using var rootActivity = activitySource.StartActivity("root", ActivityKind.Client);
|
|
|
|
rootActivity.SetTag(SemanticConventions.AttributeHttpHost, "opentelemetry.io");
|
|
|
|
var otlpSpan = rootActivity.ToOtlpSpan(DefaultSdkLimitOptions);
|
|
|
|
Assert.NotNull(otlpSpan);
|
|
|
|
var peerService = otlpSpan.Attributes.FirstOrDefault(kvp => kvp.Key == SemanticConventions.AttributePeerService);
|
|
|
|
Assert.NotNull(peerService);
|
|
Assert.Equal("opentelemetry.io", peerService.Value.StringValue);
|
|
}
|
|
|
|
[Fact]
|
|
public void UseOpenTelemetryProtocolActivityExporterWithCustomActivityProcessor()
|
|
{
|
|
if (Environment.Version.Major == 3)
|
|
{
|
|
// Adding the OtlpExporter creates a GrpcChannel.
|
|
// This switch must be set before creating a GrpcChannel when calling an insecure HTTP/2 endpoint.
|
|
// See: https://docs.microsoft.com/aspnet/core/grpc/troubleshoot#call-insecure-grpc-services-with-net-core-client
|
|
AppContext.SetSwitch("System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport", true);
|
|
}
|
|
|
|
const string ActivitySourceName = "otlp.test";
|
|
TestActivityProcessor testActivityProcessor = new TestActivityProcessor();
|
|
|
|
bool startCalled = false;
|
|
bool endCalled = false;
|
|
|
|
testActivityProcessor.StartAction =
|
|
(a) =>
|
|
{
|
|
startCalled = true;
|
|
};
|
|
|
|
testActivityProcessor.EndAction =
|
|
(a) =>
|
|
{
|
|
endCalled = true;
|
|
};
|
|
|
|
var tracerProvider = Sdk.CreateTracerProviderBuilder()
|
|
.AddSource(ActivitySourceName)
|
|
.AddProcessor(testActivityProcessor)
|
|
.AddOtlpExporter()
|
|
.Build();
|
|
|
|
using var source = new ActivitySource(ActivitySourceName);
|
|
var activity = source.StartActivity("Test Otlp Activity");
|
|
activity?.Stop();
|
|
|
|
Assert.True(startCalled);
|
|
Assert.True(endCalled);
|
|
}
|
|
|
|
[Fact]
|
|
public void Shutdown_ClientShutdownIsCalled()
|
|
{
|
|
var exportClientMock = new Mock<IExportClient<OtlpCollector.ExportTraceServiceRequest>>();
|
|
|
|
var exporter = new OtlpTraceExporter(new OtlpExporterOptions(), DefaultSdkLimitOptions, exportClientMock.Object);
|
|
|
|
var result = exporter.Shutdown();
|
|
|
|
exportClientMock.Verify(m => m.Shutdown(It.IsAny<int>()), Times.Once());
|
|
}
|
|
|
|
[Fact]
|
|
public void Null_BatchExportProcessorOptions_SupportedTest()
|
|
{
|
|
Sdk.CreateTracerProviderBuilder()
|
|
.AddOtlpExporter(
|
|
o =>
|
|
{
|
|
o.Protocol = OtlpExportProtocol.HttpProtobuf;
|
|
o.ExportProcessorType = ExportProcessorType.Batch;
|
|
o.BatchExportProcessorOptions = null;
|
|
});
|
|
}
|
|
|
|
[Fact]
|
|
public void NonnamedOptionsMutateSharedInstanceTest()
|
|
{
|
|
var testOptionsInstance = new OtlpExporterOptions();
|
|
|
|
OtlpExporterOptions tracerOptions = null;
|
|
OtlpExporterOptions meterOptions = null;
|
|
|
|
var services = new ServiceCollection();
|
|
|
|
services.AddOpenTelemetry()
|
|
.WithTracing(builder => builder.AddOtlpExporter(o =>
|
|
{
|
|
Assert.Equal(testOptionsInstance.Endpoint, o.Endpoint);
|
|
|
|
tracerOptions = o;
|
|
o.Endpoint = new("http://localhost/traces");
|
|
}))
|
|
.WithMetrics(builder => builder.AddOtlpExporter(o =>
|
|
{
|
|
Assert.Equal(testOptionsInstance.Endpoint, o.Endpoint);
|
|
|
|
meterOptions = o;
|
|
o.Endpoint = new("http://localhost/metrics");
|
|
}));
|
|
|
|
using var serviceProvider = services.BuildServiceProvider();
|
|
|
|
var tracerProvider = serviceProvider.GetRequiredService<TracerProvider>();
|
|
|
|
// Verify the OtlpTraceExporter saw the correct endpoint.
|
|
|
|
Assert.NotNull(tracerOptions);
|
|
Assert.Null(meterOptions);
|
|
Assert.Equal("http://localhost/traces", tracerOptions.Endpoint.OriginalString);
|
|
|
|
var meterProvider = serviceProvider.GetRequiredService<MeterProvider>();
|
|
|
|
// Verify the OtlpMetricExporter saw the correct endpoint.
|
|
|
|
Assert.NotNull(tracerOptions);
|
|
Assert.NotNull(meterOptions);
|
|
Assert.Equal("http://localhost/metrics", meterOptions.Endpoint.OriginalString);
|
|
|
|
Assert.False(ReferenceEquals(tracerOptions, meterOptions));
|
|
}
|
|
|
|
[Fact]
|
|
public void NamedOptionsMutateSeparateInstancesTest()
|
|
{
|
|
OtlpExporterOptions tracerOptions = null;
|
|
OtlpExporterOptions meterOptions = null;
|
|
|
|
var services = new ServiceCollection();
|
|
|
|
services.AddOpenTelemetry()
|
|
.WithTracing(builder => builder.AddOtlpExporter("Trace", o =>
|
|
{
|
|
tracerOptions = o;
|
|
o.Endpoint = new("http://localhost/traces");
|
|
}))
|
|
.WithMetrics(builder => builder.AddOtlpExporter("Metrics", o =>
|
|
{
|
|
meterOptions = o;
|
|
o.Endpoint = new("http://localhost/metrics");
|
|
}));
|
|
|
|
using var serviceProvider = services.BuildServiceProvider();
|
|
|
|
var tracerProvider = serviceProvider.GetRequiredService<TracerProvider>();
|
|
|
|
// Verify the OtlpTraceExporter saw the correct endpoint.
|
|
|
|
Assert.NotNull(tracerOptions);
|
|
Assert.Null(meterOptions);
|
|
Assert.Equal("http://localhost/traces", tracerOptions.Endpoint.OriginalString);
|
|
|
|
var meterProvider = serviceProvider.GetRequiredService<MeterProvider>();
|
|
|
|
// Verify the OtlpMetricExporter saw the correct endpoint.
|
|
|
|
Assert.NotNull(tracerOptions);
|
|
Assert.NotNull(meterOptions);
|
|
Assert.Equal("http://localhost/metrics", meterOptions.Endpoint.OriginalString);
|
|
|
|
// Verify expected state of instances.
|
|
|
|
Assert.False(ReferenceEquals(tracerOptions, meterOptions));
|
|
Assert.Equal("http://localhost/traces", tracerOptions.Endpoint.OriginalString);
|
|
Assert.Equal("http://localhost/metrics", meterOptions.Endpoint.OriginalString);
|
|
}
|
|
}
|
|
}
|