opentelemetry-dotnet/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/IntegrationTests.cs

// <copyright file="IntegrationTests.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 System.Diagnostics.Metrics;
using System.Diagnostics.Tracing;
using OpenTelemetry.Exporter.OpenTelemetryProtocol.Implementation;
using OpenTelemetry.Metrics;
using OpenTelemetry.Tests;
using OpenTelemetry.Trace;
using Xunit;
using Xunit.Abstractions;

namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests
{
    public sealed class IntegrationTests : IDisposable
    {
        private const string CollectorHostnameEnvVarName = "OTEL_COLLECTOR_HOSTNAME";
        private const int ExportIntervalMilliseconds = 10000;
        private static readonly SdkLimitOptions DefaultSdkLimitOptions = new();
        private static readonly string CollectorHostname = SkipUnlessEnvVarFoundTheoryAttribute.GetEnvironmentVariable(CollectorHostnameEnvVarName);
        private readonly OpenTelemetryEventListener openTelemetryEventListener;

        public IntegrationTests(ITestOutputHelper outputHelper)
        {
            this.openTelemetryEventListener = new(outputHelper);
        }

        public void Dispose()
        {
            this.openTelemetryEventListener.Dispose();
        }

        [InlineData(OtlpExportProtocol.Grpc, ":4317", ExportProcessorType.Batch, false)]
        [InlineData(OtlpExportProtocol.HttpProtobuf, ":4318/v1/traces", ExportProcessorType.Batch, false)]
        [InlineData(OtlpExportProtocol.Grpc, ":4317", ExportProcessorType.Batch, true)]
        [InlineData(OtlpExportProtocol.HttpProtobuf, ":4318/v1/traces", ExportProcessorType.Batch, true)]
        [InlineData(OtlpExportProtocol.Grpc, ":4317", ExportProcessorType.Simple, false)]
        [InlineData(OtlpExportProtocol.HttpProtobuf, ":4318/v1/traces", ExportProcessorType.Simple, false)]
        [InlineData(OtlpExportProtocol.Grpc, ":4317", ExportProcessorType.Simple, true)]
        [InlineData(OtlpExportProtocol.HttpProtobuf, ":4318/v1/traces", ExportProcessorType.Simple, true)]
        [Trait("CategoryName", "CollectorIntegrationTests")]
        [SkipUnlessEnvVarFoundTheory(CollectorHostnameEnvVarName)]
        public void TraceExportResultIsSuccess(OtlpExportProtocol protocol, string endpoint, ExportProcessorType exportProcessorType, bool forceFlush)
        {
            using EventWaitHandle handle = new ManualResetEvent(false);

            var exporterOptions = new OtlpExporterOptions
            {
                Endpoint = new Uri($"http://{CollectorHostname}{endpoint}"),
                Protocol = protocol,
                ExportProcessorType = exportProcessorType,
                BatchExportProcessorOptions = new()
                {
                    ScheduledDelayMilliseconds = ExportIntervalMilliseconds,
                },
            };

            DelegatingExporter<Activity> delegatingExporter = null;
            var exportResults = new List<ExportResult>();

            var activitySourceName = "otlp.collector.test";

            var builder = Sdk.CreateTracerProviderBuilder()
                .AddSource(activitySourceName);

            builder.AddProcessor(OtlpTraceExporterHelperExtensions.BuildOtlpExporterProcessor(
                exporterOptions,
                DefaultSdkLimitOptions,
                serviceProvider: null,
                configureExporterInstance: otlpExporter =>
                {
                    delegatingExporter = new DelegatingExporter<Activity>
                    {
                        OnExportFunc = (batch) =>
                        {
                            var result = otlpExporter.Export(batch);
                            exportResults.Add(result);
                            handle.Set();
                            return result;
                        },
                    };
                    return delegatingExporter;
                }));

            using (var tracerProvider = builder.Build())
            {
                using var source = new ActivitySource(activitySourceName);
                var activity = source.StartActivity($"{protocol} Test Activity");
                activity?.Stop();

                Assert.NotNull(delegatingExporter);

                if (forceFlush)
                {
                    Assert.True(tracerProvider.ForceFlush());
                    Assert.Single(exportResults);
                    Assert.Equal(ExportResult.Success, exportResults[0]);
                }
                else if (exporterOptions.ExportProcessorType == ExportProcessorType.Batch)
                {
                    Assert.True(handle.WaitOne(ExportIntervalMilliseconds * 2));
                    Assert.Single(exportResults);
                    Assert.Equal(ExportResult.Success, exportResults[0]);
                }
            }

            if (!forceFlush && exportProcessorType == ExportProcessorType.Simple)
            {
                Assert.Single(exportResults);
                Assert.Equal(ExportResult.Success, exportResults[0]);
            }
        }

        [InlineData(OtlpExportProtocol.Grpc, ":4317", false, false)]
        [InlineData(OtlpExportProtocol.HttpProtobuf, ":4318/v1/metrics", false, false)]
        [InlineData(OtlpExportProtocol.Grpc, ":4317", false, true)]
        [InlineData(OtlpExportProtocol.HttpProtobuf, ":4318/v1/metrics", false, true)]
        [InlineData(OtlpExportProtocol.Grpc, ":4317", true, false)]
        [InlineData(OtlpExportProtocol.HttpProtobuf, ":4318/v1/metrics", true, false)]
        [InlineData(OtlpExportProtocol.Grpc, ":4317", true, true)]
        [InlineData(OtlpExportProtocol.HttpProtobuf, ":4318/v1/metrics", true, true)]
        [Trait("CategoryName", "CollectorIntegrationTests")]
        [SkipUnlessEnvVarFoundTheory(CollectorHostnameEnvVarName)]
        public void MetricExportResultIsSuccess(OtlpExportProtocol protocol, string endpoint, bool useManualExport, bool forceFlush)
        {
            using EventWaitHandle handle = new ManualResetEvent(false);

            var exporterOptions = new OtlpExporterOptions
            {
                Endpoint = new Uri($"http://{CollectorHostname}{endpoint}"),
                Protocol = protocol,
            };

            DelegatingExporter<Metric> delegatingExporter = null;
            var exportResults = new List<ExportResult>();

            var meterName = "otlp.collector.test";

            var builder = Sdk.CreateMeterProviderBuilder()
                .AddMeter(meterName);

            var readerOptions = new MetricReaderOptions();
            readerOptions.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds = useManualExport ? Timeout.Infinite : ExportIntervalMilliseconds;

            builder.AddReader(OtlpMetricExporterExtensions.BuildOtlpExporterMetricReader(
                exporterOptions,
                readerOptions,
                serviceProvider: null,
                configureExporterInstance: otlpExporter =>
                {
                    delegatingExporter = new DelegatingExporter<Metric>
                    {
                        OnExportFunc = (batch) =>
                        {
                            var result = otlpExporter.Export(batch);
                            exportResults.Add(result);
                            handle.Set();
                            return result;
                        },
                    };
                    return delegatingExporter;
                }));

            using (var meterProvider = builder.Build())
            {
                using var meter = new Meter(meterName);

                var counter = meter.CreateCounter<int>("test_counter");

                counter.Add(18);

                Assert.NotNull(delegatingExporter);

                if (forceFlush)
                {
                    Assert.True(meterProvider.ForceFlush());
                    Assert.Single(exportResults);
                    Assert.Equal(ExportResult.Success, exportResults[0]);
                }
                else if (!useManualExport)
                {
                    Assert.True(handle.WaitOne(ExportIntervalMilliseconds * 2));
                    Assert.Single(exportResults);
                    Assert.Equal(ExportResult.Success, exportResults[0]);
                }
            }

            if (!forceFlush && useManualExport)
            {
                Assert.Single(exportResults);
                Assert.Equal(ExportResult.Success, exportResults[0]);
            }
        }

        [Trait("CategoryName", "CollectorIntegrationTests")]
        [SkipUnlessEnvVarFoundFact(CollectorHostnameEnvVarName)]
        public void ConstructingGrpcExporterFailsWhenHttp2UnencryptedSupportIsDisabledForNetcoreapp31()
        {
            // Adding the OtlpExporter creates a GrpcChannel.
            // This switch must be set before creating a GrpcChannel/HttpClient when calling an insecure gRPC service.
            // We want to fail fast so we are disabling it
            // See: https://docs.microsoft.com/aspnet/core/grpc/troubleshoot#call-insecure-grpc-services-with-net-core-client
            AppContext.SetSwitch("System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport", false);

            var exporterOptions = new OtlpExporterOptions
            {
                Endpoint = new Uri($"http://{CollectorHostname}:4317"),
            };

            var exception = Record.Exception(() => new OtlpTraceExporter(exporterOptions));

            if (Environment.Version.Major == 3)
            {
                Assert.NotNull(exception);
            }
            else
            {
                Assert.Null(exception);
            }
        }

        private sealed class OpenTelemetryEventListener : EventListener
        {
            private readonly ITestOutputHelper outputHelper;

            public OpenTelemetryEventListener(ITestOutputHelper outputHelper)
            {
                this.outputHelper = outputHelper;
            }

            protected override void OnEventSourceCreated(EventSource eventSource)
            {
                base.OnEventSourceCreated(eventSource);

                if (eventSource.Name.StartsWith("OpenTelemetry", StringComparison.OrdinalIgnoreCase))
                {
                    this.EnableEvents(eventSource, EventLevel.Verbose, EventKeywords.All);
                }
            }

            protected override void OnEventWritten(EventWrittenEventArgs eventData)
            {
                string message;
                if (eventData.Message != null && (eventData.Payload?.Count ?? 0) > 0)
                {
                    message = string.Format(eventData.Message, eventData.Payload.ToArray());
                }
                else
                {
                    message = eventData.Message;
                }

                this.outputHelper.WriteLine(message);
            }
        }
    }
}