Merge pull request #733 from fossa-app/license-metrics

Record Company License metrics

Author: tiksn

src/API.Core/DefaultCoreModule.cs

@@ -57,6 +57,11 @@ protected override void Load(ContainerBuilder builder)
       .AsImplementedInterfaces()
       .SingleInstance();
 
+    builder
+      .RegisterType<CompanyLicenseMetricsRecorder>()
+      .AsImplementedInterfaces()
+      .SingleInstance();
+
     builder
       .RegisterType<CompanyLicenseCreator>()
       .AsImplementedInterfaces()

src/API.Core/Services/CompanyLicenseRetriever.cs

@@ -1,23 +1,27 @@
 using Fossa.API.Core.Entities;
 using Fossa.API.Core.Repositories;
+using Fossa.API.Core.Telemetry;
 using Fossa.Licensing;
 using TIKSN.Licensing;
 
 namespace Fossa.API.Core.Services;
 
 public class CompanyLicenseRetriever : CompanyLicenseManager, ICompanyLicenseRetriever
 {
+  private readonly ICompanyLicenseMetricsRecorder _companyLicenseMetricsRecorder;
   private readonly ILicenseFileRepository _licenseFileRepository;
   private readonly ISystemLicenseRetriever _systemLicenseRetriever;
 
   public CompanyLicenseRetriever(
     ILicenseFileRepository licenseFileRepository,
     ILicenseFactory<CompanyEntitlements, CompanyLicenseEntitlements> licenseFactory,
+    ICompanyLicenseMetricsRecorder companyLicenseMetricsRecorder,
     ICertificateProvider certificateProvider,
     ISystemLicenseRetriever systemLicenseRetriever)
     : base(certificateProvider, licenseFactory)
   {
     _licenseFileRepository = licenseFileRepository ?? throw new ArgumentNullException(nameof(licenseFileRepository));
+    _companyLicenseMetricsRecorder = companyLicenseMetricsRecorder ?? throw new ArgumentNullException(nameof(companyLicenseMetricsRecorder));
     _systemLicenseRetriever = systemLicenseRetriever ?? throw new ArgumentNullException(nameof(systemLicenseRetriever));
   }
 
@@ -41,11 +45,15 @@ private async Task<Validation<Error, License<CompanyEntitlements>>> GetCompanyLi
 
     var licenseData = licenseFile.Content.ToSeq();
 
-    return await ValidateCompanyLicenseAsync(
+    var licenseValidation = await ValidateCompanyLicenseAsync(
       systemLicense,
       companyId,
       licenseData,
       cancellationToken)
       .ConfigureAwait(false);
+
+    _companyLicenseMetricsRecorder.Record(companyId, licenseValidation);
+
+    return licenseValidation;
   }
 }

src/API.Core/Telemetry/CompanyLicenseMetricsRecorder.cs

@@ -0,0 +1,29 @@
+using System.Diagnostics.Metrics;
+using Fossa.API.Core.Entities;
+using Fossa.Licensing;
+using TIKSN.Licensing;
+
+namespace Fossa.API.Core.Telemetry;
+
+public class CompanyLicenseMetricsRecorder : ICompanyLicenseMetricsRecorder
+{
+  private readonly Gauge<double> _daysLeft;
+  private readonly TimeProvider _timeProvider;
+
+  public CompanyLicenseMetricsRecorder(
+      TimeProvider timeProvider,
+      IMeterFactory meterFactory)
+  {
+    var meter = meterFactory.Create("Fossa.API.Core.Telemetry");
+    _daysLeft = meter.CreateGauge<double>("fossa.api.core.telemetry.company_license_days_left");
+    _timeProvider = timeProvider ?? throw new ArgumentNullException(nameof(timeProvider));
+  }
+
+  public void Record(CompanyId companyId, Validation<Error, License<CompanyEntitlements>> license)
+  {
+    _daysLeft.Record(
+        LicenseMetricsRecorderHelper.CalculateDaysLeft(license, _timeProvider),
+        LicenseMetricsRecorderHelper.CreateLicenseStatusTag(license),
+        new KeyValuePair<string, object?>("company_id", companyId.AsPrimitive()));
+  }
+}

src/API.Core/Telemetry/ICompanyLicenseMetricsRecorder.cs

@@ -0,0 +1,10 @@
+using Fossa.API.Core.Entities;
+using Fossa.Licensing;
+using TIKSN.Licensing;
+
+namespace Fossa.API.Core.Telemetry;
+
+public interface ICompanyLicenseMetricsRecorder
+{
+  void Record(CompanyId companyId, Validation<Error, License<CompanyEntitlements>> license);
+}

src/API.Core/Telemetry/LicenseMetricsRecorderHelper.cs

@@ -0,0 +1,37 @@
+using TIKSN.Licensing;
+
+namespace Fossa.API.Core.Telemetry;
+
+internal static class LicenseMetricsRecorderHelper
+{
+  internal static double CalculateDaysLeft<T>(
+    Validation<Error, License<T>> license,
+    TimeProvider timeProvider)
+  {
+    return license.Match(
+      validLicense => CalculateTimeLeft(validLicense, timeProvider).TotalDays,
+      _ => 0.0);
+  }
+
+  internal static TimeSpan CalculateTimeLeft<T>(
+    License<T> validLicense,
+    TimeProvider timeProvider)
+  {
+    var now = timeProvider.GetUtcNow();
+    if (validLicense.Terms.NotAfter <= now)
+    {
+      return TimeSpan.Zero;
+    }
+
+    return validLicense.Terms.NotAfter.Subtract(now);
+  }
+
+  internal static KeyValuePair<string, object?> CreateLicenseStatusTag<T>(
+    Validation<Error, License<T>> license)
+  {
+    return new KeyValuePair<string, object?>("license_status",
+      license.Match(
+       validLicense => "valid",
+       _ => "invalid"));
+  }
+}

src/API.Core/Telemetry/SystemLicenseMetricsRecorder.cs

@@ -21,23 +21,7 @@ public SystemLicenseMetricsRecorder(
   public void Record(Validation<Error, License<SystemEntitlements>> license)
   {
     _daysLeft.Record(
-      license.Match(
-        validLicense => CalculateTimeLeft(validLicense).TotalDays,
-        _ => 0.0),
-      new KeyValuePair<string, object?>("license_status",
-        license.Match(
-          validLicense => "valid",
-          _ => "invalid")));
-  }
-
-  private TimeSpan CalculateTimeLeft(License<SystemEntitlements> validLicense)
-  {
-    var now = _timeProvider.GetUtcNow();
-    if (validLicense.Terms.NotAfter <= now)
-    {
-      return TimeSpan.Zero;
-    }
-
-    return validLicense.Terms.NotAfter.Subtract(now);
+      LicenseMetricsRecorderHelper.CalculateDaysLeft(license, _timeProvider),
+      LicenseMetricsRecorderHelper.CreateLicenseStatusTag(license));
   }
 }

tests/API.UnitTests/PublicAPITests.CoreAssemblyHasNoPublicAPIChangesAsync.verified.txt

@@ -902,7 +902,7 @@ namespace Fossa.API.Core.Services
     }
     public class CompanyLicenseRetriever : Fossa.API.Core.Services.CompanyLicenseManager, Fossa.API.Core.Services.ICompanyLicenseRetriever
     {
-        public CompanyLicenseRetriever(Fossa.API.Core.Repositories.ILicenseFileRepository licenseFileRepository, TIKSN.Licensing.ILicenseFactory<Fossa.Licensing.CompanyEntitlements, Fossa.Licensing.CompanyLicenseEntitlements> licenseFactory, Fossa.API.Core.Services.ICertificateProvider certificateProvider, Fossa.API.Core.Services.ISystemLicenseRetriever systemLicenseRetriever) { }
+        public CompanyLicenseRetriever(Fossa.API.Core.Repositories.ILicenseFileRepository licenseFileRepository, TIKSN.Licensing.ILicenseFactory<Fossa.Licensing.CompanyEntitlements, Fossa.Licensing.CompanyLicenseEntitlements> licenseFactory, Fossa.API.Core.Telemetry.ICompanyLicenseMetricsRecorder companyLicenseMetricsRecorder, Fossa.API.Core.Services.ICertificateProvider certificateProvider, Fossa.API.Core.Services.ISystemLicenseRetriever systemLicenseRetriever) { }
         public System.Threading.Tasks.Task<LanguageExt.Validation<LanguageExt.Common.Error, TIKSN.Licensing.License<Fossa.Licensing.CompanyEntitlements>>> GetAsync(Fossa.API.Core.Entities.CompanyId companyId, System.Threading.CancellationToken cancellationToken) { }
     }
     public class CountryProvider : Fossa.API.Core.Services.ICountryProvider
@@ -998,6 +998,15 @@ namespace Fossa.API.Core.Services
 }
 namespace Fossa.API.Core.Telemetry
 {
+    public class CompanyLicenseMetricsRecorder : Fossa.API.Core.Telemetry.ICompanyLicenseMetricsRecorder
+    {
+        public CompanyLicenseMetricsRecorder(System.TimeProvider timeProvider, System.Diagnostics.Metrics.IMeterFactory meterFactory) { }
+        public void Record(Fossa.API.Core.Entities.CompanyId companyId, LanguageExt.Validation<LanguageExt.Common.Error, TIKSN.Licensing.License<Fossa.Licensing.CompanyEntitlements>> license) { }
+    }
+    public interface ICompanyLicenseMetricsRecorder
+    {
+        void Record(Fossa.API.Core.Entities.CompanyId companyId, LanguageExt.Validation<LanguageExt.Common.Error, TIKSN.Licensing.License<Fossa.Licensing.CompanyEntitlements>> license);
+    }
     public interface ISystemLicenseMetricsRecorder
     {
         void Record(LanguageExt.Validation<LanguageExt.Common.Error, TIKSN.Licensing.License<Fossa.Licensing.SystemEntitlements>> license);