Merge pull request #34 from DevExcelerate/feature/add-telemetry-and-feature-flags

Calin Lupas · web-flow · commit b0009ccb1342 · 2025-04-30T16:10:37.000-04:00
Add feature flags and telemetry
diff --git a/docs/main.md b/docs/main.md
@@ -20,7 +20,7 @@ This application is built using .NET Core. It supports multiple data stores, inc
 | `Logging:LogLevel:Default`               | String | Specifies the default log level.                                            |
 | `Logging:LogLevel:Microsoft.AspNetCore`  | String | Log level for Microsoft.AspNetCore namespace.                               |
 | `AllowedHosts`                           | String | Comma-separated list of allowed hosts.                                      |
-| `AllowedOrigins`                         | Array  | List of allowed origins for CORS. Example: https://localhost:8000                                          |
+| `AllowedOrigins`                         | Array  | List of allowed origins for CORS. Example: https://localhost:8000           |
 | `AppLocale`                              | String | Application locale, optional, defaults to "en" (English).                   |
 | `GitHub:AppId`                           | String | GitHub App ID.                                                              |
 | `GitHub:WebhookSecret`                   | String | Secret for GitHub webhooks.                                                 |
@@ -32,13 +32,37 @@ This application is built using .NET Core. It supports multiple data stores, inc
 | `GitHub:RepoRulesetsCustomPropertyName`  | String | Custom property name for repository rulesets.                               |
 | `Azure:KeyVaultName`                     | String | Name of the Azure Key Vault.                                                |
 | `Azure:KeyName`                          | String | Name of the key in Azure Key Vault.                                         |
+| `Azure:AzureMonitor:EnableTelemetry`     | String | Whether to enable telemetry or not.                                         |
+| `Azure:AzureMonitor:UseEntraIdAuthentication` | String | When telemetry is enabled, whether to use entra for authentication vs Instrumentation Key. |
 | `DataStore:Type`                         | String | Type of data store (FileSystem, CosmosDb, SqlServer).                       |
 | `DataStore:FileSystem:FilePath`          | String | File path for file system data store.                                       |
 | `DataStore:CosmosDb:Database`            | String | Database name for Cosmos DB.                                                |
 | `DataStore:CosmosDb:ConnectionString`    | String | Connection string for Cosmos DB.                                            |
-| `DataStore:CosmosDb:GitHubWebhooksContainer` | String | Container for GitHub webhooks in Cosmos DB.                                 |
+| `DataStore:CosmosDb:GitHubWebhooksContainer` | String | Container for GitHub webhooks in Cosmos DB.                             |
 | `DataStore:SqlServer:ConnectionString`   | String | Connection string for SQL Server.                                           |
 
+### Feature flags
+
+Follows the .NET FeatureManagement [schema](https://learn.microsoft.com/en-us/azure/azure-app-configuration/feature-management-dotnet-reference#net-feature-management-schema)
+
+```json
+"feature_management": {
+  "feature_flags": [
+    {
+      "id": "IssueAutoApprove",
+      "display_name": "Auto Approve Issues",
+      "description": "Whether to auto approve issues or let someone approve them",
+      "enabled": true
+    },
+    {
+      "id": "UseInventoryWithPullRequest",
+      "display_name": "Use Pull Request for Inventory Metadata",
+      "description": "Determines whether to use a pull request to populate the inventory metadata or not",
+      "enabled": true
+    }
+  ]
+}
+```
 
 ### Example
 
@@ -67,7 +91,11 @@ This application is built using .NET Core. It supports multiple data stores, inc
   },
   "Azure": {
     "KeyVaultName": "",
-    "KeyName": ""
+    "KeyName": "",
+    "AzureMonitor": {
+      "EnableTelemetry": true,
+      "UseEntraIdAuthentication": false
+    }
   },
   "DataStore": {
     // FileSystem, CosmosDb, SqlServer
diff --git a/src/DevExcelerateApi/Core/Options/AzureMonitorOptions.cs b/src/DevExcelerateApi/Core/Options/AzureMonitorOptions.cs
@@ -0,0 +1,19 @@
+﻿namespace DevExcelerateApi.Core.Options;
+
+public class AzureMonitorOptions
+{
+    /// <summary>
+    /// Gets the configuration section name for GitHub options.
+    /// </summary>
+    public static readonly string ConfigurationSectionName = "Azure:AzureMonitor";
+
+    /// <summary>
+    /// Gets or sets whether to enable telemetry.
+    /// </summary>
+    public bool EnableTelemetry { get; set; }
+
+    /// <summary>
+    /// Gets or sets whether to use Entra ID authentication instead of the instrumentation key.
+    /// </summary>
+    public bool UseEntraIdAuthentication { get; set; }
+}
diff --git a/src/DevExcelerateApi/Core/Options/GitHubOptions.cs b/src/DevExcelerateApi/Core/Options/GitHubOptions.cs
@@ -46,18 +46,6 @@ public class GitHubOptions
     [Required]
     public required string RepoPolicy { get; set; }
 
-    /// <summary>
-    /// Flag to auto approve the issue opened
-    /// </summary>
-    [Required]
-    public required bool IssueAutoApprove { get; set; }
-
-    /// <summary>
-    /// Flag to save repository from issue event or use the inventory repository.
-    /// </summary>
-    [Required]
-    public required bool UseInventoryWithPullRequest { get; set; }    
-
     /// <summary>
     /// The custom property name for the repository rulesets.
     /// </summary>
diff --git a/src/DevExcelerateApi/DevExcelerateApi.csproj b/src/DevExcelerateApi/DevExcelerateApi.csproj
@@ -9,8 +9,10 @@
   <ItemGroup>
 	<PackageReference Include="Azure.Extensions.AspNetCore.Configuration.Secrets" Version="1.4.0" />
 	<PackageReference Include="Azure.Identity" Version="1.13.2" />
+	<PackageReference Include="Azure.Monitor.OpenTelemetry.AspNetCore" Version="1.2.0" />
 	<PackageReference Include="Azure.Security.KeyVault.Keys" Version="4.7.0" />
 	<PackageReference Include="Microsoft.Azure.Cosmos" Version="3.49.0" />
+	<PackageReference Include="Microsoft.FeatureManagement" Version="4.0.0" />
 	<PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" Version="8.9.0" />
 	<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
 	<PackageReference Include="Octokit" Version="14.0.0" />
diff --git a/src/DevExcelerateApi/Program.cs b/src/DevExcelerateApi/Program.cs
@@ -1,10 +1,14 @@
+using Azure.Monitor.OpenTelemetry.AspNetCore;
 using DevExcelerateApi.Core.Extensions;
 using DevExcelerateApi.Core.Options;
 using DevExcelerateApi.Services;
 using Microsoft.AspNetCore.Localization;
 using Octokit.Webhooks.AspNetCore;
 using System.Resources;
 using System.Text.Json;
+using Azure.Core;
+using Azure.Identity;
+using Microsoft.FeatureManagement;
 
 // see https://learn.microsoft.com/en-us/aspnet/core/fundamentals/localization/provide-resources?view=aspnetcore-9.0#culture-fallback-behavior
 [assembly: NeutralResourcesLanguage("en")]
@@ -39,6 +43,37 @@ public static async Task Main(string[] args)
             // Add named HTTP clients for IHttpClientFactory
             builder.Services.AddHttpClient();
 
+            var azureOptions = builder.Configuration.GetSection(Core.Options.AzureMonitorOptions.ConfigurationSectionName).Get<Core.Options.AzureMonitorOptions>();
+            //If you set the connection string in multiple places, the environment variable will be prioritized in the following order:
+            // Code
+            // Environment variable (APPLICATIONINSIGHTS_CONNECTION_STRING)
+            // Configuration file
+            if (azureOptions!.EnableTelemetry)
+            {
+                builder.Services.AddOpenTelemetry().UseAzureMonitor(options =>
+                {
+                    if (!azureOptions.UseEntraIdAuthentication)
+                    {
+                        return;
+                    }
+
+                    TokenCredential azureCredentials = builder.Environment.IsDevelopment()
+                        // Only allow Developer style credentials in development
+                        ? new ChainedTokenCredential(
+                            new VisualStudioCredential(),
+                            new VisualStudioCodeCredential(),
+                            new AzureCliCredential(),
+                            new AzureDeveloperCliCredential(),
+                            new AzurePowerShellCredential())
+                        // Only allow managed identity credential in production
+                        : new ManagedIdentityCredential();
+
+                    options.Credential = azureCredentials;
+                });
+            }
+
+            builder.Services.AddFeatureManagement();
+
             // Application Build & Run
 
             // Configure middleware and endpoints
diff --git a/src/DevExcelerateApi/Properties/launchSettings.json b/src/DevExcelerateApi/Properties/launchSettings.json
@@ -7,7 +7,8 @@
       "launchBrowser": false,
       "applicationUrl": "http://localhost:5131",
       "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "APPLICATIONINSIGHTS_CONNECTION_STRING": ""
       }
     },
     "https": {
@@ -16,7 +17,8 @@
       "launchBrowser": false,
       "applicationUrl": "https://localhost:7135;http://localhost:5131",
       "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "APPLICATIONINSIGHTS_CONNECTION_STRING": ""
       }
     }
   }
diff --git a/src/DevExcelerateApi/Services/DevExIssuesEventProcessorService.cs b/src/DevExcelerateApi/Services/DevExIssuesEventProcessorService.cs
@@ -3,6 +3,7 @@
 using DevExcelerateApi.Data;
 using DevExcelerateApi.Models;
 using Microsoft.Extensions.Options;
+using Microsoft.FeatureManagement;
 using Octokit.Webhooks;
 using Octokit.Webhooks.Events;
 using Octokit.Webhooks.Events.IssueComment;
@@ -19,7 +20,8 @@ public class DevExIssuesEventProcessorService(
         IIssueService issueService,
         GitHubWebhookRepository gitHubWebhookRepository,
         IOptions<GitHubOptions> gitHubOptions,
-        ILocalizationService localizationService) 
+        ILocalizationService localizationService,
+        IVariantFeatureManager featureManager) 
         : IDevExIssuesEventProcessorService
     {
         private readonly ILogger<DevExIssuesEventProcessorService> _logger = logger;
@@ -29,6 +31,7 @@ public class DevExIssuesEventProcessorService(
         private readonly GitHubWebhookRepository _gitHubWebhookRepository = gitHubWebhookRepository;
         private readonly GitHubOptions _gitHubOptions = gitHubOptions.Value;
         private readonly ILocalizationService _localizationService = localizationService;
+        private readonly IVariantFeatureManager _featureManager = featureManager;
 
         public async Task SaveAndProcessIssueEventAsync(WebhookHeaders headers, IssuesEvent issuesEvent, IssuesAction action)
         {
@@ -88,7 +91,7 @@ private async Task ValidateIssueApproval(IssuesEvent issuesEvent)
             // Opened
             if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueOpened())).GetValueOrDefault())
             {
-                if (_gitHubOptions.IssueAutoApprove)
+                if (await _featureManager.IsEnabledAsync("IssueAutoApprove"))
                 {
                     // TODO: add more conditions for auto-approval
 
@@ -130,7 +133,7 @@ private async Task ValidateIssue(IssuesEvent issuesEvent)
                     }
                     else if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueValidated())).GetValueOrDefault())
                     {
-                        if (_gitHubOptions.UseInventoryWithPullRequest)
+                        if (await _featureManager.IsEnabledAsync("UseInventoryWithPullRequest"))
                         {
                             // IF validated, create a pull request
                             await _repositoryService.ValidateCreateRepository(issuesEvent!, createPullRequest: true);
@@ -186,12 +189,12 @@ private async Task ValidateIssueCommentApproval(string data, IssueCommentEvent i
                 )
                )
             {
-                await _issueService.ChangeIssueLabel([TicketStatus.APPROVED.ToString()], issueCommentEvent!);
+                await _issueService.ChangeIssueLabel([nameof(TicketStatus.APPROVED)], issueCommentEvent!);
             }
             // Opened -> Rejected
             else if ((data?.IsIssueRejected()).GetValueOrDefault() && !(issueCommentEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueRejected())).GetValueOrDefault())
             {
-                await _issueService.ChangeIssueLabel([TicketStatus.REJECTED.ToString()], issueCommentEvent!);
+                await _issueService.ChangeIssueLabel([nameof(TicketStatus.REJECTED)], issueCommentEvent!);
             }
         }
     }
diff --git a/src/DevExcelerateApi/appsettings.json b/src/DevExcelerateApi/appsettings.json
@@ -16,13 +16,15 @@
     "RepoOnboarding": "",
     "RepoInventory": "",
     "RepoPolicy": "",
-    "IssueAutoApprove": "true",
-    "UseInventoryWithPullRequest":  "true",
     "RepoRulesetsCustomPropertyName": ""
   },
   "Azure": {
     "KeyVaultName": "",
-    "KeyName": ""
+    "KeyName": "",
+    "AzureMonitor": {
+      "EnableTelemetry": false,
+      "UseEntraIdAuthentication": false
+    }
   },
   "DataStore": {
     // FileSystem, CosmosDb, SqlServer
@@ -40,5 +42,21 @@
     "SqlServer": {
       "ConnectionString": "" // dotnet user-secrets set "DataStore:SqlServer:ConnectionString" "MY_SQLSERVER_CONNECTION_STRING"
     }
+  },
+  "feature_management": {
+    "feature_flags": [
+      {
+        "id": "IssueAutoApprove",
+        "display_name": "Auto Approve Issues",
+        "description": "Whether to auto approve issues or let someone approve them",
+        "enabled": true
+      },
+      {
+        "id": "UseInventoryWithPullRequest",
+        "display_name": "Use Pull Request for Inventory Metadata",
+        "description": "Determines whether to use a pull request to populate the inventory metadata or not",
+        "enabled": true
+      }
+    ]
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,8 @@`
`7`	`7`	`"launchBrowser": false,`
`8`	`8`	`"applicationUrl": "http://localhost:5131",`
`9`	`9`	`"environmentVariables": {`
`10`		`- "ASPNETCORE_ENVIRONMENT": "Development"`
	`10`	`+ "ASPNETCORE_ENVIRONMENT": "Development",`
	`11`	`+ "APPLICATIONINSIGHTS_CONNECTION_STRING": ""`
`11`	`12`	`}`
`12`	`13`	`},`
`13`	`14`	`"https": {`
`@@ -16,7 +17,8 @@`
`16`	`17`	`"launchBrowser": false,`
`17`	`18`	`"applicationUrl": "https://localhost:7135;http://localhost:5131",`
`18`	`19`	`"environmentVariables": {`
`19`		`- "ASPNETCORE_ENVIRONMENT": "Development"`
	`20`	`+ "ASPNETCORE_ENVIRONMENT": "Development",`
	`21`	`+ "APPLICATIONINSIGHTS_CONNECTION_STRING": ""`
`20`	`22`	`}`
`21`	`23`	`}`
`22`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`using DevExcelerateApi.Data;`
`4`	`4`	`using DevExcelerateApi.Models;`
`5`	`5`	`using Microsoft.Extensions.Options;`
	`6`	`+using Microsoft.FeatureManagement;`
`6`	`7`	`using Octokit.Webhooks;`
`7`	`8`	`using Octokit.Webhooks.Events;`
`8`	`9`	`using Octokit.Webhooks.Events.IssueComment;`
`@@ -19,7 +20,8 @@ public class DevExIssuesEventProcessorService(`
`19`	`20`	`IIssueService issueService,`
`20`	`21`	`GitHubWebhookRepository gitHubWebhookRepository,`
`21`	`22`	`IOptions<GitHubOptions> gitHubOptions,`
`22`		`- ILocalizationService localizationService)`
	`23`	`+ ILocalizationService localizationService,`
	`24`	`+ IVariantFeatureManager featureManager)`
`23`	`25`	`: IDevExIssuesEventProcessorService`
`24`	`26`	`{`
`25`	`27`	`private readonly ILogger<DevExIssuesEventProcessorService> _logger = logger;`
`@@ -29,6 +31,7 @@ public class DevExIssuesEventProcessorService(`
`29`	`31`	`private readonly GitHubWebhookRepository _gitHubWebhookRepository = gitHubWebhookRepository;`
`30`	`32`	`private readonly GitHubOptions _gitHubOptions = gitHubOptions.Value;`
`31`	`33`	`private readonly ILocalizationService _localizationService = localizationService;`
	`34`	`+ private readonly IVariantFeatureManager _featureManager = featureManager;`
`32`	`35`
`33`	`36`	`public async Task SaveAndProcessIssueEventAsync(WebhookHeaders headers, IssuesEvent issuesEvent, IssuesAction action)`
`34`	`37`	`{`
`@@ -88,7 +91,7 @@ private async Task ValidateIssueApproval(IssuesEvent issuesEvent)`
`88`	`91`	`// Opened`
`89`	`92`	`if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueOpened())).GetValueOrDefault())`
`90`	`93`	`{`
`91`		`- if (_gitHubOptions.IssueAutoApprove)`
	`94`	`+ if (await _featureManager.IsEnabledAsync("IssueAutoApprove"))`
`92`	`95`	`{`
`93`	`96`	`// TODO: add more conditions for auto-approval`
`94`	`97`
`@@ -130,7 +133,7 @@ private async Task ValidateIssue(IssuesEvent issuesEvent)`
`130`	`133`	`}`
`131`	`134`	`else if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueValidated())).GetValueOrDefault())`
`132`	`135`	`{`
`133`		`- if (_gitHubOptions.UseInventoryWithPullRequest)`
	`136`	`+ if (await _featureManager.IsEnabledAsync("UseInventoryWithPullRequest"))`
`134`	`137`	`{`
`135`	`138`	`// IF validated, create a pull request`
`136`	`139`	`await _repositoryService.ValidateCreateRepository(issuesEvent!, createPullRequest: true);`
`@@ -186,12 +189,12 @@ private async Task ValidateIssueCommentApproval(string data, IssueCommentEvent i`
`186`	`189`	`)`
`187`	`190`	`)`
`188`	`191`	`{`
`189`		`- await _issueService.ChangeIssueLabel([TicketStatus.APPROVED.ToString()], issueCommentEvent!);`
	`192`	`+ await _issueService.ChangeIssueLabel([nameof(TicketStatus.APPROVED)], issueCommentEvent!);`
`190`	`193`	`}`
`191`	`194`	`// Opened -> Rejected`
`192`	`195`	`else if ((data?.IsIssueRejected()).GetValueOrDefault() && !(issueCommentEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueRejected())).GetValueOrDefault())`
`193`	`196`	`{`
`194`		`- await _issueService.ChangeIssueLabel([TicketStatus.REJECTED.ToString()], issueCommentEvent!);`
	`197`	`+ await _issueService.ChangeIssueLabel([nameof(TicketStatus.REJECTED)], issueCommentEvent!);`
`195`	`198`	`}`
`196`	`199`	`}`
`197`	`200`	`}`