Add HeatlthCheck (#26)

mikmog · web-flow · commit 7831b7ff5479 · 2024-09-09T17:05:01.000+02:00
* Add HeatlthCheck
diff --git a/.github/workflows/backend-build.yml b/.github/workflows/backend-build.yml
@@ -35,16 +35,17 @@ jobs:
       run: dotnet restore "${{ inputs.projectDirectory }}"
 
     - name: Build
-      run: dotnet build "${{ inputs.projectDirectory }}" --configuration "${{ env.CONFIGURATION }}" --no-restore
+      run: dotnet build "${{ inputs.projectDirectory }}" --configuration "${{ env.CONFIGURATION }}" --no-restore -r linux-x64
 
     - name: All backend tests
       run: dotnet test "${{ env.BACKEND_BASE_DIRECTORY }}"
 
     - name: Publish
-      run: dotnet publish "${{ inputs.projectDirectory }}" --configuration "${{ env.CONFIGURATION }}" --no-build --output "${{ inputs.artifactsDirectory }}"
+      run: dotnet publish "${{ inputs.projectDirectory }}" --configuration "${{ env.CONFIGURATION }}" --no-build --output "${{ inputs.artifactsDirectory }}" -r linux-x64
 
     - name: Upload Artifacts
       uses: actions/upload-artifact@v4
       with:
+        include-hidden-files: true #TODO: Remove this line when the bug is fixed https://github.com/actions/upload-artifact/issues/602
         name: ${{ inputs.artifactsName }}
         path: ${{ inputs.artifactsDirectory }}
diff --git a/src/backend/Database/Ts.TelemetryDatabase.Sql/Ts.TelemetryDatabase.Sql.sqlproj b/src/backend/Database/Ts.TelemetryDatabase.Sql/Ts.TelemetryDatabase.Sql.sqlproj
@@ -8,6 +8,7 @@
     <TargetDatabaseSet>True</TargetDatabaseSet>
     <ProjectVersion>4.1</ProjectVersion>
     <LangVersion>latest</LangVersion>
+	<TargetFramework>net472</TargetFramework>
     <ProjectGuid>{d6b56a08-b5c2-4c8b-9e49-51994f67ff4b}</ProjectGuid>
     <RunSqlCodeAnalysis>True</RunSqlCodeAnalysis>
   </PropertyGroup>
diff --git a/src/backend/Directory.Packages.props b/src/backend/Directory.Packages.props
@@ -3,6 +3,8 @@
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
   </PropertyGroup>
   <ItemGroup>
+    <PackageVersion Include="AspNetCore.HealthChecks.Azure.IoTHub" Version="8.0.1" />
+    <PackageVersion Include="AspNetCore.HealthChecks.SqlServer" Version="8.0.2" />
     <PackageVersion Include="Azure.Extensions.AspNetCore.Configuration.Secrets" Version="1.3.2" />
     <PackageVersion Include="Azure.Identity" Version="1.12.0" />
     <PackageVersion Include="Azure.Security.KeyVault.Secrets" Version="4.6.0" />
@@ -11,6 +13,7 @@
     <PackageVersion Include="Dapper.Contrib" Version="2.0.78" />
     <PackageVersion Include="Microsoft.Azure.Functions.Worker" Version="1.23.0" />
     <PackageVersion Include="Microsoft.Azure.Functions.Worker.Extensions.EventGrid" Version="3.4.2" />
+    <PackageVersion Include="Microsoft.Azure.Functions.Worker.Extensions.Http" Version="3.2.0" />
     <PackageVersion Include="Microsoft.Azure.Functions.Worker.Extensions.Timer" Version="4.3.1" />
     <PackageVersion Include="Microsoft.Azure.Functions.Worker.Sdk" Version="1.17.4" />
     <PackageVersion Include="Microsoft.ApplicationInsights.WorkerService" Version="2.22.0" />
@@ -24,6 +27,7 @@
     <PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="9.0.0-preview.6.24327.7" />
     <PackageVersion Include="Microsoft.Extensions.Configuration.UserSecrets" Version="9.0.0-preview.6.24327.7" />
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="9.0.0-preview.6.24327.7" />
+    <PackageVersion Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="8.0.8" />
     <PackageVersion Include="Microsoft.Extensions.Http" Version="9.0.0-preview.6.24327.7" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.0" />
     <PackageVersion Include="Microsoft.SqlServer.DacFx" Version="162.3.566" />
@@ -35,4 +39,4 @@
     <PackageVersion Include="xunit" Version="2.9.0" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/src/backend/Functions/Ts.Functions/Extensions/AppSettings.cs b/src/backend/Functions/Ts.Functions/Extensions/AppSettings.cs
@@ -12,4 +12,16 @@ public static IConfigurationBuilder AddAppSettings(this IConfigurationBuilder bu
 
         return builder;
     }
+
+    public static string GetRequiredConnectionString(this IConfiguration configuration, string name)
+    {
+        return configuration.GetConnectionString(name) ?? throw new ConfigurationErrorException($"Missing required connection string '{name}'");
+    }
+
+    public static string GetRequiredSetting(this IConfiguration configuration, string name) 
+    {
+        return configuration[name]  ?? throw new ConfigurationErrorException($"Missing required configuration '{name}'");
+    }
 }
+
+public class ConfigurationErrorException(string message) : Exception(message) { }
diff --git a/src/backend/Functions/Ts.Functions/Health/HealtChecks/IotHubHealthCheck.cs b/src/backend/Functions/Ts.Functions/Health/HealtChecks/IotHubHealthCheck.cs
@@ -0,0 +1,25 @@
+﻿using Azure.Identity;
+using Microsoft.Azure.Devices;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+using TelemetryStash.Functions.Extensions;
+
+namespace TelemetryStash.Functions.Health.HealtChecks;
+public class IotHubHealthCheck(IConfiguration configuration) : IHealthCheck
+{
+    public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = new CancellationToken())
+    {
+        var ioTHubHostName = configuration.GetRequiredSetting("IoTHubHostName");
+
+        var manager = RegistryManager.Create(ioTHubHostName, new DefaultAzureCredential());
+        var query = manager.CreateQuery("SELECT COUNT()");
+
+        var response = await query.GetNextAsJsonAsync();
+        if (!response.Any())
+        {
+            return HealthCheckResult.Unhealthy();
+        }
+
+        return HealthCheckResult.Healthy();
+    }
+}
diff --git a/src/backend/Functions/Ts.Functions/Health/HealthCheck.cs b/src/backend/Functions/Ts.Functions/Health/HealthCheck.cs
@@ -0,0 +1,22 @@
+﻿using Microsoft.Azure.Functions.Worker;
+using Microsoft.Azure.Functions.Worker.Http;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+using System.Net;
+
+namespace TelemetryStash.Functions.Health;
+
+public class HealthCheck(HealthCheckService healthCheckService)
+{
+    [Function("HealthCheck")]
+    public async Task<HttpResponseData> RunAsync([HttpTrigger(AuthorizationLevel.Function, "get", Route = null)] HttpRequestData req, FunctionContext executionContext)
+    {
+        var status = await healthCheckService.CheckHealthAsync();
+
+        var response = req.CreateResponse();
+        response.StatusCode = status.Status == HealthStatus.Healthy ? HttpStatusCode.OK : HttpStatusCode.FailedDependency;
+        await response.WriteAsJsonAsync(new Response(Enum.GetName(status.Status), status.TotalDuration.TotalMilliseconds));
+        return response;
+    }
+
+    private record Response(string? Status, double Duration);
+}
diff --git a/src/backend/Functions/Ts.Functions/Health/StartupExtensions.cs b/src/backend/Functions/Ts.Functions/Health/StartupExtensions.cs
@@ -0,0 +1,15 @@
+﻿using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using TelemetryStash.Functions.Extensions;
+using TelemetryStash.Functions.Health.HealtChecks;
+
+namespace TelemetryStash.Functions.Health;
+internal static class StartupExtensions
+{
+    public static void AddHealthCheck(this IServiceCollection services, IConfiguration configuration)
+    {
+        services.AddHealthChecks()
+            .AddSqlServer(configuration.GetRequiredConnectionString("TelemetryStashDatabase"), name: "SqlServerHealthCheck")
+            .AddCheck<IotHubHealthCheck>("IoTHubHealthCheck");
+    }
+}
diff --git a/src/backend/Functions/Ts.Functions/Program.cs b/src/backend/Functions/Ts.Functions/Program.cs
@@ -2,6 +2,7 @@
 using Microsoft.Extensions.Hosting;
 using TelemetryStash.Database;
 using TelemetryStash.Functions.Extensions;
+using TelemetryStash.Functions.Health;
 
 var host = new HostBuilder()
     .ConfigureFunctionsWorkerDefaults()
@@ -18,6 +19,7 @@
 
         services.AddFunctionServices();
         services.AddTelemetryDatabase(context.Configuration);
+        services.AddHealthCheck(context.Configuration);
     })
     .Build();
 
diff --git a/src/backend/Functions/Ts.Functions/TelemetryHistoryManager/TelemetryHistoryManager.cs b/src/backend/Functions/Ts.Functions/TelemetryHistoryManager/TelemetryHistoryManager.cs
diff --git a/src/backend/Functions/Ts.Functions/Ts.Functions.csproj b/src/backend/Functions/Ts.Functions/Ts.Functions.csproj
@@ -1,23 +1,28 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
+    <RuntimeIdentifiers>linux-x64</RuntimeIdentifiers>
     <AzureFunctionsVersion>v4</AzureFunctionsVersion>
     <OutputType>Exe</OutputType>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <RootNamespace>TelemetryStash.Functions</RootNamespace>
   </PropertyGroup>
   <ItemGroup>
+    <PackageReference Include="AspNetCore.HealthChecks.Azure.IoTHub" />
+    <PackageReference Include="AspNetCore.HealthChecks.SqlServer" />
     <PackageReference Include="Azure.Extensions.AspNetCore.Configuration.Secrets" />
     <PackageReference Include="Azure.Identity" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.EventGrid" />
+    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Timer" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" />
     <PackageReference Include="Microsoft.ApplicationInsights.WorkerService" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.ApplicationInsights" />
     <PackageReference Include="Microsoft.Extensions.Caching.Hybrid" />
     <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" />
+    <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" />
     <PackageReference Include="Microsoft.Extensions.Http" />
   </ItemGroup>
   <ItemGroup>
@@ -44,4 +49,7 @@
   <ItemGroup>
     <Using Include="System.Threading.ExecutionContext" Alias="ExecutionContext" />
   </ItemGroup>
+  <ItemGroup>
+    <Folder Include="Properties\" />
+  </ItemGroup>
 </Project>
diff --git a/src/backend/Functions/Ts.Functions/appsettings.Development.json b/src/backend/Functions/Ts.Functions/appsettings.Development.json
@@ -1,14 +1,7 @@
 ﻿{
-  "Logging": {
-    "LogLevel": {
-      "Microsoft.EntityFrameworkCore.Database.Command": "Warning"
-    }
-  },
   "ConnectionStrings": {
     "TelemetryStashDatabase": "Server=tcp:sql-ts-develop.database.windows.net,1433;Initial Catalog=sqldb-ts-develop;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Authentication=Active Directory Default;"
   },
-  "KeyVault": "https://kv1-telemetrystash-dev.vault.azure.net",
-  "TelemetryHistoryManager": {
-    "RunSchedule": "0 0 3 * * *"
-  }
+  "KeyVault": "https://kv-ts-develop.vault.azure.net/",
+  "IoTHubHostName": "iot-ts-develop.azure-devices.net"
 }
diff --git a/src/backend/Functions/Ts.Functions/appsettings.Production.json b/src/backend/Functions/Ts.Functions/appsettings.Production.json
@@ -1,14 +1,7 @@
 ﻿{
-  "Logging": {
-    "LogLevel": {
-      "Microsoft.EntityFrameworkCore.Database.Command": "Warning"
-    }
-  },
   "ConnectionStrings": {
     "TelemetryStashDatabase": "Server=tcp:sql-ts-prod.database.windows.net,1433;Initial Catalog=sqldb-ts-prod;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Authentication=Active Directory Default;"
   },
-  "KeyVault": "https://kv-telemetrystash-prod.vault.azure.net",
-  "TelemetryHistoryManager": {
-    "RunSchedule": "0 0 3 * * *"
-  }
+  "KeyVault": "https://kv-ts-prod.vault.azure.net",
+  "IoTHubHostName": "iot-ts-prod.azure-devices.net"
 }
diff --git a/src/backend/Functions/Ts.Functions/local.settings.json b/src/backend/Functions/Ts.Functions/local.settings.json
@@ -2,9 +2,6 @@
   "IsEncrypted": false,
   "Values": {
     "AzureWebJobsStorage": "UseDevelopmentStorage=true",
-    "FUNCTIONS_WORKER_RUNTIME": "dotnet-isolated",
-
-    "_comment": "Enable/disable AzureWebJobs.* to run individually during development",
-    "AzureWebJobs.TelemetryHistoryManager.Disabled": true
+    "FUNCTIONS_WORKER_RUNTIME": "dotnet-isolated"
   }
 }
diff --git a/src/backend/Infrastructure/Ts.Infrastructure/main.bicep b/src/backend/Infrastructure/Ts.Infrastructure/main.bicep
@@ -121,9 +121,24 @@ module iotHubModule 'modules/iot-hub/iot-hub.bicep' = {
   }
 }
 
+// Iot Hub - Role Assignments
+module iotHubRoleAssignmentModule 'modules/iot-hub/role-assignment.bicep' = {
+  name: getResourceName({ resourceAbbr: 'ras', resourceName: 'iot' }, applicationParameters)
+  params: { 
+    iotHubName: iotHubModule.outputs.iotHubName
+    roleAssignments: concat([
+      {
+        principalId: functionAppModule.outputs.identityPrincipalId
+        principalType: 'ServicePrincipal'
+        roleDefinition: 'IoTHubDataReader'
+      }
+    ], iotHubParameters.roleAssignments)
+  }
+}
+
 // Key Vault - Role Assignments
 module keyVaultRoleAssignmentModule 'modules/key-vault/role-assignment.bicep' = {
-  name: getResourceName({ resourceAbbr: 'ras' }, applicationParameters)
+  name: getResourceName({ resourceAbbr: 'ras', resourceName: 'kv' }, applicationParameters)
   params: { 
     keyVaultName: keyVaultModule.outputs.keyVaultName
     roleAssignments: concat([
diff --git a/src/backend/Infrastructure/Ts.Infrastructure/modules/iot-hub/iot-hub.bicep b/src/backend/Infrastructure/Ts.Infrastructure/modules/iot-hub/iot-hub.bicep
@@ -83,3 +83,5 @@ resource eventSubscription 'Microsoft.EventGrid/systemTopics/eventSubscriptions@
     }
   }
 }
+
+output iotHubName string = iotHub.name
diff --git a/src/backend/Infrastructure/Ts.Infrastructure/modules/iot-hub/role-assignment.bicep b/src/backend/Infrastructure/Ts.Infrastructure/modules/iot-hub/role-assignment.bicep
@@ -0,0 +1,30 @@
+﻿// ********************************************************************
+// IOT HUB ROLES ASSIGNMENT
+// https://learn.microsoft.com/en-us/azure/templates/microsoft.authorization/2022-04-01/roleassignments?pivots=deployment-language-bicep
+// ********************************************************************
+
+import { roleAssignment }  from '../../parameter-types.bicep'
+param roleAssignments roleAssignment[]
+param iotHubName string
+
+resource iotHub 'Microsoft.Devices/IotHubs@2023-06-30' existing = {
+  name: iotHubName
+}
+
+resource assignRoles 'Microsoft.Authorization/roleAssignments@2022-04-01' = [for assignment in roleAssignments: {
+  name: guid(iotHub.id, assignment.principalId, iotHubRoleDefinitions[assignment.roleDefinition])
+  scope: iotHub
+  properties: {
+    principalId: assignment.principalId
+    principalType: assignment.principalType
+    roleDefinitionId: subscriptionResourceId('Microsoft.Authorization/roleDefinitions', iotHubRoleDefinitions[assignment.roleDefinition])
+  }
+}]
+
+// https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#internet-of-things
+var iotHubRoleDefinitions = {
+    IoTHubDataContributor:      '4fc6c259-987e-4a07-842e-c321cc9d413f'
+    IoTHubDataReader:           'b447c946-2db7-41ec-983d-d8bf3b1c77e3'
+    IoTHubRegistryContributor:  '4ea46cd5-c1b2-4a8e-910b-273211f9ce47'
+    IoTHubTwinContributor:      '494bdba2-168f-4f31-a0a1-191d2f7c028c'
+}
diff --git a/src/backend/Infrastructure/Ts.Infrastructure/parameter-types.bicep b/src/backend/Infrastructure/Ts.Infrastructure/parameter-types.bicep
@@ -93,6 +93,7 @@ type iotHubParams = {
   
   retentionTimeInDays: 1 | 7 | 30
   location: 'westeurope' | 'swedencentral' | 'norwayeast'
+  roleAssignments: roleAssignment[]
 }
 
 @export()
@@ -110,7 +111,8 @@ type monitorParams = {
 type roleAssignment = {
   principalId: string
   principalType: 'Device' | 'ForeignGroup' | 'Group' | 'ServicePrincipal' | 'User'
-  roleDefinition: 'Administrator' | 'CertificateOfficer' | 'Contributor' | 'CryptoOfficer' | 'CryptoServiceEncryptionUser' | 'CryptoUser' | 'Reader' | 'SecretsOfficer' | 'SecretsUser'
+  roleDefinition: 'Administrator' | 'SecretsUser'   // Key Vault
+                  | 'IoTHubDataReader'              // Iot Hub
 }
 
 @export()
diff --git a/src/backend/Infrastructure/Ts.Infrastructure/ts.dev.bicepparam b/src/backend/Infrastructure/Ts.Infrastructure/ts.dev.bicepparam
@@ -74,4 +74,10 @@ param iotHubParameters = {
     }
     location: 'norwayeast'
     retentionTimeInDays: 1
-}
+    roleAssignments: [
+    {
+      principalId: userDefinitions.Administrator_NonProd.principalId
+      principalType: 'Group'
+      roleDefinition: 'IoTHubDataReader'
+    }
+  ]}
diff --git a/src/backend/Infrastructure/Ts.Infrastructure/ts.prod.bicepparam b/src/backend/Infrastructure/Ts.Infrastructure/ts.prod.bicepparam
@@ -75,4 +75,5 @@ param iotHubParameters = {
     }
     location: 'westeurope'
     retentionTimeInDays: 1
-}
+    roleAssignments: []
+  }
diff --git a/src/backend/global.json b/src/backend/global.json
@@ -1,6 +1,6 @@
 ﻿{
   "sdk": {
-    "version": "8.0.300",
+    "version": "8.0.401",
     "rollForward": "latestFeature"
   }
 }
