opentelemetry-dotnet/test/OpenTelemetry.Tests/Trace/SamplersTest.cs

// <copyright file="SamplersTest.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 OpenTelemetry.Tests;
using Xunit;

namespace OpenTelemetry.Trace.Tests
{
    public class SamplersTest
    {
        private const string ActivitySourceName = "SamplerTest";
        private static readonly ActivityKind ActivityKindServer = ActivityKind.Server;
        private readonly ActivityTraceId traceId;
        private readonly ActivitySpanId spanId;
        private readonly ActivitySpanId parentSpanId;

        public SamplersTest()
        {
            this.traceId = ActivityTraceId.CreateRandom();
            this.spanId = ActivitySpanId.CreateRandom();
            this.parentSpanId = ActivitySpanId.CreateRandom();
        }

        [Theory]
        [InlineData(ActivityTraceFlags.Recorded)]
        [InlineData(ActivityTraceFlags.None)]
        public void AlwaysOnSampler_AlwaysReturnTrue(ActivityTraceFlags flags)
        {
            var parentContext = new ActivityContext(this.traceId, this.parentSpanId, flags);
            var link = new ActivityLink(parentContext);

            Assert.Equal(
                SamplingDecision.RecordAndSample,
                new AlwaysOnSampler().ShouldSample(new SamplingParameters(parentContext, this.traceId, "Another name", ActivityKindServer, null, new List<ActivityLink> { link })).Decision);
        }

        [Fact]
        public void AlwaysOnSampler_GetDescription()
        {
            Assert.Equal("AlwaysOnSampler", new AlwaysOnSampler().Description);
        }

        [Theory]
        [InlineData(ActivityTraceFlags.Recorded)]
        [InlineData(ActivityTraceFlags.None)]
        public void AlwaysOffSampler_AlwaysReturnFalse(ActivityTraceFlags flags)
        {
            var parentContext = new ActivityContext(this.traceId, this.parentSpanId, flags);
            var link = new ActivityLink(parentContext);

            Assert.Equal(
                SamplingDecision.Drop,
                new AlwaysOffSampler().ShouldSample(new SamplingParameters(parentContext, this.traceId, "Another name", ActivityKindServer, null, new List<ActivityLink> { link })).Decision);
        }

        [Fact]
        public void AlwaysOffSampler_GetDescription()
        {
            Assert.Equal("AlwaysOffSampler", new AlwaysOffSampler().Description);
        }

        [Theory]
        [InlineData(SamplingDecision.Drop)]
        [InlineData(SamplingDecision.RecordOnly)]
        [InlineData(SamplingDecision.RecordAndSample)]
        public void TracerProviderSdkSamplerAttributesAreAppliedToLegacyActivity(SamplingDecision samplingDecision)
        {
            var testSampler = new TestSampler
            {
                SamplingAction = (samplingParams) =>
                {
                    var attributes = new Dictionary<string, object>
                    {
                        { "tagkeybysampler", "tagvalueaddedbysampler" },
                    };
                    return new SamplingResult(samplingDecision, attributes);
                },
            };

            var operationNameForLegacyActivity = "TestOperationName";
            using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                        .SetSampler(testSampler)
                        .AddLegacySource(operationNameForLegacyActivity)
                        .Build();

            Activity activity = new Activity(operationNameForLegacyActivity);
            activity.Start();
            Assert.NotNull(activity);
            if (samplingDecision != SamplingDecision.Drop)
            {
                Assert.Contains(new KeyValuePair<string, object>("tagkeybysampler", "tagvalueaddedbysampler"), activity.TagObjects);
            }

            activity.Stop();
        }

        [Theory]
        [InlineData(SamplingDecision.Drop)]
        [InlineData(SamplingDecision.RecordOnly)]
        [InlineData(SamplingDecision.RecordAndSample)]
        public void SamplersCanModifyTraceStateOnLegacyActivity(SamplingDecision samplingDecision)
        {
            var existingTraceState = "a=1,b=2";
            var newTraceState = "a=1,b=2,c=3,d=4";
            var testSampler = new TestSampler
            {
                SamplingAction = (samplingParams) =>
                {
                    Assert.Equal(existingTraceState, samplingParams.ParentContext.TraceState);
                    return new SamplingResult(samplingDecision, newTraceState);
                },
            };

            var operationNameForLegacyActivity = "TestOperationName";
            using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                        .SetSampler(testSampler)
                        .AddLegacySource(operationNameForLegacyActivity)
                        .Build();

            using var parentActivity = new Activity("Foo");
            parentActivity.TraceStateString = existingTraceState;
            parentActivity.Start();

            using var activity = new Activity(operationNameForLegacyActivity);
            activity.Start();
            Assert.NotNull(activity);
            if (samplingDecision != SamplingDecision.Drop)
            {
                Assert.Equal(newTraceState, activity.TraceStateString);
            }

            activity.Stop();
            parentActivity.Stop();
        }

        [Theory]
        [InlineData(SamplingDecision.Drop)]
        [InlineData(SamplingDecision.RecordOnly)]
        [InlineData(SamplingDecision.RecordAndSample)]
        public void SamplersDoesNotImpactTraceStateWhenUsingNullLegacyActivity(SamplingDecision samplingDecision)
        {
            var existingTraceState = "a=1,b=2";
            var testSampler = new TestSampler
            {
                SamplingAction = (samplingParams) =>
                {
                    Assert.Equal(existingTraceState, samplingParams.ParentContext.TraceState);
                    return new SamplingResult(samplingDecision);
                },
            };

            var operationNameForLegacyActivity = "TestOperationName";
            using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                        .SetSampler(testSampler)
                        .AddLegacySource(operationNameForLegacyActivity)
                        .Build();

            using var parentActivity = new Activity("Foo");
            parentActivity.TraceStateString = existingTraceState;
            parentActivity.Start();

            using var activity = new Activity(operationNameForLegacyActivity);
            activity.Start();
            Assert.NotNull(activity);
            if (samplingDecision != SamplingDecision.Drop)
            {
                Assert.Equal(existingTraceState, activity.TraceStateString);
            }

            activity.Stop();
            parentActivity.Stop();
        }

        [Theory]
        [InlineData(SamplingDecision.Drop)]
        [InlineData(SamplingDecision.RecordOnly)]
        [InlineData(SamplingDecision.RecordAndSample)]
        public void SamplersCanModifyTraceState(SamplingDecision sampling)
        {
            var parentTraceState = "a=1,b=2";
            var newTraceState = "a=1,b=2,c=3,d=4";
            var testSampler = new TestSampler
            {
                SamplingAction = (samplingParams) =>
                {
                    Assert.Equal(parentTraceState, samplingParams.ParentContext.TraceState);
                    return new SamplingResult(sampling, newTraceState);
                },
            };

            using var activitySource = new ActivitySource(ActivitySourceName);
            using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                .AddSource(ActivitySourceName)
                .SetSampler(testSampler)
                .Build();

            var parentContext = new ActivityContext(ActivityTraceId.CreateRandom(), ActivitySpanId.CreateRandom(), ActivityTraceFlags.Recorded, parentTraceState, true);

            using var activity = activitySource.StartActivity("root", ActivityKind.Server, parentContext);
            if (sampling != SamplingDecision.Drop)
            {
                Assert.Equal(newTraceState, activity.TraceStateString);
            }
        }

        [Theory]
        [InlineData(SamplingDecision.Drop)]
        [InlineData(SamplingDecision.RecordOnly)]
        [InlineData(SamplingDecision.RecordAndSample)]
        public void SamplersDoesNotImpactTraceStateWhenUsingNull(SamplingDecision sampling)
        {
            var parentTraceState = "a=1,b=2";
            var testSampler = new TestSampler
            {
                SamplingAction = (samplingParams) =>
                {
                    Assert.Equal(parentTraceState, samplingParams.ParentContext.TraceState);

                    // Not explicitly setting tracestate, leaving it null.
                    // backward compat test that existing
                    // samplers will not inadvertently
                    // reset Tracestate
                    return new SamplingResult(sampling);
                },
            };

            using var activitySource = new ActivitySource(ActivitySourceName);
            using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                .AddSource(ActivitySourceName)
                .SetSampler(testSampler)
                .Build();

            var parentContext = new ActivityContext(ActivityTraceId.CreateRandom(), ActivitySpanId.CreateRandom(), ActivityTraceFlags.Recorded, parentTraceState, true);

            using var activity = activitySource.StartActivity("root", ActivityKind.Server, parentContext);
            if (sampling != SamplingDecision.Drop)
            {
                Assert.Equal(parentTraceState, activity.TraceStateString);
            }
        }
    }
}