feat: Add OLTP Exporter Option for Protocol

config/promitor/scraper/runtime.yaml

@@ -11,6 +11,7 @@ metricSinks:
       promitorMetricName: promitor_demo_documentation_availability
   openTelemetryCollector:
     collectorUri: http://opentelemetry-collector:4317
+    protocol: grpc
   prometheusScrapingEndpoint:
     metricUnavailableValue: -1
     enableMetricTimestamps: true # true by default

src/Promitor.Agents.Scraper/Extensions/IServiceCollectionExtensions.cs

@@ -198,7 +198,7 @@ public static IServiceCollection UseMetricSinks(this IServiceCollection services
             if (metricSinkConfiguration?.OpenTelemetryCollector != null
                 && string.IsNullOrWhiteSpace(metricSinkConfiguration.OpenTelemetryCollector.CollectorUri) == false)
             {
-                AddOpenTelemetryCollectorMetricSink(metricSinkConfiguration.OpenTelemetryCollector.CollectorUri, agentVersion, services, metricSinkAsciiTable);
+                AddOpenTelemetryCollectorMetricSink(metricSinkConfiguration.OpenTelemetryCollector, agentVersion, services, metricSinkAsciiTable);
             }
 
             AnsiConsole.Write(metricSinkAsciiTable);
@@ -224,9 +224,10 @@ private static void AddAtlassianStatuspageMetricSink(string pageId, IServiceColl
 
         const string OpenTelemetryServiceName = "promitor-scraper";
 
-        private static void AddOpenTelemetryCollectorMetricSink(string collectorUri, string agentVersion, IServiceCollection services, Table metricSinkAsciiTable)
+        private static void AddOpenTelemetryCollectorMetricSink(Promitor.Integrations.Sinks.OpenTelemetry.Configuration.OpenTelemetryCollectorSinkConfiguration otelConfiguration, string agentVersion, IServiceCollection services, Table metricSinkAsciiTable)
         {
-            metricSinkAsciiTable.AddRow("OpenTelemetry Collector", $"Url: {collectorUri}.");
+            metricSinkAsciiTable.AddRow("OpenTelemetry Collector", $"Url: {otelConfiguration.CollectorUri}.");
+            metricSinkAsciiTable.AddRow("OpenTelemetry Collector", $"Protocol: {otelConfiguration.Protocol}.");
 
             var resourceBuilder = ResourceBuilder.CreateDefault()
                 .AddService(OpenTelemetryServiceName, serviceVersion: agentVersion);
@@ -236,7 +237,12 @@ private static void AddOpenTelemetryCollectorMetricSink(string collectorUri, str
                     {
                         metricsBuilder.SetResourceBuilder(resourceBuilder)
                                       .AddMeter("Promitor.Scraper.Metrics.AzureMonitor")
-                                      .AddOtlpExporter(options => options.Endpoint = new Uri(collectorUri));
+                                      .AddOtlpExporter(options =>
+                                          {
+                                              options.Endpoint = new Uri(otelConfiguration.CollectorUri);
+                                              options.Protocol = otelConfiguration.Protocol;
+                                          }
+                                      );
                     });
             services.AddTransient<IMetricSink, OpenTelemetryCollectorMetricSink>();
             services.AddTransient<OpenTelemetryCollectorMetricSink>();

src/Promitor.Agents.Scraper/Startup.cs

@@ -115,6 +115,7 @@ private string BuildOpenApiDescription(IConfiguration configuration)
             if (metricSinkConfiguration.OpenTelemetryCollector != null)
             {
                 openApiDescriptionBuilder.AppendLine($"<li>OpenTelemetry Collector located on {metricSinkConfiguration.OpenTelemetryCollector.CollectorUri}</li>");
+                openApiDescriptionBuilder.AppendLine($"<li>OpenTelemetry Collector Protocol selected: {metricSinkConfiguration.OpenTelemetryCollector.Protocol}</li>");
             }
 
             if (metricSinkConfiguration.Statsd != null)

src/Promitor.Agents.Scraper/Validation/Steps/Sinks/OpenTelemetryCollectorMetricSinkValidationStep.cs

@@ -3,6 +3,7 @@
 using System.Linq;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
+using OpenTelemetry.Exporter;
 using Promitor.Agents.Core.Validation;
 using Promitor.Agents.Core.Validation.Interfaces;
 using Promitor.Agents.Core.Validation.Steps;
@@ -13,6 +14,27 @@ namespace Promitor.Agents.Scraper.Validation.Steps.Sinks
     public class OpenTelemetryCollectorMetricSinkValidationStep : ValidationStep, IValidationStep
     {
         private readonly IOptions<ScraperRuntimeConfiguration> _runtimeConfiguration;
+        public static bool TryParseProtocol(string value, out OtlpExportProtocol result)
+        {
+            switch (value?.Trim().ToLower())
+            {
+                case "grpc":
+                    result = OtlpExportProtocol.Grpc;
+                    return true;
+                case "http/protobuf":
+                    result = OtlpExportProtocol.HttpProtobuf;
+                    return true;
+                case "httpprotobuf":
+                    result = OtlpExportProtocol.HttpProtobuf;
+                    return true;
+                case "http":
+                    result = OtlpExportProtocol.HttpProtobuf;
+                    return true;
+                default:
+                    result = default;
+                    return false;
+            }
+        }
 
         public OpenTelemetryCollectorMetricSinkValidationStep(IOptions<ScraperRuntimeConfiguration> runtimeConfiguration, ILogger<OpenTelemetryCollectorMetricSinkValidationStep> validationLogger)
             : base(validationLogger)
@@ -33,6 +55,8 @@ public ValidationResult Run()
 
             var errorMessages = new List<string>();
             var collectorUri = openTelemetryCollectorSinkConfiguration.CollectorUri;
+            var collectorProtocol = openTelemetryCollectorSinkConfiguration.Protocol.ToString();
+            // Url Validation
             if (string.IsNullOrWhiteSpace(collectorUri))
             {
                 errorMessages.Add("No URI for the OpenTelemetry Collector is configured.");
@@ -48,6 +72,11 @@ public ValidationResult Run()
                     errorMessages.Add($"Configured URI ({collectorUri}) for the OpenTelemetry Collector is not a valid URI.");
                 }
             }
+            // Protocol Validation
+            if (!TryParseProtocol(collectorProtocol, out var parsedProtocol))
+            {
+                errorMessages.Add($"Invalid Protocol ({collectorProtocol}) for the OpenTelemetry Collector is configured. Please check here for valid protocols: https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md#otlpexporteroptions");
+            }
 
             return errorMessages.Any() ? ValidationResult.Failure(ComponentName, errorMessages) : ValidationResult.Successful(ComponentName);
         }

src/Promitor.Integrations.Sinks.OpenTelemetry/Configuration/OpenTelemetryCollectorSinkConfiguration.cs

@@ -1,7 +1,11 @@
-namespace Promitor.Integrations.Sinks.OpenTelemetry.Configuration
+using OpenTelemetry.Exporter;
+
+namespace Promitor.Integrations.Sinks.OpenTelemetry.Configuration
 {
     public class OpenTelemetryCollectorSinkConfiguration
     {
+        public OtlpExportProtocol Protocol { get; set; } = default(OtlpExportProtocol);
         public string CollectorUri { get; set; }
+        //Todo: Headers
     }
 }

src/Promitor.Tests.Unit/Configuration/RuntimeConfigurationUnitTest.cs

@@ -3,6 +3,7 @@
 using Microsoft.Azure.Management.ResourceManager.Fluent.Core;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
+using OpenTelemetry.Exporter;
 using Promitor.Agents.Scraper.Configuration;
 using Promitor.Integrations.Sinks.Statsd.Configuration;
 using Promitor.Tests.Unit.Generators.Config;
@@ -391,7 +392,7 @@ public async Task RuntimeConfiguration_HasConfiguredCollectorUriInOpenTelemetryC
             // Arrange
             var collectorUri = "https://foo.bar";
             var configuration = await RuntimeConfigurationGenerator.WithServerConfiguration()
-                .WithOpenTelemetryCollectorMetricSink(collectorUri: collectorUri)
+                 .WithOpenTelemetryCollectorMetricSink(collectorUri: collectorUri, protocol: OtlpExportProtocol.Grpc)
                 .GenerateAsync();
 
             // Act
@@ -402,6 +403,7 @@ public async Task RuntimeConfiguration_HasConfiguredCollectorUriInOpenTelemetryC
             Assert.NotNull(runtimeConfiguration.MetricSinks);
             Assert.NotNull(runtimeConfiguration.MetricSinks.OpenTelemetryCollector);
             Assert.Equal(collectorUri, runtimeConfiguration.MetricSinks.OpenTelemetryCollector.CollectorUri);
+            Assert.Equal(OtlpExportProtocol.Grpc, runtimeConfiguration.MetricSinks.OpenTelemetryCollector.Protocol);
         }
 
         [Fact]

src/Promitor.Tests.Unit/Generators/Config/BogusScraperRuntimeConfigurationGenerator.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using Bogus;
 using Microsoft.Extensions.Logging;
+using OpenTelemetry.Exporter;
 using Promitor.Agents.Core.Configuration.Server;
 using Promitor.Agents.Core.Configuration.Telemetry;
 using Promitor.Agents.Core.Configuration.Telemetry.Sinks;
@@ -156,6 +157,7 @@ private static OpenTelemetryCollectorSinkConfiguration GenerateOpenTelemetryColl
             var openTelemetryCollectorSinkConfiguration = new Faker<OpenTelemetryCollectorSinkConfiguration>()
                 .StrictMode(true)
                 .RuleFor(promConfiguration => promConfiguration.CollectorUri, faker => faker.Internet.Url())
+                .RuleFor(promConfiguration => promConfiguration.Protocol, faker => OtlpExportProtocol.Grpc)
                 .Generate();
             return openTelemetryCollectorSinkConfiguration;
         }

src/Promitor.Tests.Unit/Generators/Config/RuntimeConfigurationGenerator.cs

@@ -6,6 +6,7 @@
 using Microsoft.Azure.Management.ResourceManager.Fluent.Core;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
+using OpenTelemetry.Exporter;
 using Promitor.Agents.Core.Configuration.Server;
 using Promitor.Agents.Core.Configuration.Telemetry;
 using Promitor.Agents.Core.Configuration.Telemetry.Sinks;
@@ -71,12 +72,12 @@ public RuntimeConfigurationGenerator WithPrometheusMetricSink(double? metricUnav
 
                 if (metricUnavailableValue != null)
                 {
-                    prometheusSinkConfiguration.MetricUnavailableValue = (double) metricUnavailableValue;
+                    prometheusSinkConfiguration.MetricUnavailableValue = (double)metricUnavailableValue;
                 }
 
                 if (enableMetricsTimestamp != null)
                 {
-                    prometheusSinkConfiguration.EnableMetricTimestamps = (bool) enableMetricsTimestamp;
+                    prometheusSinkConfiguration.EnableMetricTimestamps = (bool)enableMetricsTimestamp;
                 }
             }
 
@@ -85,13 +86,14 @@ public RuntimeConfigurationGenerator WithPrometheusMetricSink(double? metricUnav
             return this;
         }
 
-        public RuntimeConfigurationGenerator WithOpenTelemetryCollectorMetricSink(string collectorUri = "https://opentelemetry-collector:8888")
+        public RuntimeConfigurationGenerator WithOpenTelemetryCollectorMetricSink(string collectorUri = "https://opentelemetry-collector:8888", OtlpExportProtocol protocol = OtlpExportProtocol.Grpc)
         {
             if (string.IsNullOrWhiteSpace(collectorUri) == false)
             {
                 _runtimeConfiguration.MetricSinks.OpenTelemetryCollector = new OpenTelemetryCollectorSinkConfiguration
                 {
-                    CollectorUri = collectorUri
+                    CollectorUri = collectorUri,
+                    Protocol = protocol
                 };
             }
 
@@ -201,7 +203,7 @@ public RuntimeConfigurationGenerator WithContainerTelemetry(LogLevel? verbosity
                 };
 
             _runtimeConfiguration.Telemetry ??= new TelemetryConfiguration();
-_runtimeConfiguration.Telemetry.ContainerLogs = containerLogConfiguration;
+            _runtimeConfiguration.Telemetry.ContainerLogs = containerLogConfiguration;
 
             return this;
         }
@@ -296,6 +298,7 @@ public async Task<IConfiguration> GenerateAsync()
                 {
                     configurationBuilder.AppendLine("  openTelemetryCollector:");
                     configurationBuilder.AppendLine($"    collectorUri: {_runtimeConfiguration?.MetricSinks.OpenTelemetryCollector.CollectorUri}");
+                    configurationBuilder.AppendLine($"    protocol: {_runtimeConfiguration?.MetricSinks.OpenTelemetryCollector.Protocol}");
                 }
             }
 

src/Promitor.Tests.Unit/Validation/Scraper/Metrics/Sinks/OpenTelemetryCollectorMetricSinkValidationStepTests.cs

@@ -1,6 +1,9 @@
-using System.ComponentModel;
+using System.Collections.Generic;
+using System.ComponentModel;
+using Bogus;
 using Microsoft.Extensions.Logging.Abstractions;
 using Microsoft.Extensions.Options;
+using OpenTelemetry.Exporter;
 using Promitor.Agents.Scraper.Configuration;
 using Promitor.Agents.Scraper.Validation.Steps.Sinks;
 using Promitor.Tests.Unit.Generators.Config;
@@ -72,6 +75,50 @@ public void Validate_OpenTelemetryCollectorWithUnspecifiedCollectorUri_Fails(str
             PromitorAssert.ValidationFailed(validationResult);
         }
 
+        [Theory]
+        [InlineData("grpc")]
+        [InlineData("http")]
+        [InlineData("http/protobuf")]
+        [InlineData("httpprotobuf")]
+        public void Validate_OpenTelemetryCollectorWithValidProtocol_Success(string collectorProtocolString)
+        {
+            // Arrange
+            var runtimeConfiguration = CreateRuntimeConfiguration();
+
+            if (OpenTelemetryCollectorMetricSinkValidationStep.TryParseProtocol(collectorProtocolString, out var collectorProtocol))
+            {
+                runtimeConfiguration.Value.MetricSinks.OpenTelemetryCollector.Protocol = collectorProtocol;
+
+                // Act
+                var openTelemetryCollectorValidationStep = new OpenTelemetryCollectorMetricSinkValidationStep(runtimeConfiguration, NullLogger<OpenTelemetryCollectorMetricSinkValidationStep>.Instance);
+                var validationResult = openTelemetryCollectorValidationStep.Run();
+
+                // Assert
+                PromitorAssert.ValidationIsSuccessful(validationResult);
+            }
+        }
+
+        [Theory]
+        [InlineData("badprotocol")]
+        [InlineData("https")]
+        public void Validate_OpenTelemetryCollectorWithValidProtocol_FailsToDefault(string collectorProtocolString)
+        {
+            // Arrange
+            var runtimeConfiguration = CreateRuntimeConfiguration();
+
+            if (!OpenTelemetryCollectorMetricSinkValidationStep.TryParseProtocol(collectorProtocolString, out var collectorProtocol))
+            {
+                runtimeConfiguration.Value.MetricSinks.OpenTelemetryCollector.Protocol = collectorProtocol;
+
+                // Act
+                var openTelemetryCollectorValidationStep = new OpenTelemetryCollectorMetricSinkValidationStep(runtimeConfiguration, NullLogger<OpenTelemetryCollectorMetricSinkValidationStep>.Instance);
+                var validationResult = openTelemetryCollectorValidationStep.Run();
+
+                // Assert
+                PromitorAssert.ValidationIsSuccessful(validationResult);
+            }
+        }
+
         [Theory]
         [InlineData("http://")]
         [InlineData("http://foo:bar")]
@@ -121,4 +168,4 @@ private IOptions<ScraperRuntimeConfiguration> CreateRuntimeConfiguration()
             return Options.Create(bogusRuntimeConfiguration);
         }
     }
-}
+}