Add telemetry to application (#251)

Co-authored-by: Laurent Ellerbach <[email protected]>

Author: Feiko

README.md

@@ -462,6 +462,12 @@ nanoff --clearcache
 
 The exit codes can be checked in [this source file](https://github.com/nanoframework/nanoFirmwareFlasher/blob/main/nanoFirmwareFlasher.Library/ExitCodes.cs).
 
+## Telemetry
+
+This tool is using anonymous telemetry to help us improve the usage. You can opt out by setting up an environment variable `NANOFRAMEWORK_TELEMETRY_OPTOUT` to 1.
+
+The telemetry information is mainly related to the command line arguments, the firmware versions installed and any issue that can occurs during the code execution.
+
 ## Feedback and documentation
 
 To provide feedback, report issues and finding out how to contribute please refer to the [Home repo](https://github.com/nanoframework/Home).

azure-pipelines.yml

@@ -327,6 +327,17 @@ jobs:
         eq(variables['UPDATE_DEPENDENTS'], 'false')
       )
 
+  # Replace the intrument key
+  - powershell: |
+          . ./common.ps1
+          $fileToReplace = "$(System.DefaultWorkingDirectory)/nanoFirmwareFlasher.Library/appsettings.json"
+          $sourceString = "INTRUMENT_KEY"
+          $instrumentKey = "$(InstrumentKey)"
+
+          Find-ReplaceInFile -filePath $fileToReplace -sourceString $sourceString -targetString $instrumentKey
+    displayName: Replace intrument key
+    condition: succeeded()
+
   - task: CopyFiles@1
     condition: >-
       and(

common.ps1

@@ -0,0 +1,62 @@
+
+# Common functions used by the other scripts
+
+function Check-DirectoryExists {
+    param (
+        [string]$rootDirectory
+    )
+
+    return Test-Path -Path $rootDirectory -PathType Container
+}
+
+function Find-ReplaceInFiles {
+    param (
+        [string]$rootDirectory,
+        [string]$sourceString,
+        [string]$targetString
+    )
+
+    Get-ChildItem -Recurse -File $rootDirectory | ForEach-Object {
+        $filePath = $_.FullName
+
+        Find-ReplaceInFile -filePath $filePath -sourceString $sourceString -targetString $targetString
+    }
+
+    Write-Host "String replacement completed."
+}
+
+function Find-ReplaceInFile {
+    param (
+        [string]$filePath,
+        [string]$sourceString,
+        [string]$targetString
+    )
+
+    # Get the original encoding of the file
+    $sr = New-Object System.IO.StreamReader($filePath, $true)
+    [char[]] $buffer = new-object char[] 3
+    $sr.Read($buffer, 0, 3)  
+    $originalEncoding = $sr.CurrentEncoding
+    $sr.Close()
+
+    # Making it simple as we only want to preserve UTF8 encoding
+    if ( $originalEncoding.BodyName -eq "utf-8" ) {
+      $fileEncoding = "UTF8" 
+    }
+    else {
+      $fileEncoding = "ASCII" 
+    }
+    
+    # Read the content of the file using the original encoding
+    $content = Get-Content -Path $filePath -Raw -Encoding $fileEncoding
+    
+    # Perform the replacement
+    $newContent = $content -replace [regex]::Escape($sourceString), $targetString
+
+    if ($content -ne $newContent) {
+        Write-Host "Replacing in $filePath"
+        
+        # Save the modified content back to the file using the original encoding
+        Set-Content -Path $filePath -Value $newContent -Encoding $fileEncoding
+    }
+}

nanoFirmwareFlasher.Library/FirmwarePackage.cs

@@ -14,6 +14,11 @@
 using System.Net.Http;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
+using Microsoft.ApplicationInsights;
+using Microsoft.ApplicationInsights.DataContracts;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Configuration.Json;
+using System.Reflection;
 
 namespace nanoFramework.Tools.FirmwareFlasher
 {
@@ -34,6 +39,8 @@ public abstract class FirmwarePackage : IDisposable
 
         private const string _readmeContent = "This folder contains nanoFramework firmware files. Can safely be removed.";
 
+        private static IConfigurationRoot _configuration;
+
         /// <summary>
         /// Path with the base location for firmware packages.
         /// </summary>
@@ -97,13 +104,25 @@ public static string LocationPathBase
         /// </summary>
         public object BooterStartAddress { get; internal set; }
 
+
+
         static FirmwarePackage()
         {
             _cloudsmithClient = new HttpClient
             {
                 BaseAddress = new Uri("https://api.cloudsmith.io/v1/packages/net-nanoframework/")
             };
             _cloudsmithClient.DefaultRequestHeaders.Add("Accept", "*/*");
+
+            if (_configuration == null)
+            {
+
+                var builder = new ConfigurationBuilder()
+                    .SetBasePath(Directory.GetCurrentDirectory())
+                    .AddJsonFile("appsettings.json");
+
+                _configuration = builder.Build();
+            }
         }
 
         /// <summary>
@@ -342,7 +361,42 @@ internal async Task<ExitCodes> DownloadAndExtractAsync()
                             Console.ForegroundColor = ConsoleColor.White;
                         }
 
+                        //send app insight on successful download
+
+                        string insightConnectionString = _configuration["iConnectionString"];
+                        string optOut = Environment.GetEnvironmentVariable("NANOFRAMEWORK_TELEMETRY_OPTOUT");
+
                         stepSuccessful = true;
+
+                        if (!string.IsNullOrEmpty(insightConnectionString) && optOut != "1")
+                        {
+                            TelemetryClient telemetryClient = new TelemetryClient(new Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration()
+                            {
+                                ConnectionString = insightConnectionString
+                            });
+                            AssemblyInformationalVersionAttribute nanoffVersion = null;
+
+                            try
+                            {
+                                nanoffVersion = Attribute.GetCustomAttribute(
+                                         Assembly.GetEntryAssembly()!,
+                                         typeof(AssemblyInformationalVersionAttribute))
+                                     as AssemblyInformationalVersionAttribute;
+                            }
+                            catch
+                            {
+
+                            }
+                            var packageTelemetry = new EventTelemetry("PackageDownloaded");
+                            packageTelemetry.Properties.Add("TargetName", _targetName);
+                            packageTelemetry.Properties.Add("Version", Version);
+                            packageTelemetry.Properties.Add("nanoffVersion", nanoffVersion == null ? "unknown" : nanoffVersion.InformationalVersion);
+                            telemetryClient.TrackEvent(packageTelemetry);
+                            telemetryClient.Flush();
+
+                        }
+
+
                     }
                     catch
                     {

nanoFirmwareFlasher.Library/appsettings.json

@@ -0,0 +1,4 @@
+{
+  "iConnectionString": "INTRUMENT_KEY"
+
+}

nanoFirmwareFlasher.Library/nanoFirmwareFlasher.Library.csproj

@@ -58,6 +58,9 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.ApplicationInsights" Version="2.22.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration" Version="8.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="8.0.0" />
     <PackageReference Include="nanoFramework.Tools.Debugger.Net" Version="2.4.36" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageReference Include="Nerdbank.GitVersioning" Version="3.6.133" PrivateAssets="All" />
@@ -124,5 +127,10 @@
         <None Include="..\lib\uniflash\**" Link="uniflash\%(RecursiveDir)%(Filename)%(Extension)">
         </None>
     </ItemGroup>
+    <ItemGroup>
+      <None Update="appsettings.json">
+        <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+      </None>
+    </ItemGroup>
 
 </Project>