Release 1.6.1

CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to the Carbon Aware SDK will be documented in this file.
 
+## [1.6.1] - 2024-11
+
+Release addressing minor issues [https://github.com/Green-Software-Foundation/carbon-aware-sdk/labels/v1.6.1](https://github.com/Green-Software-Foundation/carbon-aware-sdk/labels/v1.6.1) 
+
+### Added
+
+- [PR #531] Add configuration for tracing log](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/531)
+
+### Fixed 
+
+- [PR #575] Consider null value in carbonIntensity on EM ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/575)
+- [PR #572] EM datasource didn't filter out-of-range emission data ](https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/572)
+
+For more details, checkout [https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/579](https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/579)
+
 ## [1.6.0] - 2024-09
 
 Release for milestone https://github.com/Green-Software-Foundation/carbon-aware-sdk/milestone/8?closed=1 with general bugs fixes and improvements

casdk-docs/docs/tutorial-extras/configuration.md

@@ -409,6 +409,16 @@ InstrumentationKey. For more details, please refer to
 AppInsights_InstrumentationKey="AppInsightsInstrumentationKey"
 ```
 
+#### Configuring telemetry log
+
+WebAPI configures [console exporter of OpenTelemetry](https://opentelemetry.io/docs/languages/net/exporters/#console) by default.
+You can configure whether the exporter is enabled with `EnableTelemetryLogging`.
+Set `false` if you want to reduce the log.
+
+```bash
+CarbonAwareVars__EnableTelemetryLogging=false
+```
+
 ### Prometheus exporter for emissions data
 
 > DISCLAIMER:  The `/metrics` Prometheus exporter is currently unsupported, and is used for internal GSF needs, and may change in the future.  It will retrieve _all_ emissions data and create heavy load on your data API's.  It is turned off by default.

src/CarbonAware.DataSources/CarbonAware.DataSources.ElectricityMaps/src/ElectricityMapsDataSource.cs

@@ -138,18 +138,18 @@ private async Task<IEnumerable<CarbonIntensity>> GetRecentCarbonInstensityData(L
 
     private IEnumerable<EmissionsData> HistoryCarbonIntensityToEmissionsData(Location location, IEnumerable<CarbonIntensity> data, DateTimeOffset startTime, DateTimeOffset endTime)
     {
-        IEnumerable<EmissionsData> emissions;
         var duration = GetDurationFromHistoryDataPointsOrDefault(data, TimeSpan.Zero);
-        emissions = data.Select(d =>
-        {
-            var emission = (EmissionsData) d;
-            emission.Location = location.Name ?? string.Empty;
-            emission.Time = d.DateTime;
-            emission.Duration = duration;
-            return emission;
-        });
-
-        return emissions;
+        return data.Where(d => ((startTime <= d.DateTime) && (d.DateTime < endTime)) ||
+                               ((startTime <= d.DateTime.Add(duration)) && (d.DateTime.Add(duration) < endTime)) ||
+                               ((d.DateTime < startTime) && (endTime < d.DateTime.Add(duration))))
+            .Select(d =>
+            {
+                var emission = (EmissionsData)d;
+                emission.Location = location.Name ?? string.Empty;
+                emission.Time = d.DateTime;
+                emission.Duration = duration;
+                return emission;
+            });
     }
 
     private TimeSpan GetDurationFromHistoryDataPointsOrDefault(IEnumerable<CarbonIntensity> carbonIntensityDataPoints, TimeSpan defaultValue)

src/CarbonAware.DataSources/CarbonAware.DataSources.ElectricityMaps/src/Model/HistoryCarbonIntensityData.cs

@@ -32,7 +32,7 @@ internal record CarbonIntensity
     /// Carbon Intensity value.
     /// </summary>
     [JsonPropertyName("carbonIntensity")]
-    public int Value { get; init; }
+    public int? Value { get; init; }
 
     /// <summary>
     /// Indicates the datetime of the carbon intensity
@@ -74,7 +74,7 @@ public static explicit operator EmissionsData(CarbonIntensity historyCarbonInten
     {
         return new EmissionsData
         {
-            Rating = historyCarbonIntensity.Value,
+            Rating = historyCarbonIntensity.Value ?? -1,
             Time = historyCarbonIntensity.UpdatedAt,
         };
     }

src/CarbonAware.DataSources/CarbonAware.DataSources.ElectricityMaps/test/Client/ElectricityMapsClientTests.cs

@@ -8,6 +8,7 @@
 using Moq.Protected;
 using Moq.Contrib.HttpClient;
 using System.Text.Json;
+using CarbonAware.Model;
 
 namespace CarbonAware.DataSources.ElectricityMaps.Tests;
 
@@ -299,4 +300,36 @@
                 .ReturnsResponse(statusCode);
         }    
     }
+
+    [Test]
+    public async Task GetRecentCarbonIntensityHistoryAsync_DeserializesExpectedResponseWithNull()
+    {
+        AddHandler_RequestResponse(r =>
+        {
+            return r.Method == HttpMethod.Get;
+        }, System.Net.HttpStatusCode.OK, TestData.GetHistoryCarbonIntensityDataJsonStringWithNull());
+
+        var client = new ElectricityMapsClient(this.HttpClientFactory, this.Options.Object, this.Log.Object);
+
+        // Act
+        var data = await client.GetRecentCarbonIntensityHistoryAsync(TestLatitude, TestLongitude);
+        var dataPoint = data?.HistoryData.First();
+
+        // Assert
+        Assert.That(data, Is.Not.Null);
+        Assert.That(data?.Zone, Is.EqualTo(TestZone));
+        Assert.That(data?.HistoryData.Count(), Is.GreaterThan(0));
+        Assert.Multiple(() =>
+        {
+            Assert.That(dataPoint?.DateTime, Is.EqualTo(new DateTimeOffset(2099, 1, 1, 0, 0, 0, TimeSpan.Zero)));
+            Assert.That(dataPoint?.UpdatedAt, Is.EqualTo(new DateTimeOffset(2099, 1, 1, 0, 0, 0, TimeSpan.Zero)));
+            Assert.That(dataPoint?.CreatedAt, Is.EqualTo(new DateTimeOffset(2099, 1, 1, 0, 0, 0, TimeSpan.Zero)));
+            Assert.That(dataPoint?.Value, Is.Null);
+            Assert.That(((EmissionsData)dataPoint).Rating, Is.EqualTo(-1));
+            Assert.That(dataPoint?.EmissionFactorType, Is.EqualTo("lifecycle"));
+            Assert.That(dataPoint?.IsEstimated, Is.False);
+            Assert.That(dataPoint?.EstimationMethod, Is.Null);
+        });
+    }
+
 }

src/CarbonAware.DataSources/CarbonAware.DataSources.ElectricityMaps/test/Client/TestData.cs

@@ -92,4 +92,28 @@ public static string GetCurrentForecastJsonString()
 
         return json.ToString();
     }
+
+    public static string GetHistoryCarbonIntensityDataJsonStringWithNull()
+    {
+        var json = new JsonObject
+        {
+            ["zone"] = TestZoneId1,
+            ["history"] = new JsonArray
+            {
+                new JsonObject
+                {
+                    ["datetime"] = new DateTimeOffset(2099, 1, 1, 0, 0, 0, TimeSpan.Zero),
+                    ["updatedAt"] = new DateTimeOffset(2099, 1, 1, 0, 0, 0, TimeSpan.Zero),
+                    ["createdAt"] = new DateTimeOffset(2099, 1, 1, 0, 0, 0, TimeSpan.Zero),
+                    ["carbonIntensity"] = null,
+                    ["emissionFactorType"] = "lifecycle",
+                    ["isEstimated"] = false,
+                    ["estimatedMethod"] = null,
+                }
+            }
+        };
+
+        return json.ToString();
+    }
+
 }

src/CarbonAware.DataSources/CarbonAware.DataSources.ElectricityMaps/test/ElectricityMapsDataSourceTests.cs

@@ -134,6 +134,7 @@ public async Task GetCarbonIntensity_CallsExpectedClientEndpoint(int startTimeOf
     public async Task GetCarbonIntensity_DateRangeWithin24Hours_ReturnsResultsWhenRecordsFound()
     {
         var startDate = DateTimeOffset.UtcNow.AddHours(-10);
+        var expectedDate = startDate.AddMinutes(-10);
         var endDate = startDate.AddHours(1);
         var expectedCarbonIntensity = 100;
 
@@ -145,10 +146,12 @@ public async Task GetCarbonIntensity_DateRangeWithin24Hours_ReturnsResultsWhenRe
             {
                 new CarbonIntensity()
                 {
-                    Value = expectedCarbonIntensity,
+                    DateTime = startDate.AddMinutes(-40),  // out of range
+                    Value = 0,
                 },
                 new CarbonIntensity()
                 {
+                    DateTime = expectedDate,
                     Value = expectedCarbonIntensity,
                 }
             }
@@ -162,10 +165,11 @@ public async Task GetCarbonIntensity_DateRangeWithin24Hours_ReturnsResultsWhenRe
         var result = await this._dataSource.GetCarbonIntensityAsync(new List<Location>() { _defaultLocation }, startDate, endDate);
 
         Assert.IsNotNull(result);
-        Assert.That(result.Count(), Is.EqualTo(2));
+        Assert.That(result.Count(), Is.EqualTo(1));
 
         var first = result.First();
         Assert.IsNotNull(first);
+        Assert.That(expectedDate, Is.EqualTo(first.Time));
         Assert.That(first.Rating, Is.EqualTo(expectedCarbonIntensity));
         Assert.That(first.Location, Is.EqualTo(_defaultLocation.Name));
 
@@ -176,6 +180,7 @@ public async Task GetCarbonIntensity_DateRangeWithin24Hours_ReturnsResultsWhenRe
     public async Task GetCarbonIntensity_DateRangeMore24Hours_ReturnsResultsWhenRecordsFound()
     {
         var startDate = _defaultDataStartTime;
+        var expectedDate = startDate.AddMinutes(-10);
         var endDate = startDate.AddHours(1);
         var expectedCarbonIntensity = 100;
 
@@ -187,10 +192,12 @@ public async Task GetCarbonIntensity_DateRangeMore24Hours_ReturnsResultsWhenReco
             {
                 new CarbonIntensity()
                 {
-                    Value = expectedCarbonIntensity,
+                    DateTime = startDate.AddMinutes(-40),  // out of range
+                    Value = 0,
                 },
                 new CarbonIntensity()
                 {
+                    DateTime = expectedDate,
                     Value = expectedCarbonIntensity,
                 }
             }
@@ -206,10 +213,11 @@ public async Task GetCarbonIntensity_DateRangeMore24Hours_ReturnsResultsWhenReco
         var result = await this._dataSource.GetCarbonIntensityAsync(new List<Location>() { _defaultLocation }, startDate, endDate);
 
         Assert.IsNotNull(result);
-        Assert.That(result.Count(), Is.EqualTo(2));
+        Assert.That(result.Count(), Is.EqualTo(1));
 
         var first = result.First();
         Assert.IsNotNull(first);
+        Assert.That(expectedDate, Is.EqualTo(first.Time));
         Assert.That(first.Rating, Is.EqualTo(expectedCarbonIntensity));
         Assert.That(first.Location, Is.EqualTo(_defaultLocation.Name));
 
@@ -261,7 +269,9 @@ public async Task GetDurationBetweenHistoryDataPoints_ReturnsDefaultDuration_Whe
         {
             HistoryData = new List<CarbonIntensity>()
             {
-                new CarbonIntensity()
+                new CarbonIntensity(){
+                    DateTime = startDate.AddMinutes(30),
+                },
             }
         };
 
@@ -285,7 +295,7 @@ public async Task GetDurationBetweenHistoryDataPoints_WhenMultipleDataPoints_Ret
     {
         var startDate = DateTimeOffset.UtcNow.AddHours(-8);
         var endDate = startDate.AddHours(1);
-        var expectedDuration = TimeSpan.FromHours(1);
+        var expectedDuration = TimeSpan.FromMinutes(59);
         // Arrange
         _locationSource.Setup(l => l.ToGeopositionLocationAsync(_defaultLocation)).Returns(Task.FromResult(_defaultLocation));
 

src/CarbonAware.WebApi/src/Configuration/ServiceCollectionExtensions.cs

@@ -1,6 +1,8 @@
 using Microsoft.Extensions.Options;
 using CarbonAware.WebApi.Metrics;
 using OpenTelemetry.Metrics;
+using OpenTelemetry.Resources;
+using OpenTelemetry.Trace;
 
 namespace CarbonAware.WebApi.Configuration;
 
@@ -32,7 +34,23 @@
           // Can be extended in the future to support a different provider like Zipkin, Prometheus etc 
         }
 
+        var enableTelemetryLogging = envVars?.EnableTelemetryLogging ?? true;
+        if (enableTelemetryLogging)
+        {
+            const string serviceName = "CarbonAware.WebAPI";
+            const string serviceVersion = "1.0.0";
 
+            services.AddOpenTelemetry()
+                .WithTracing(tracerProviderBuilder =>
+                    tracerProviderBuilder
+                    .AddConsoleExporter()
+                    .AddSource(serviceName)
+                    .SetResourceBuilder(
+                        ResourceBuilder.CreateDefault()
+                            .AddService(serviceName: serviceName, serviceVersion: serviceVersion))
+                    .AddHttpClientInstrumentation()
+                    .AddAspNetCoreInstrumentation());
+        }
     }
 
     public static IServiceCollection AddCarbonExporter(this IServiceCollection services, IConfiguration configuration)
@@ -88,7 +106,7 @@
     public static ILogger CreateConsoleLogger(IConfiguration? config)
     {
         var factory = LoggerFactory.Create(b => {
             b.AddConfiguration(config?.GetSection("Logging"));
             b.AddConsole();
         });
         return factory.CreateLogger<IServiceCollection>();

src/CarbonAware.WebApi/src/Program.cs

@@ -5,29 +5,11 @@
 using GSF.CarbonAware.Configuration;
 using GSF.CarbonAware.Exceptions;
 using Microsoft.OpenApi.Models;
-using OpenTelemetry.Resources;
-using OpenTelemetry.Trace;
-using OpenTelemetry.Metrics;
 using Swashbuckle.AspNetCore.SwaggerGen;
 using System.Reflection;
 
-// Define constants to initialize tracing with
-var serviceName = "CarbonAware.WebAPI";
-var serviceVersion = "1.0.0";
-
 var builder = WebApplication.CreateBuilder(args);
 
-builder.Services.AddOpenTelemetry()
-    .WithTracing(tracerProviderBuilder =>
-        tracerProviderBuilder
-        .AddConsoleExporter()
-        .AddSource(serviceName)
-        .SetResourceBuilder(
-            ResourceBuilder.CreateDefault()
-                .AddService(serviceName: serviceName, serviceVersion: serviceVersion))
-        .AddHttpClientInstrumentation()
-        .AddAspNetCoreInstrumentation());
-
 // Add services to the container.
 builder.Services.AddControllers(options =>
 {

src/CarbonAware.WebApi/test/unitTests/Configuration/ServiceCollectionExtensionsTests.cs

@@ -3,6 +3,8 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Configuration;
 using NUnit.Framework.Internal;
+using OpenTelemetry.Trace;
+using Microsoft.ApplicationInsights;
 
 namespace CarbonAware.WepApi.UnitTests;
 
@@ -21,7 +23,7 @@
             { "ApplicationInsights_Connection_String", "AppInsightsConnectionString" }
         };
         var configuration = new ConfigurationBuilder()
             .AddInMemoryCollection(inMemorySettings)
             .Build();
 
         // Act & Assert
@@ -40,7 +42,7 @@
             { "AppInsights_InstrumentationKey", "AppInsightsInstrumentationKey" }
         };
         var configuration = new ConfigurationBuilder()
             .AddInMemoryCollection(inMemorySettings)
             .Build();
 
         // Act & Assert
@@ -58,7 +60,7 @@
             { "CarbonAwareVars:TelemetryProvider", "ApplicationInsights" }
         };
         var configuration = new ConfigurationBuilder()
             .AddInMemoryCollection(inMemorySettings)
             .Build();
 
         // Act & Assert
@@ -74,13 +76,13 @@
 
         var inMemorySettings = new Dictionary<string, string>{};
         var configuration = new ConfigurationBuilder()
             .AddInMemoryCollection(inMemorySettings)
             .Build();
 
         // Act & Assert
         Assert.DoesNotThrow(() => services.AddMonitoringAndTelemetry(configuration));
-        Assert.That(services.Count, Is.EqualTo(0));
-    }    
+        Assert.Null(services.BuildServiceProvider().GetService<TelemetryClient>());
+    }
 
     [Test]
     public void AddCarbonExporter_AddsServices_IsEnabledInConfiguration()
@@ -93,7 +95,7 @@
             { "CarbonAwareVars:EnableCarbonExporter", "true" }
         };
         var configuration = new ConfigurationBuilder()
             .AddInMemoryCollection(inMemorySettings)
             .Build();
 
         // Act & Assert
@@ -112,7 +114,7 @@
             { "CarbonAwareVars:EnableCarbonExporter", "false" }
         };
         var configuration = new ConfigurationBuilder()
             .AddInMemoryCollection(inMemorySettings)
             .Build();
 
         // Act & Assert
@@ -156,4 +158,58 @@
         // Assert
         Assert.That(logger, Is.Not.Null);
     }
+
+    [Test]
+    public void EnableTelemetryLogging_AddsServices_WithoutConfiguration()
+    {
+        // Arrange
+        var services = new ServiceCollection();
+
+        var inMemorySettings = new Dictionary<string, string> { };
+        var configuration = new ConfigurationBuilder()
+            .AddInMemoryCollection(inMemorySettings)
+            .Build();
+
+        // Act & Assert
+        Assert.DoesNotThrow(() => services.AddMonitoringAndTelemetry(configuration));
+        Assert.NotNull(services.BuildServiceProvider().GetService<TracerProvider>());
+    }
+
+    [Test]
+    public void EnableTelemetryLogging_AddsServices_IsEnabledInConfiguration()
+    {
+        // Arrange
+        var services = new ServiceCollection();
+
+        var inMemorySettings = new Dictionary<string, string>
+        {
+            { "CarbonAwareVars:EnableTelemetryLogging", "true" }
+        };
+        var configuration = new ConfigurationBuilder()
+            .AddInMemoryCollection(inMemorySettings)
+            .Build();
+
+        // Act & Assert
+        Assert.DoesNotThrow(() => services.AddMonitoringAndTelemetry(configuration));
+        Assert.NotNull(services.BuildServiceProvider().GetService<TracerProvider>());
+    }
+
+    [Test]
+    public void EnableTelemetryLogging_AddsServices_IsDisabledInConfiguration()
+    {
+        // Arrange
+        var services = new ServiceCollection();
+
+        var inMemorySettings = new Dictionary<string, string>
+        {
+            { "CarbonAwareVars:EnableTelemetryLogging", "false" }
+        };
+        var configuration = new ConfigurationBuilder()
+            .AddInMemoryCollection(inMemorySettings)
+            .Build();
+
+        // Act & Assert
+        Assert.DoesNotThrow(() => services.AddMonitoringAndTelemetry(configuration));
+        Assert.Null(services.BuildServiceProvider().GetService<TracerProvider>());
+    }
 }