internal/functions/invoke-timesignal.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<#
.SYNOPSIS
Invoke timing logic
 
.DESCRIPTION
Invoke timing logic that keeps track of the time spend inside a function
 
.PARAMETER Start
Switch to instruct the cmdlet that the starting of measurement
 
.PARAMETER End
Switch to instruct the cmdlet that the ending of measurement
 
.EXAMPLE
Invoke-TimeSignal -Start
 
This will start the timing measurement.
 
.EXAMPLE
Invoke-TimeSignal -End
 
This will end the timing measurement and have the cmdlet write the details into the verbose log.
 
.NOTES
Author: Mötz Jensen (@Splaxi)
 
#>

function Invoke-TimeSignal {
    [CmdletBinding(DefaultParameterSetName = 'Start')]
    param (
        [Parameter(Mandatory = $true, ParameterSetName = 'Start', Position = 1 )]                    
        [switch] $Start,    
        
        [Parameter(Mandatory = $True, ParameterSetName = 'End', Position = 2 )]                    
        [switch] $End
    )
    $Time = (Get-Date)

    $Command = (Get-PSCallStack)[1].Command

    if($Start.IsPresent) {
        if($Script:TimeSignals.ContainsKey($Command)) {
            Write-PSFMessage -Level Verbose -Message "The command '$Command' was already taking part in time measurement. The entry has been update with current date and time."
            $Script:TimeSignals[$Command] = $Time
        }
        else{
            $Script:TimeSignals.Add($Command, $Time)
        }
    }
    else{
        if($Script:TimeSignals.ContainsKey($Command)) {
            $TimeSpan = New-TimeSpan -End $Time -Start (($Script:TimeSignals)[$Command])

            Write-PSFMessage -Level Verbose -Message "Total time spent inside the function was $TimeSpan" -Target $TimeSpan -FunctionName $Command -Tag "TimeSignal"
            $Script:TimeSignals.Remove($Command)
        }
        else {
            Write-PSFMessage -Level Verbose -Message "The command '$Command' was never started to take part in time measurement."        
        }
    }
}