Added telemetry for MSBuildV1 task (#15512)

* Added telemetry for MSBuildV1 task

* Remove extra code

* Move to stopwatch from meaure-command

* Resolved comments

* Bumped XamarinAndroid version

* Fix test

* Fix VSBuild tests

* Add missed semicolon

Co-authored-by: Alexander Smolyakov <[email protected]>

* Change let to const

* Bump Xamarin android

Co-authored-by: Alexander Smolyakov <[email protected]>

Author: EzzhevNikita

Tasks/Common/MSBuildHelpers/MSBuildHelpers.psm1

@@ -4,6 +4,7 @@ Import-VstsLocStrings "$PSScriptRoot\module.json"
 . $PSScriptRoot\ArgumentFunctions
 . $PSScriptRoot\InvokeFunctions
 . $PSScriptRoot\PathFunctions
+. $PSScriptRoot\TelemetryHelper
 Export-ModuleMember -Function @(
     # Argument functions.
     'Format-MSBuildArguments'
@@ -14,4 +15,6 @@ Export-ModuleMember -Function @(
     'Get-SolutionFiles'
     'Get-VisualStudio'
     'Select-MSBuildPath'
+    # Telemetry emiter
+    'EmitTelemetry'
 )

Tasks/Common/MSBuildHelpers/TelemetryHelper.ps1

@@ -0,0 +1,18 @@
+function EmitTelemetry {
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory = $true)]
+        [PSCustomObject]$TelemetryPayload,
+        [Parameter(Mandatory = $true)]
+        [string]$TaskName)
+
+    try {
+        Assert-VstsAgent -Minimum '2.120.0'
+
+        $telemetryJson = ConvertTo-Json $TelemetryPayload -Compress
+
+        Write-Host "##vso[telemetry.publish area=TaskHub;feature=$TaskName]$telemetryJson"
+    } catch {
+        Write-Verbose "Failed to publish java telemetry: $errors"
+    }
+}

Tasks/MSBuildV1/MSBuild.ps1

@@ -2,6 +2,18 @@
 param()
 
 Trace-VstsEnteringInvocation $MyInvocation
+$msbuildTelemetry = [PSCustomObject]@{
+    MSBuildVersion = ""
+    MSBuildArguments = ""
+    MSBuildLocationMethod = ""
+    Platform = ""
+    Configuration = ""
+    MSBuildExecutionTimeSeconds = ""
+}
+
+# Import the helpers.
+Import-Module -Name $PSScriptRoot\ps_modules\MSBuildHelpers\MSBuildHelpers.psm1
+
 try {
     Import-VstsLocStrings "$PSScriptRoot\Task.json"
 
@@ -24,8 +36,11 @@ try {
     [string]$msBuildVersion = Get-VstsInput -Name MSBuildVersion
     [string]$msBuildArchitecture = Get-VstsInput -Name MSBuildArchitecture
 
-    # Import the helpers.
-    Import-Module -Name $PSScriptRoot\ps_modules\MSBuildHelpers\MSBuildHelpers.psm1
+    $msbuildTelemetry.MSBuildVersion = "$msBuildVersion"
+    $msbuildTelemetry.MSBuildArguments = "$msBuildArguments"
+    $msbuildTelemetry.MSBuildLocationMethod = "$msBuildLocationMethod"
+    $msbuildTelemetry.Platform = "$platform"
+    $msbuildTelemetry.Configuration = "$configuration"
 
     # Resolve match patterns.
     $solutionFiles = Get-SolutionFiles -Solution $solution
@@ -44,7 +59,14 @@ try {
     $global:ErrorActionPreference = 'Continue'
 
     # Build each solution.
+    $stopwatch = New-Object System.Diagnostics.Stopwatch
+    $stopwatch.Start()
+
     Invoke-BuildTools -NuGetRestore:$restoreNuGetPackages -SolutionFiles $solutionFiles -MSBuildLocation $msBuildLocation -MSBuildArguments $msBuildArguments -Clean:$clean -NoTimelineLogger:(!$logProjectEvents) -CreateLogFile:$createLogFile -LogFileVerbosity:$logFileVerbosity
+
+    $stopwatch.Stop()
+    $msbuildTelemetry.MSBuildExecutionTimeSeconds = $stopwatch.ElapsedMilliseconds / 1000
 } finally {
+    EmitTelemetry -TelemetryPayload $msbuildTelemetry -TaskName "MSBuildV1"
     Trace-VstsLeavingInvocation $MyInvocation
-}
+}

Tasks/MSBuildV1/Tests/PassesArguments.ps1

@@ -6,6 +6,7 @@ param()
 Register-Mock Trace-VstsEnteringInvocation
 Register-Mock Trace-VstsLeavingInvocation
 Register-Mock Import-VstsLocStrings
+Register-Mock EmitTelemetry
 $variableSets = @(
     @{ Clean = $false ; MaximumCpuCount = $false ; RestoreNugetPackages = $false ; LogProjectEvents = $false ; CreateLogFile = $false ; LogFileVerbosity = '' ; Debug = $false }
     @{ Clean = $false ; MaximumCpuCount = $false ; RestoreNugetPackages = $false ; LogProjectEvents = $false ; CreateLogFile = $true ; LogFileVerbosity = '' ; Debug = $false }

Tasks/MSBuildV1/msbuild.ts

@@ -2,8 +2,10 @@ import path = require('path');
 import tl = require('azure-pipelines-task-lib/task');
 import { ToolRunner } from 'azure-pipelines-task-lib/toolrunner';
 import msbuildHelpers = require('msbuildhelpers/msbuildhelpers');
+import { TelemetryPayload, emitTelemetry } from './telemetryHelper';
 
 async function run() {
+    const telemetry = {} as TelemetryPayload;
     try {
         tl.setResourcePath(path.join(__dirname, 'task.json'));
 
@@ -14,6 +16,11 @@ async function run() {
         let msbuildArguments: string = tl.getInput('msbuildArguments');
         let clean: boolean = tl.getBoolInput('clean');
 
+        // pass inputs to telemetry object
+        telemetry.configuration = configuration;
+        telemetry.platform = platform;
+        telemetry.msBuildArguments = msbuildArguments;
+
         let logsolutionEvents: boolean = tl.getBoolInput('logsolutionEvents');
         if (logsolutionEvents) {
             tl.warning(tl.loc('RecordProjectDetailsOnlySupportedOnWindows'));
@@ -28,15 +35,17 @@ async function run() {
         if (!msbuildLocationMethod) {
             msbuildLocationMethod = 'version';
         }
+        telemetry.msBuildLocationMethod = msbuildLocationMethod;
 
         let msbuildTool: string;
         if (msbuildLocationMethod === 'version') {
             let msbuildVersion: string = tl.getInput('msbuildVersion');
+            telemetry.msBuildVersion = msbuildVersion;
             msbuildTool = await msbuildHelpers.getMSBuildPath(msbuildVersion);
         }
         if (msbuildLocationMethod === 'location') {
             msbuildTool = tl.getInput('msbuildLocation');
-        } 
+        }
 
         let filesList: string[] = tl.findMatch(null, solution, { followSymbolicLinks: false, followSpecifiedSymbolicLink: false, allowBrokenSymbolicLinks: false }, { matchBase: true });
         for (let file of filesList) {
@@ -59,10 +68,18 @@ async function run() {
             if (msbuildArguments) {
                 buildTool.line(msbuildArguments);
             }
+
+            const startExecTime = new Date().getTime();
             await buildTool.exec();
+            const endExecTime = new Date().getTime();
+
+            const executionTime = (endExecTime - startExecTime) / 1000; // need to convert from milliseconds to seconds
+            telemetry.msbuildExectionTimeSeconds = executionTime;
         }
     } catch (err) {
         tl.setResult(tl.TaskResult.Failed, err);
+    } finally {
+        emitTelemetry(telemetry);
     }
 }
 

Tasks/MSBuildV1/task.loc.json

@@ -188,4 +188,4 @@
     "CreateLogFileOnlySupportedOnWindows": "ms-resource:loc.messages.CreateLogFileOnlySupportedOnWindows",
     "MSB_BuildToolNotFound": "ms-resource:loc.messages.MSB_BuildToolNotFound"
   }
-}
+}

Tasks/MSBuildV1/telemetryHelper.ts

@@ -0,0 +1,26 @@
+import tl = require('azure-pipelines-task-lib/task');
+import * as semver from 'semver';
+
+export interface TelemetryPayload {
+    msBuildVersion: string;
+    msBuildArguments: string;
+    msBuildLocationMethod: string;
+    platform: string;
+    configuration: string;
+    msbuildExectionTimeSeconds: number;
+}
+
+export function emitTelemetry(telemetryData: TelemetryPayload) {
+    try {
+        let agentVersion = tl.getVariable('Agent.Version');
+        if (semver.gte(agentVersion, '2.120.0')) {
+            let telemetry = JSON.stringify(telemetryData);
+
+            console.log(`##vso[telemetry.publish area=TaskHub;feature=MSBuildV1]${telemetry}`);
+        } else {
+            tl.debug(`Agent version of ( ${agentVersion} ) does not meet minimum requirements for telemetry`);
+        }
+    } catch (err) {
+        tl.debug(`Unable to log telemetry. Err:( ${err} )`);
+    }
+}

Tasks/VSBuildV1/Tests/MapsVSVersions.ps1

@@ -7,6 +7,7 @@ Register-Mock Get-VstsTaskVariable { $false } -- -Name System.Debug -AsBool
 Register-Mock Get-SolutionFiles
 Register-Mock Format-MSBuildArguments
 Register-Mock Invoke-BuildTools
+Register-Mock EmitTelemetry
 $mappings = @(
     @{ VSVersion = '' ; MSBuildVersion = '14.0' }
     @{ VSVersion = '17.0' ; MSBuildVersion = '17.0' }

Tasks/VSBuildV1/Tests/PassesArguments.ps1

@@ -23,6 +23,7 @@ foreach ($variableSet in $variableSets) {
     Unregister-Mock Select-MSBuildPath
     Unregister-Mock Format-MSBuildArguments
     Unregister-Mock Invoke-BuildTools
+    Register-Mock EmitTelemetry
     Register-Mock Get-VstsInput { $variableSet.VSVersion } -- -Name VSVersion
     Register-Mock Get-VstsInput { 'Some input architecture' } -- -Name MSBuildArchitecture
     Register-Mock Get-VstsInput { 'Some input arguments' } -- -Name MSBuildArgs

Tasks/VSBuildV1/Tests/ThrowsIfUnknownVSVersion.ps1

@@ -4,6 +4,7 @@ param()
 # Arrange.
 . $PSScriptRoot\..\..\..\Tests\lib\Initialize-Test.ps1
 Register-Mock Get-SolutionFiles
+Register-Mock EmitTelemetry
 Register-Mock Get-VstsInput { '14.0' } -- -Name VSVersion
 Register-Mock Get-VstsInput { 'Some input architecture' } -- -Name MSBuildArchitecture
 Register-Mock Get-VstsInput { 'Some input arguments' } -- -Name MSBuildArgs