Repository navigation
Expand file tree
/
Copy pathPSSysLog.psm1
More file actions
1157 lines (982 loc) · 33.6 KB
/
Copy pathPSSysLog.psm1
File metadata and controls
1157 lines (982 loc) · 33.6 KB
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
Set-StrictMode -Version 3.0
<#
os_log notes:
There are no public APIs on MacOS for consuming os_log data or
collecting log output in real-time. To get log data in a programmatically consumable
format, the data must first be extracted then converted to a raw text format.
Extraction requires the following steps:
1: Snapshot the current time
2: Enable persistence of PowerShell log entries
See Set-OsLogPersistence
3: Run powershell to generate the expected log output
4: Run 'log collect' to retrieve log records after a specific timestamp
from the system logs.
Note that the extracted data is still not directly consumable.
5: Run 'log show' to convert the extracted data to text and redirect it
to a file.
The --predicate can be used at this point to filter extracted records.
The typical filter is 'process == "pwsh"'
The redirected text file can then be consumed by this module.
Example command-lines:
sudo log collect --start "2018-02-07 14:33:30" --output ./system.logarchive
log show ./system.logarchive/ --info --predicate 'process == "pwsh"' >pwsh.log.txt
Parsing Notes:
* Sample contains 6.0.1 content (which is out of date) revise with 6.1.0 preview
* Ensure analytic data is considered when parsing; specifically Provider_Lifecycle:ProviderStart.Method.Informational
* Multi-line output is expected. Parsing needs to detect the timestamp at the beginning
of a line and append subsequent lines to the message until the next 'log' line is found.
* Header lines need to be skipped.
Sample output from 'log show' illustrating one single-line entry and one multi-line entry.
Analytic log items are often multi-line because the message text contains newline characters.
==========
/Users/psbuildacct/system.logarchive
==========
Timestamp Thread Type Activity PID
2018-02-07 14:34:35.256501-0800 0x2a3730 Default 0x0 39437 pwsh: (libpsl-native.dylib) [com.microsoft.powershell.powershell] (v6.0.1:1:10) [Perftrack_ConsoleStartupStart:PowershellConsoleStartup.WinStart.Informational] PowerShell console is starting up
2018-02-07 14:34:35.562003-0800 0x2a373a Default 0x0 39437 pwsh: (libpsl-native.dylib) [com.microsoft.powershell.powershell] (v6.0.1:4:11) [Provider_Lifecycle:ProviderStart.Method.Informational] Provider Alias changed state to Started.
Context:
Severity = Informational
Host Name = ConsoleHost
Host Version = 6.0.1
Host ID = 964756e8-c074-4228-a54d-d410a88e8c66
Host Application = /usr/local/microsoft/powershell/6.0.1/pwsh.dll
Engine Version =
Runspace ID =
Pipeline ID =
Command Name =
Command Type =
Script Name =
Command Path =
Sequence Number = 1
User = PowerShells-MacBook\psbuildacct
Connected User =
Shell ID = Microsoft.PowerShell
User Data:
#>
#region Utilities
function Test-Sudo
{
if(-not (Test-Path -Path "env:SUDO_USER"))
{
throw "This command must be run from sudo"
}
}
function Test-MacOS
{
if (-not $IsMacOS)
{
throw "This command requires MacOS"
}
}
function Test-Linux
{
if (-not $IsLinux)
{
throw "This command requires Linux"
}
}
function Start-NativeExecution
{
param
(
[Parameter(Mandatory)]
[ValidateNotNull()]
[ScriptBlock] $command
)
$saveErrorAction = $ErrorActionPreference
$ErrorActionPreference = 'Continue'
try
{
& $command
if ($LASTEXITCODE -ne 0)
{
throw "Execution of {$command} failed with exit code $LASTEXITCODE"
}
}
finally
{
$ErrorActionPreference = $saveErrorAction
}
}
#endregion Utilities
#region SysLog support
# Defines the array indices when calling
# String.Split on a SysLog log entry
enum SysLogIds
{
Month = 0;
Day = 1;
Time = 2;
Hostname = 3;
Id = 4;
CommitId = 5;
EventId = 6;
Message = 7;
}
# Defines the array indices when calling
# String.Split on an OsLog log entry
Class OsLogIds
{
[int] $Date = 0;
[int] $Time = 1;
[int] $Thread = 2;
[int] $Type = 3;
[int] $Activity = 4;
[int] $PID = 5;
[int] $TTL = 6;
[int] $ProcessName = 7;
[int] $Module = 8;
[int] $Id = 9;
[int] $CommitId = 10;
[int] $EventId = 11;
[int] $Message = 12;
[void] UseOldIds()
{
$this.ProcessName=6;
$this.Module =7;
$this.Id =8;
$this.CommitId=9;
$this.EventId=10;
$this.Message=11;
}
}
class PSLogItem
{
[string] $LogId = [string]::Empty
[DateTime] $Timestamp = [DateTime]::Now
[string] $Hostname = [string]::Empty
[int] $ProcessId = 0
[int] $ThreadId = 0
[int] $Channel = 0
[string] $CommitId = [string]::Empty
[string] $EventId = [string]::Empty
[string] $Message = [string]::Empty
[int] $Count = 1
[System.Collections.Generic.List[String]]$ParseErrors = [System.Collections.Generic.List[string]]::new()
hidden static $monthNames = @('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun','Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec')
hidden static [int] GetMonth([string] $value)
{
Set-StrictMode -Version 3.0
for ($x = 0; $x -lt [PSLogItem]::monthNames.Count; $x++)
{
[string] $monthName = [PSLogItem]::monthNames[$x]
if ($value.StartsWith($monthName, [StringComparison]::InvariantCultureIgnoreCase))
{
return $x + 1
}
}
return 1
}
static [PSLogItem] ConvertSysLog([string] $content, [string] $id, [Nullable[DateTime]] $after)
{
Set-StrictMode -Version 3.0
<#
MMM dd HH:MM:SS machinename id[PID]: (commitid:TID:CHANNEL) [EventName] Message
Expecting split to return
0: Month (abreviated)
1: DD
2: HH:MM:SS
3: hostname
4: nameid[processid]:
5: (commitid:treadid:channel)
6: [EventId]
7: Message Text
NOTE: In some cases, syslog will detect the same message being logged multiple times.
In those cases, a single message is logged in the following format
MMM dd HH:MM:SS machinename id[PID]: message repeated NNN times: [(commitid:TID:CHANNEL) [EventName] Message]
Alternatively, more recent syslog daemons may change the message format to:
2023-06-02T22:49:50.513735+00:00 machinename id[PID]: message repeated NNN times: [(commitid:TID:CHANNEL) [EventName] Message]
the first element of the line may be converted to a datetime, which we can use to convert the input to the expected string.
#>
$firstToken = $content.split()[0]
$dt = $firstToken -as [DateTime]
if ($dt)
{
$replacement = "{0:MMM} {0:dd} {0:hh}:{0:mm}:{0:ss}" -f $dt
$content = $content.replace($firstToken,$replacement)
}
# split contents into separate space delimited tokens (first 7) and leave the rest as the message.
[string[]] $parts = $content.Split(' ', 8, [System.StringSplitOptions]::RemoveEmptyEntries)
if ($parts.Count -ne 8)
{
Write-Verbose -Message "Skipping unparsable entry: $content"
return $null
}
if ($id)
{
# If the log entry doesn't have the expected $id, return null.
if ($parts[[SysLogIds]::Id].StartsWith($id, [StringComparison]::OrdinalIgnoreCase) -eq $false)
{
return $null
}
}
$now = [DateTime]::Now
$month = [PSLogItem]::GetMonth($parts[[SysLogIds]::Month])
$day = [int]::Parse($parts[[SysLogIds]::Day])
# guess at the year
$year = [DateTime]::Now.Year
if (($month -gt $now.Month) -or ($now.Month -eq $month -and $day -gt $now.Day))
{
$year--;
}
[DateTime]$time = [DateTime]::Parse($parts[[SysLogIds]::Time], [System.Globalization.CultureInfo]::InvariantCulture)
$time = [DateTime]::new($year, $month, $day, $time.Hour, $time.Minute, $time.Second)
if ($after -ne $null -and $time -lt $after)
{
# if the entry was logged prior to the expected time, return null
return $null
}
$item = [PSLogItem]::new()
$item.Timestamp = $time
$item.Message = $parts[[SysLogIds]::Message]
[char[]] $splitChars = $null
# handle log entries that have 'message repeated NNN times: ['
if ($parts[[SysLogIds]::CommitId] -eq 'message' -and $parts[[SysLogIds]::EventId] -eq 'repeated')
{
# NNN times: [ message ]
$splitChars = (' ', ':', '[')
$subparts = $item.Message.Split($splitChars, 3, [System.StringSplitOptions]::RemoveEmptyEntries)
$item.Count = [int]::Parse($subparts[0])
$value = $subparts[2]
# (commitid:TID:CHANNEL)
$start = $value.IndexOf('(')
$end = $value.IndexOf(')')
$parts[[SysLogIds]::CommitId] = $value.Substring($start, $end-$start+1)
$value = $value.Substring($end + 1)
# [eventid]
$start = $value.IndexOf('[')
$end = $value.IndexOf(']')
$parts[[SysLogIds]::EventId] = $value.Substring($start, $end-$start+1)
# message text
# NOTE: Skip the trailing ']'
$end++
$item.Message = $value.Substring($end, $value.Length - ($end + 1))
}
$item.Hostname = $parts[[SysLogIds]::Hostname]
# [EventId]
$splitChars = ('[', ']', ' ')
$item.EventId = $parts[[SysLogIds]::EventId]
$subparts = $item.EventId.Split($splitChars, [System.StringSplitOptions]::RemoveEmptyEntries)
if ($subparts.Count -eq 1)
{
$item.EventId = $subparts[0]
}
else
{
$item.ParseErrors.Add("Could not split EventId $($item.EventId) on '[] ' Count:$($subparts.Count) -> $content")
}
# (commitid:TID:ChannelID)
[char[]] $splitChars = ('(', ')', ':', ' ')
$item.CommitId = $parts[[SysLogIds]::CommitId]
$subparts = $item.CommitId.Split($splitChars, [System.StringSplitOptions]::RemoveEmptyEntries)
if ($subparts.Count -eq 3)
{
$item.CommitId = $subparts[0]
$item.ThreadId = [int]::Parse($subparts[1], [System.Globalization.NumberStyles]::AllowHexSpecifier)
$item.Channel = [int]::Parse($subparts[2])
}
else
{
$item.ParseErrors.Add("Could not split CommitId $($item.CommitId) on '(): ' Count:$($subparts.Count) -> $content")
}
# nameid[PID]
$splitChars = ('[',']',':')
$item.LogId = $parts[[SysLogIds]::Id]
$subparts = $item.LogId.Split($splitChars, [System.StringSplitOptions]::RemoveEmptyEntries)
if ($subparts.Count -eq 2)
{
$item.LogId = $subparts[0]
$item.ProcessId = [int]::Parse($subparts[1], [System.Globalization.NumberStyles]::AllowHexSpecifier)
}
else
{
$item.ParseErrors.Add("Could not split LogId $($item.LogId) on '[]:' Count:$($subparts.Count) -> $content")
}
return $item
}
static [object] ConvertOsLog([string] $content, [string] $id, [Nullable[DateTime]] $after)
{
Set-StrictMode -Version 3.0
<#
Expecting split to return
0: date 2018-02-07
1: time 14:34:35.256501-0800
2: thread 0x2a3730
3: Type Default
4: activity 0x12
5: PID 39437
6: TTL (introduced in ~ 10.13) 0
7: processname pwsh:
8: sourcedll (libpsl-native.dylib)
9: log source [com.microsoft.powershell.powershell]
10: commitid:treadid:channel (v6.0.1:1:10)
11:[EventId] [Perftrack_ConsoleStartupStart:PowershellConsoleStartup.WinStart.Informational]
12:Message Text
#>
[object] $result = $content
[char[]] $splitChars = $null
do
{
# determine if the line is a log entry
# versus an overflow of a multi-line entry
# check for thread
$index = $content.IndexOf(" 0x")
if ($index -le 0)
{
# no thread value,
# assume text only
break
}
# look for a date/time stamp prior to the thread.
# if this succeeds, we'll ignore the values in split.
[DateTime] $time = [DateTime]::Now
$value = $content.Substring(0, $index).Trim()
if ([DateTime]::TryParse($value, [ref] $time) -eq $false)
{
# no timestamp,
# assume text only
break
}
if ($after -ne $null -and $time -lt $after)
{
$result = $null
break
}
$parts = $content.Split(' ', [StringSplitOptions]::RemoveEmptyEntries)
$item = [PSLogItem]::new()
$item.Count = 1
$item.Timestamp = $time
$osLogIds = [OsLogIds]::new();
$item.ProcessId = [int]::Parse($parts[$osLogIds.Pid])
# Around macOS 13, Apple added a field
# Detect if the field is the old or new field and if it is old
# Switch to the old schema
if($parts[$osLogIds.TTL] -match '\:')
{
$osLogIds.UseOldIds()
}
if($parts.Length -gt ($osLogIds.Message +1))
{
# The message got split into multiple parts, put it back together
$item.Message = $parts[$osLogIds.Message..($parts.Length-1)] -join ' '
}
else
{
$item.Message = $parts[$osLogIds.Message] -join ' '
}
# [com.microsoft.powershell.logid]
$splitChars = ('[', '.', ']')
$item.LogId = $parts[$osLogIds.Id]
if($item.LogId -notmatch '^\[com\.microsoft\.powershell')
{
# this is really a lot of output, so we'll skip it for now.
# Write-Verbose "Skipping logId: $($item.LogId)" -Verbose
$result = $null
break
}
$subparts = $item.LogId.Split($splitChars, [StringSplitOptions]::RemoveEmptyEntries)
if ($subparts.Length -eq 4)
{
$item.LogId = $subparts[3]
if ($null -ne $id -and $id -ne $item.LogId)
{
# this is not the log id we're looking for.
$result = $null
break
}
}
# (commitid:TID:ChannelID)
$splitChars = ('(', ')', ':', ' ')
$item.CommitId = $parts[$osLogIds.CommitId]
$subparts = $item.CommitId.Split($splitChars, [System.StringSplitOptions]::RemoveEmptyEntries)
if ($subparts.Count -eq 3)
{
$item.CommitId = $subparts[0]
$item.ThreadId = [int]::Parse($subparts[1], [System.Globalization.NumberStyles]::AllowHexSpecifier)
$item.Channel = [int]::Parse($subparts[2])
}
else
{
$item.ParseErrors.Add("Could not split CommitId $($item.CommitId) on '(): ' Count:$($subparts.Count)")
}
# [EventId]
$splitChars = ('[', ']', ' ')
$item.EventId = $parts[$osLogIds.EventId]
$subparts = $item.EventId.Split($splitChars, [System.StringSplitOptions]::RemoveEmptyEntries)
if ($subparts.Count -eq 1)
{
$item.EventId = $subparts[0]
}
else
{
$item.ParseErrors.Add("Could not split EventId $($item.EventId) on '[] ' Count:$($subparts.Count)")
}
$result = $item
} while ($false)
# returning [string] or [PSLogItem]
return $result
}
}
function ConvertFrom-SysLog
{
[CmdletBinding()]
param
(
[Parameter(Mandatory, ValueFromPipeline)]
[string[]] $Content,
[string] $Id,
[Nullable[DateTime]] $After
)
Begin
{
[int] $totalWritten = 0
}
Process
{
foreach ($line in $Content)
{
try
{
[PSLogItem] $item = [PSLogItem]::ConvertSysLog($line, $id, $after)
if ($item -ne $null)
{
$totalWritten++
Write-Output $item
}
}
catch
{
Write-Warning -Message "Could not convert '$line' to PSLogItem"
}
}
}
End
{
Write-Verbose "Found $totalWritten items"
}
}
<#
.SYNOPSIS
Reads log entries with the specified identifier
.PARAMETER Path
The fully qualified path to the syslog formatted file.
.PARAMETER Id
The identifier for the entries to read.
The default value is 'powershell'
.PARAMETER TotalCount
Specifies the number of items to return.
Can be used with After and Tail
.PARAMETER Tail
Specifies the number of lines from the end of a file
This value is passed through to the underlying Get-Content Cmdlet and controls
the number of lines to read from the syslog file. As a result, the number of
returned PowerShell log items may be less than this value.
.PARAMETER After
Returns items on or after the specified DateTime
Can be used with TotalCount.
.EXAMPLE
PS> Get-PSSysLog -id 'powershell' -logPath '/var/log/powershell'
Gets all log entries from the log with the id 'powershell' from the log /var/log/powershell
.EXAMPLE
PS> Get-PSSysLog -id 'powershell' -logPath '/var/log/syslog'
Gets all log entries from the log with the id 'powershell' from the log /var/log/syslog
.Example
PS> Get-PSSysLog -id 'powershell' -logPath '/var/log/syslog' -Tail 200
Gets the last 200 log entries from /var/log/syslog and returns items from
this set that have the id 'powershell'.
.Example
PS> Get-PSSysLog -id 'powershell' -logPath '/var/log/syslog' -TotalCount 200
Gets up to 200 log entries with the id 'powershell' from /var/log/syslog
.Example
PS> $time = [DateTime]::Parse('1/19/2018 1:26:49 PM')
PS> Get-PSSysLog -id 'powershell' -logPath '/var/log/syslog' -After $time
Gets log entries with the id 'powershell' that occurred on or after a specific date/time
.NOTES
This function reads syslog entries using Get-Content, filters based on the id, and
returns an object for each log entry.
#>
function Get-PSSysLog
{
[CmdletBinding(DefaultParameterSetName='All')]
param
(
[Parameter(ParameterSetName = 'All')]
[Parameter(ParameterSetName = 'After')]
[Parameter(ParameterSetName = 'Tail')]
[ValidateNotNullOrEmpty()]
[string] $Path,
[Parameter(ParameterSetName = 'All')]
[Parameter(ParameterSetName = 'After')]
[Parameter(ParameterSetName = 'Tail')]
[ValidateNotNullOrEmpty()]
[string] $Id = 'powershell',
[Parameter(ParameterSetName='All')]
[Parameter(ParameterSetName = 'After')]
[Parameter(ParameterSetName = 'Tail')]
[ValidateRange(0, [int]::MaxValue)]
[int] $TotalCount,
[Parameter(ParameterSetName = 'All')]
[Parameter(ParameterSetName = 'Tail')]
[ValidateRange(0, [int]::MaxValue)]
[int] $Tail,
[Parameter(ParameterSetName = 'All')]
[Parameter(ParameterSetName = 'After')]
[Nullable[DateTime]] $After
)
[int] $maxItems = 0
$contentParms = @{Path = $Path}
if ($PSBoundParameters.ContainsKey('Tail'))
{
$contentParms['Tail'] = $Tail
}
if ($PSBoundParameters.ContainsKey('TotalCount'))
{
$maxItems = $TotalCount
}
if ($TotalCount -eq 0)
{
Get-Content @contentParms | ConvertFrom-SysLog -After $After -Id $Id
}
else
{
[string] $filter = [string]::Format(" {0}[", $id)
Get-Content @contentParms -Filter {$_.Contains($filter)} | ConvertFrom-SysLog -Id $Id -After $After | Select-Object -First $maxItems
}
}
#endregion SysLog support
#region os_log support
<#
Provides a utility class for handling single and multi-line os_log entries
#>
class LogItemBuilder
{
hidden [System.Text.StringBuilder] $sb = [System.Text.StringBuilder]::new()
hidden [PSLogItem] $item = $null
PSLogItemBuilder()
{
}
[PSLogItem] Add([object] $value)
{
[PSLogItem] $result = $null
if ($value -eq $null)
{
}
elseif ($value -is [PSLogItem])
{
# return the pending item
$result = $this.Flush()
if ($result -ne $null -and $this.sb.Length -gt 0)
{
$result.Message = $this.sb.ToString()
}
$null = $this.sb.Clear()
# save the current one to handle multiline
# message text.
$this.item = $value
}
elseif ($this.item -eq $null)
{
# Exported logs contain header lines;
# skip these.
}
else
{
# we have an item pending...
# build a multi-line message property
if ($this.sb.Length -eq 0)
{
$null = $this.sb.Append($this.item.Message)
}
$null = $this.sb.AppendLine('')
$null = $this.sb.Append($value.ToString())
}
return $result
}
[PSLogItem] Flush()
{
[PSLogItem] $result = $null
if ($this.item -ne $null)
{
$result = $this.item
$this.item = $null
if ($this.sb.Length -gt 0)
{
# rewrite the message wtih the multiple log lines
$result.Message = $this.sb.ToString()
$this.sb.Clear()
}
}
return $result
}
}
function ConvertFrom-OSLog
{
[CmdletBinding()]
param
(
[Parameter(Mandatory, ValueFromPipeline)]
[string[]] $Content,
[string] $Id,
[Nullable[DateTime]] $After
)
Begin
{
[int] $totalWritten = 0
# NOTE: Log items can span multiple lines
[LogItemBuilder] $builder = [LogItemBuilder]::new()
}
Process
{
foreach ($line in $Content)
{
[object] $item = [PSLogItem]::ConvertOsLog($line, $id, $after)
# os_log entries can span multiple lines when new lines are
# included in the entry's message text.
# To ensure the entire log entry is processed,
# LogItemBuilder.Add will not return an item until it encounters the start
# of another log entry.
# To ensure the last item is processed, Flush needs to be called at the end of the
# pipeline. See the End block below.
$item = $builder.Add($item)
if ($item -ne $null)
{
$totalWritten++
Write-Output $item
}
}
}
End
{
$item = $builder.Flush()
if ($item -ne $null)
{
$totalWritten++
Write-Output $item
}
Write-Verbose "Found $totalWritten items"
}
}
<#
.SYNOPSIS
Reads log entries with the specified identifier
.Description
This cmdlet parses a text file exported from a MacOS os_log.
.PARAMETER Path
The fully qualified path to the os_log formatted file.
.PARAMETER Id
The identifier for the PowerShell log identity of the instance(s) producing the log content.
The default value is 'powershell'
.PARAMETER TotalCount
Specifies the maximum number of items to return.
.PARAMETER After
Returns items on or after the specified DateTime
.EXAMPLE
PS> Export-OSLog -After $timestamp | Set-Content -Path "$PSDrive/mytest.txt"
PS> Get-PSOsLog -logPath "$PSDrive/mytest.txt"
Gets all log entries from a given timestamp.
.EXAMPLE
PS> Export-OSLog -After $timestamp | Set-Content -Path "$PSDrive/mytest.txt"
PS> Get-PSOsLog -id 'mypwsh' -logPath "$PSDrive/mytest.txt" -TotalCount 200
Gets up to 200 log entries from a given timestamp with the log identity of 'mypwsh'
#>
function Get-PSOsLog
{
[CmdletBinding()]
param
(
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
[string] $Path,
[string] $Id = 'powershell',
[ValidateRange(0, [int]::MaxValue)]
[int] $TotalCount,
[Nullable[DateTime]] $After
)
[int] $maxItems = 0
$contentParms = @{Path = $Path}
if ($PSBoundParameters.ContainsKey('TotalCount'))
{
$maxItems = $TotalCount
}
if ($TotalCount -eq 0)
{
Get-Content @contentParms | Where-Object {![string]::IsNullOrEmpty($_)} | ConvertFrom-OsLog -After $After -Id $Id
}
else
{
[string] $filter = [string]::Format("com.microsoft.powershell.{0}: (", $id)
Write-Warning "this code path `Get-PSOsLog -TotalCount` should not be used if the message field is needed!"
Get-Content @contentParms -Filter {$_.Contains($filter)} | Where-Object {![string]::IsNullOrEmpty($_)} | ConvertFrom-OsLog -Id $Id -After $After | Select-Object -First $maxItems
}
}
<#
.SYNOPSIS
Export PowerShell os_log content as text.
.PARAMETER After
The datetime for the starting entries to export.
Log entries with a timestamp on or after this value will be returned.
.EXAMPLE
PS> $timestamp = [DateTime]::Now
PS> # perform some work...
PS> $content = (Export-PSOsLog -After $timestamp)
.EXAMPLE
PS> $timestamp = [DateTime]::Now
PS> # perform some work...
PS> Export-PSOsLog -After $timestamp | Set-Content -Path "$PSDrive/mytest.txt"
.NOTES
This command requires MacOS.
See Get-PSOsLog for parsing content from this cmdlet
#>
function Export-PSOsLog
{
[CmdletBinding(DefaultParameterSetName='default')]
param
(
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
[DateTime] $After,
[string] $LogId = "powershell",
[int] $LogPid,
[Parameter(Mandatory, ParameterSetName='WaitUntil')]
[int] $TimeoutInMilliseconds,
[Parameter(Mandatory, ParameterSetName='WaitUntil')]
[int] $IntervalInMilliseconds,
[Parameter(Mandatory, ParameterSetName='WaitUntil')]
[string] $MinimumCount
)
Test-MacOS
# NOTE: The use of double quotes and single quotes for the predicate parameter
# is mandatory. Reversing the usage (e.g., single quotes around double quotes)
# causes the double quotes to be stripped breaking the predicate syntax expected
# by log show
$extraParams = @()
if($LogPid)
{
$extraParams += @(
'--predicate'
"processID == $LogPid"
)
}
if ($After -ne $null)
{
[string] $startTime = $After.ToString("yyyy-MM-dd HH:mm:ss")
$extraParams += @(
'--start'
"$startTime"
)
}
else {
$extraParams += @(
'--predicate'
"process == 'pwsh'"
)
}
Wait-UntilSuccess {
# Leaving this in an turned on by default until the tests are stabilized.
Write-Verbose "Exporting macOS logs..." -Verbose
$log = @(Start-NativeExecution -command {log show --info @extraParams})
# Only count line with `[com.microsoft.powershell` as matching rows
$logToCount = $log | Select-String -SimpleMatch '[com.microsoft.powershell'
if($logToCount.Count -ge $MinimumCount){
Write-Output $log
}
else {
throw "did not receive at least $MinimumCount records but $($logToCount.Count) instead."
}
} -TimeoutInMilliseconds $TimeoutInMilliseconds -IntervalInMilliseconds $IntervalInMilliseconds -LogErrorSb {
$log = Start-NativeExecution -command {log show --info @extraParams}
Send-VstsLogFile -Contents $log -LogName 'Export-PSOsLog-Failure'
}
}
function Wait-UntilSuccess
{
[CmdletBinding()]
param (
[ScriptBlock]$sb,
[ScriptBlock]$LogErrorSb,
[int]$TimeoutInMilliseconds = 10000,
[int]$IntervalInMilliseconds = 10000
)
# Get the current time
$startTime = [DateTime]::Now
# Loop until the script block returns
while ($true) {
try{
return & $sb
}
catch{
# If the timeout period has passed, return false
$msPassed = ([DateTime]::Now - $startTime).TotalMilliseconds
if ($msPassed -gt $timeoutInMilliseconds) {
if($LogErrorSb)
{
try { & $LogErrorSb } catch {Write-Verbose "Logging of Error details failed with: $_" -Verbose}
}
throw
}
}
# Wait
Start-Sleep -Milliseconds $intervalInMilliseconds
}
return $true
}
<#
.SYNOPSIS
Enables or disables persistence of PowerShell logging
.PARAMETER Enable
Enable persistence of PowerShell log items
.PARAMETER Disable
Disables persistent of PowerShell log items.
This reverts persistence to the system default.
.EXAMPLE
Set-OsLogPersistence -Enable
Enables persistence of PowerShell log entries
.EXAMPLE
Set-OsLogPersistence -Disable
Reverts persistence to the default state.
.NOTES
See Get-OsLogPersistence to query the current setting.
#>
function Set-OsLogPersistence
{
[CmdletBinding()]
param
(
[Parameter(Mandatory, ParameterSetName='Enable')]
[switch] $Enable,
[Parameter(Mandatory, ParameterSetName='Disable')]