PSMultiLog.psm1
|
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 |
<#
.DESCRIPTION A module that provides a single entry point to output a log to multiple sources. .EXAMPLE C:\PS> Import-Module PSMultiLog C:\PS> Start-FileLog -FilePath c:\ps\info.log C:\PS> Write-Log -EntryType Information -Message "Test Log Entry" #> # Load strings file $CurrentPath = Split-Path -Path $MyInvocation.MyCommand.Definition -Parent Import-LocalizedData -BindingVariable r -FileName Strings.psd1 -BaseDirectory (Join-Path -Path $CurrentPath -ChildPath "Localized") $Script:r = $r # Array to hold log entries that will be e-mailed when using e-mail logging. $Script:LogEntries = @() # Settings for each of the log types. $Script:Settings = @{ File = New-Object -TypeName psobject -Property @{ Enabled = $false LogLevel = 0 FilePath = $null } Email = New-Object -TypeName psobject -Property @{ Enabled = $false } EventLog = New-Object -TypeName psobject -Property @{ Enabled = $false LogLevel = 0 LogName = $null Source = $null } Host = New-Object -TypeName psobject -Property @{ Enabled = $false LogLevel = 0 } PassThru = New-Object -TypeName psobject -Property @{ Enabled = $false LogLevel = 0 } } #------------------------------------------------------------------------------- # Public Cmdlets #------------------------------------------------------------------------------- #------------------------------------------------------------------------------- # File Logging Function Start-FileLog { <# .SYNOPSIS Begins to log output to file. .DESCRIPTION Begins to log output to file. Only entries with a severity at or above the specified level will be written. .PARAMETER FilePath Specifies the path and name of the log file that will be written. .PARAMETER LogLevel Specifies the minimum log entry severity to include in the file log. The default value is "Error". .PARAMETER Append Specifies that the file at <FilePath> should not be deleted if it already exists. New entries will be appended to the end of the file. .OUTPUTS None. .EXAMPLE C:\PS> Start-FileLog -FilePath c:\ps\data.log ----------- This command shows the minimum requirements for enabling file logging. It will replace any existing log file of the same name and will only log entries of type "Error". .EXAMPLE C:\PS> Start-FileLog -FilePath c:\ps\data.log -Append ----------- This command will leave an existing log file in place if it exists and append new log entries of type "Error" to the end of the file. .EXAMPLE C:\PS> Start-FileLog -FilePath c:\ps\data.log -LogLevel Warning -Append ----------- This command will leave an existing log file in place if it exists and append new log entries of type "Warning" or type "Error" to the end of the file. #> [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [string]$FilePath, [Parameter()] [ValidateSet("Information", "Warning", "Error")] [string]$LogLevel = "Error", [Parameter()] [switch]$Append ) Process { $Script:Settings["File"].Enabled = $false # First attempt to remove existing file if necessary if (!$Append -and (Test-Path -LiteralPath $FilePath)) { try { Remove-Item -LiteralPath $FilePath -Force -ErrorAction Stop } catch { Write-Error -Exception $_.Exception -Message $Script:r.FileLogUnableToRemoveExistingFile return } } # Create file if necessary if (!(Test-Path -LiteralPath $FilePath)) { try { New-Item -Path $FilePath -ItemType File -Force -ErrorAction Stop | Out-Null } catch { Write-Error -Exception $_.Exception -Message $Script:r.FileLogUnableToCreateFile return } } $Script:Settings["File"].Enabled = $true $Script:Settings["File"].LogLevel = Get-LogLevel -EntryType $LogLevel $Script:Settings["File"].FilePath = $FilePath } } Function Stop-FileLog { <# .SYNOPSIS Stops writing log output to file. .DESCRIPTION Stops writing log output to file. Any log data that has already been written will remain. .OUTPUTS None. .EXAMPLE C:\PS> Stop-FileLog ----------- This command turns off file logging. #> [CmdletBinding(SupportsShouldProcess = $true)] Param () Process { if ($PSCmdlet.ShouldProcess($Script:r.CurrentSession)) { $Script:Settings["File"].Enabled = $false $Script:Settings["File"].FilePath = $null } } } #------------------------------------------------------------------------------- # E-mail Logging Function Start-EmailLog { <# .SYNOPSIS Starts recording log events so that they can be e-mailed. .DESCRIPTION Starts recording log events so that they can be e-mailed. A separate Cmdlet (Send-EmailLog) must be issued to actually send an e-mail. .PARAMETER ClearEntryCache Specifies whether any existing recorded log entries from the cache of entries to be e-mailed should be removed. .OUTPUTS None. .EXAMPLE C:\PS> Start-EmailLog ----------- This command begins the recording of log events so that they can be e-mailed. If any entries were already in the cache, they will remain there. .EXAMPLE C:\PS> Start-EmailLog -ClearEntryCache ----------- This command begins the recording of log events so that they can be e-mailed and clears the cache of recorded entries. #> [CmdletBinding()] Param ( [Parameter()] [switch]$ClearEntryCache ) Process { $Script:Settings["Email"].Enabled = $true if ($ClearEntryCache) { $Script:LogEntries = @() } } } Function Stop-EmailLog { <# .SYNOPSIS Stops the recording of log events to the e-mail cache. .DESCRIPTION Stops the recording of log events to the e-mail cache. By default, the cache is also cleared. .PARAMETER RetainEntryCache Specifies whether any log entries that have already been recorded should be kept or discarded. .OUTPUTS None. .EXAMPLE C:\PS> Stop-EmailLog ----------- This command stops the recording of log entries and clears the e-mail cache. .EXAMPLE C:\PS> Stop-EmailLog -RetainEntryCache ----------- This command stops the recording of log entries but retains any that were already recorded. #> [CmdletBinding(SupportsShouldProcess = $true)] Param ( [Parameter()] [switch]$RetainEntryCache ) Process { if ($PSCmdlet.ShouldProcess($Script:r.CurrentSession)) { $Script:Settings["Email"].Enabled = $false if (!$RetainEntryCache) { $Script:LogEntries = @() } } } } Function Send-EmailLog { <# .SYNOPSIS Sends an e-mail containing one or more of the log messages collected since e-mail logging was enabled. .DESCRIPTION Sends an e-mail containing one or more of the log messages collected since e-mail logging was enabled in the current session. Parameters can be used to control the severity of log message required to trigger sending an e-mail and also what levels are sent when an e-mail is triggered. .PARAMETER SmtpServer Specifies the SMTP server to use to send e-mail. .PARAMETER To Specifies one or more recipients for the e-mail. .PARAMETER From Specifies a from address to use when sending the e-mail. Note that some SMTP servers require this to be a valid mailbox. .PARAMETER Subject Specifies the subject of the e-mail message. .PARAMETER Message Specifies additional text to include in the e-mail message before the log data. .PARAMETER TriggerLogLevel Specifies the condition for sending an e-mail. A log entry at or above the specified level must have been recorded for an e-mail to be sent. .PARAMETER SendLogLevel Specifies what log events to include when sending an e-mail. This can be different than the TriggerLogLevel. .PARAMETER RetainEntryCache Specifies whether or not to keep the log entries that have been recorded. The default behavior is to clear them. .PARAMETER SendOnEmpty Specifies whether or not to send an e-mail if there are no log events that match the SendLogLevel parameter. .OUTPUTS None. .EXAMPLE C:\PS> Send-EmailLog -SmtpServer smtp.contoso.com -To ellen@contoso.com -From info@contoso.com ----------- This command shows the minimum requirements for e-mailing a log. A default subject will be used and no extra message will be added. Because the TriggerLogLevel parameter was not provided, the module will try to send an e-mail no matter what, using the default SendLogLevel of Error. .EXAMPLE C:\PS> Send-EmailLog -SmtpServer smtp.contoso.com -To ellen@contoso.com -From info@contoso.com -TriggerLogLevel Error -SendLogLevel Information ----------- This command will cause the module only to send an e-mail if any errors were encountered, but when sending an e-mail it will send the full log. #> [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [string]$SmtpServer, [Parameter( Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )] [string[]]$To, [Parameter(Mandatory = $true)] [string]$From, [Parameter()] [string]$Subject = "", [Parameter()] [string]$Message = "", [Parameter()] [ValidateSet("Information", "Warning", "Error")] [string]$TriggerLogLevel = "Error", [Parameter()] [ValidateSet("Information", "Warning", "Error")] [string]$SendLogLevel = "Error", [Parameter()] [switch]$RetainEntryCache = $false, [Parameter()] [switch]$SendOnEmpty = $false, [Parameter()] [ValidateSet("Information", "Warning", "Error")] [string]$LogLevel = "Error" ) Begin { if ($LogLevel) { # Deprecated functionality. Write-Warning -Message ([string]::Format($Script:r.Parameter_F0_Deprecated_F1, "LogLevel", "TriggerLogLevel and SendLogLevel")) $TriggerLogLevel = $LogLevel $SendLogLevel = $LogLevel } # Start by checking if anything was logged that fits our trigger level. $TriggerLogLevelNumber = Get-LogLevel -EntryType $TriggerLogLevel if ((!$PSBoundParameters.ContainsKey("TriggerLogLevel") -and !$PSBoundParameters.ContainsKey("LogLevel")) -or $Script:LogEntries | Where-Object -FilterScript { $_.LogLevel -le $TriggerLogLevelNumber }) { if (!$Subject) { $Subject = $Script:r.EmailLogSubject } $EmailBody = "<style>.log-entries {font-family: `"Lucida Console`", Monaco, monospace;font-size: 10pt;}</style><body>" if ($Message) { $EmailBody += "<p>$Message</p>" } $SendLogLevelNumber = Get-LogLevel -EntryType $SendLogLevel $Entries = $Script:LogEntries | Where-Object -FilterScript { $_.LogLevel -le $SendLogLevelNumber } $Empty = $false if ($Entries) { $EmailBody += "<div class=`"log-entries`">" $EmailBody += $Entries | ConvertTo-HtmlUnorderedList -FormatScript { $Line = "[$($_.Timestamp.ToString("u"))] - " switch ($_.EntryType) { "Information" { $Line += "<span style=`"color: Teal`">$($Script:r.Info)</span>" } "Warning" { $Line += "<span style=`"color: GoldenRod`">$($Script:r.Warn)</span>" } "Error" { $Line += "<span style=`"color: Red`">$($Script:r.Errr)</span>" } } $Line += ": $($_.Message)" if ($_.Exception) { $Line += "<ul><li>$($Script:r.Message): $($_.Exception.Message)</li><li>$($Script:r.Source): $($_.Exception.Source)</li><li>$($Script:r.StackTrace):" if ($_.Exception.StackTrace -and $_.Exception.StackTrace.Count -gt 0) { $Line += "<ul>" foreach ($Stack in $_.Exception.StackTrace) { $Line += "<li>$Stack</li>" } $Line += "</ul>" } $Line += "</li><li>$($Script:r.TargetSite): $($_.Exception.TargetSite)</li></ul>" } $Line } $EmailBody += "</div>" } else { $Empty = $true $EmailBody += "<p>$($Script:r.NoEntriesToReport)</p>" } $EmailBody += "</body>" } else { # No events occurred that would trigger us to send an e-mail. break } } Process { if (!$Empty -or $SendOnEmpty) { Send-MailMessage -From $From -To $To -Subject $Subject -Body $EmailBody -SmtpServer $SmtpServer -BodyAsHtml } } End { if (!$RetainEntryCache) { $Script:LogEntries = @() } } } #------------------------------------------------------------------------------- # Event Log Logging Function Start-EventLogLog { <# .SYNOPSIS Starts recording log events to the Windows Event Log. .DESCRIPTION Starts recording log events to the Windows Event Log. Which log is written to and what source is used are configurable. .PARAMETER Source Specifies the Event Log source to record events under. If the source does not exist, the module will attempt to create it, but this requires administrative rights. You might need to run the script as an administrator the first time to create the source, but once it exists you should not need to. .PARAMETER LogLevel Specifies the minimum log entry severity to write to the Event Log. The default value is "Error". .PARAMETER LogName Specifies the Windows Event Log to write events to. The default is "Application" .OUTPUTS None. .EXAMPLE C:\PS> Start-EventLogLog -Source "MyScript" ----------- This command shows the minimum required parameter set to enable Event Log logging. If the "MyScript" source does not exist in the Event Log, it will be created. Because the default LogLevel of "Error" is being used, only errors will be written to the Event Log. #> [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [string]$Source, [Parameter()] [ValidateSet("Information", "Warning", "Error")] [string]$LogLevel = "Error", [Parameter()] [string]$LogName = "Application" ) Process { $Script:Settings["EventLog"].Enabled = $false # Check if the source exists. try { if ([System.Diagnostics.EventLog]::SourceExists($Source)) { # It does exist, make sure it points at the right log. if ([System.Diagnostics.EventLog]::LogNameFromSourceName($Source, ".") -ne $LogName) { # Source exists but points to a different log. Not good! Write-Error -Message $Script:r.EventLogLogSourceInWrongLog return } } else { # Source does not exist, try to create it. try { New-EventLog -LogName $LogName -Source $Source } catch [System.Exception] { Write-Error -Exception $_.Exception -Message $Script:r.EventLogLogUnableToCreateLogOrSource return } } } catch [System.Exception] { Write-Error -Exception $_.Exception -Message $Script:r.EventLogLogUnableToReadLogSources return } $Script:Settings["EventLog"].Enabled = $true $Script:Settings["EventLog"].LogLevel = Get-LogLevel -EntryType $LogLevel $Script:Settings["EventLog"].LogName = $LogName $Script:Settings["EventLog"].Source = $Source } } Function Stop-EventLogLog { <# .SYNOPSIS Stops writing log output to the Windows Event Log. .DESCRIPTION Stops writing log output to the Windows Event Log. .OUTPUTS None. .EXAMPLE C:\PS> Stop-EventLogLog ----------- This command turns off Event Log logging. #> [CmdletBinding(SupportsShouldProcess = $true)] Param () Process { if ($PSCmdlet.ShouldProcess($Script:r.CurrentSession)) { $Script:Settings["EventLog"].Enabled = $false $Script:Settings["EventLog"].LogName = $null $Script:Settings["EventLog"].Source = $null } } } #------------------------------------------------------------------------------- # Host Logging Function Start-HostLog { <# .SYNOPSIS Turns on writing formatted log events to the host display. .DESCRIPTION Starts writing formatted log events to the host display. Includes timestamp, color-coded entry type, and message text. .PARAMETER LogLevel Specifies the minimum log entry severity to write to the host. The default value is "Error". .OUTPUTS None. .EXAMPLE C:\PS> Start-HostLog ----------- This command turns on host logging. #> [CmdletBinding()] Param ( [Parameter()] [ValidateSet("Information", "Warning", "Error")] [string]$LogLevel = "Error" ) Process { $Script:Settings["Host"].Enabled = $true $Script:Settings["Host"].LogLevel = Get-LogLevel -EntryType $LogLevel } } Function Stop-HostLog { <# .SYNOPSIS Turns off writing log messages to the host display. .DESCRIPTION Turns off writing log messages to the host display. .OUTPUTS None. .EXAMPLE C:\PS> Stop-HostLog ----------- This command turns off host logging. #> [CmdletBinding(SupportsShouldProcess = $true)] Param () Process { if ($PSCmdlet.ShouldProcess($Script:r.CurrentSession)) { $Script:Settings["Host"].Enabled = $false } } } #------------------------------------------------------------------------------- # "Pass Thru" Logging Function Start-PassThruLog { <# .SYNOPSIS Turns on "Pass Thru" display of log events by writing them to other streams. .DESCRIPTION Turns on "Pass Thru" display of log events by writing them to other streams. The streams used are: - Information - Verbose Stream - Warning - Warning Stream - Error - Error stream .PARAMETER LogLevel Specifies the minimum log entry severity to write to another stream. The default value is "Error". .OUTPUTS None. .EXAMPLE C:\PS> Start-PassThruLog ----------- This command turns on "Pass Thru" logging. #> [CmdletBinding()] Param ( [Parameter()] [ValidateSet("Information", "Warning", "Error")] [string]$LogLevel = "Error" ) Process { $Script:Settings["PassThru"].Enabled = $true $Script:Settings["PassThru"].LogLevel = Get-LogLevel -EntryType $LogLevel } } Function Stop-PassThruLog { <# .SYNOPSIS Turns off "Pass Thru" logging. .DESCRIPTION Turns off "Pass Thru" logging. .OUTPUTS None. .EXAMPLE C:\PS> Stop-PassThruLog ----------- This command turns off "Pass Thru" logging. #> [CmdletBinding(SupportsShouldProcess = $true)] Param () Process { if ($PSCmdlet.ShouldProcess($Script:r.CurrentSession)) { $Script:Settings["PassThru"].Enabled = $false } } } #------------------------------------------------------------------------------- # Main logging method Function Write-Log { <# .SYNOPSIS Writes a log entry to whichever output formats are currently enabled. .DESCRIPTION Writes a log entry to whichever output formats are currently enabled. .PARAMETER EntryType Specifies what type of log entry to write. .PARAMETER Message Specifies a descriptive message for the log entry. This is separate from the message that is attached to any exception that might be included in the log event. .PARAMETER Exception For error type entries, includes information about an actual exception that occurred. .PARAMETER EventId For Event Log entries, specifies the Event Id to write in the Event Log. The default is 1000. .OUTPUTS None. .EXAMPLE C:\PS> Write-Log -EntryType Information -Message "This is a sample log message." ----------- This command writes a simple log message. .EXAMPLE C:\PS> Write-Log -EntryType Error -Message "An exception occurred." -Exception $_.Exception ----------- This command, which might be used in a try/catch block, logs an error, including data about the exception that was caught. #> [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [ValidateSet("Information", "Warning", "Error")] [string]$EntryType, [Parameter(Mandatory = $true)] [string]$Message, [Parameter()] [System.Exception]$Exception = $null, [Parameter()] [int]$EventId = 1000 ) Process { $NewEntry = New-Object -TypeName psobject -Property @{ Timestamp = Get-Date EntryType = $EntryType LogLevel = Get-LogLevel -EntryType $EntryType Message = $Message Exception = $Exception EventId = $EventId } # Log to File if ($Script:Settings["File"].Enabled -and $NewEntry.LogLevel -le $Script:Settings["File"].LogLevel) { Write-FileLog -Entry $NewEntry -FilePath $Script:Settings["File"].FilePath } # Log to EventLog if ($Script:Settings["EventLog"].Enabled -and $NewEntry.LogLevel -le $Script:Settings["EventLog"].LogLevel) { Write-EventLogLog -Entry $NewEntry -LogName $Script:Settings["EventLog"].LogName -Source $Script:Settings["EventLog"].Source } # Record entry for e-mailing later if ($Script:Settings["Email"].Enabled) { Write-EmailLog -Entry $NewEntry } # Write to host if ($Script:Settings["Host"].Enabled -and $NewEntry.LogLevel -le $Script:Settings["Host"].LogLevel) { Write-HostLog -Entry $NewEntry } # Pass through to verbose/warning/error streams if ($Script:Settings["PassThru"].Enabled -and $NewEntry.LogLevel -le $Script:Settings["PassThru"].LogLevel) { Write-PassThruLog -Entry $NewEntry } } } #------------------------------------------------------------------------------- # Internal Cmdlets #------------------------------------------------------------------------------- Function Get-LogLevel { <# .SYNOPSIS Gets the integer representation of the specified entry type. .DESCRIPTION Gets the integer representation of the specified entry type. Used for filtering log output. .PARAMETER EntryType Specifies the entry type to evaluate. .OUTPUTS Integer. #> [CmdletBinding()] [OutputType([int])] Param ( [Parameter(Mandatory = $true)] [ValidateSet("Information", "Warning", "Error")] [string]$EntryType ) Process { switch ($EntryType) { "Information" { return 2 } "Warning" { return 1 } "Error" { return 0 } } } } Function Format-LogMessage { <# .SYNOPSIS Returns a Formats a log entry for output and returns the formatted string. .DESCRIPTION Returns a Formats a log entry for output and returns the formatted string. Used by the File and PassThru logging methods. .PARAMETER Entry Specifies the log entry to format. .PARAMETER Type Specifies whether or not to include the log entry type in the formatted string. .PARAMETER Exception Specifies an exception object to include information about in the formatted string. .OUTPUTS String. #> [CmdletBinding()] [OutputType([string])] Param ( [Parameter(Mandatory = $true)] [psobject]$Entry, [Parameter()] [switch]$Type, [Parameter()] [switch]$Exception ) Process { $ReturnString = "[$($Entry.Timestamp.ToString("u"))]" if ($Type) { $TypeString = "" switch($Entry.EntryType) { "Information" { $TypeString = $Script:r.Info } "Warning" { $TypeString = $Script:r.Warn } "Error" { $TypeString = $Script:r.Errr } } $ReturnString += " - $TypeString" } $ReturnString += " - $($Entry.Message)" if ($Exception -and $Entry.Exception) { $ReturnString += " - $($Script:r.Exception): $($Entry.Exception.Message)" } return $ReturnString } } Function Write-FileLog { <# .SYNOPSIS Writes a log message to a file. .DESCRIPTION Writes a log message to a file. .PARAMETER Entry Specifies the log entry to write. .PARAMETER FilePath Specifies the file to write the log entry to. .OUTPUTS None. #> [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [psobject]$Entry, [Parameter(Mandatory = $true)] [string]$FilePath ) Process { Format-LogMessage -Entry $Entry -Type -Exception | Out-File -FilePath $FilePath -Append -Encoding ascii } } Function Write-EventLogLog { <# .SYNOPSIS Creates a new Event Log object from a log message. .DESCRIPTION Creates a new Event Log object from a log message. .PARAMETER Entry Specifies the log entry which will be used to create the Event Log object. .PARAMETER LogName Specifies which log in the Windows Event Log to write to. .PARAMETER Source Specifies the source to use when creating the Event Log object. .OUTPUTS None. #> [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [psobject]$Entry, [Parameter(Mandatory = $true)] [string]$LogName, [Parameter(Mandatory = $true)] [string]$Source ) Process { $EventLogMessage = $Entry.Message if ($Entry.Exception) { $EventLogMessage += "`n`n$($Script:r.ExceptionInformation)" + ` "`n$($Script:r.Message): $($Entry.Exception.Message)" + ` "`n$($Script:r.Source): $($Entry.Exception.Source)" + ` "`n$($Script:r.StackTrace): $($Entry.Exception.StackTrace)" + ` "`n$($Script:r.TargetSite): $($Entry.Exception.TargetSite)" } Write-EventLog -LogName $LogName -Source $Source -EntryType $Entry.EntryType -EventId $Entry.EventId -Message $EventLogMessage } } Function Write-EmailLog { <# .SYNOPSIS Stores a log entry in the cache used when e-mailing log data. .DESCRIPTION Stores a log entry in the cache used when e-mailing log data. .PARAMETER Entry Specifies the log entry to record. .OUTPUTS None. #> [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [psobject]$Entry ) Process { $Script:LogEntries += $Entry } } Function Write-HostLog { <# .SYNOPSIS Writes a log entry to the host. .DESCRIPTION Writes a log entry to the host. .PARAMETER Entry Specifies the log entry to write to the host. .OUTPUTS None. #> [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [psobject]$Entry ) Process { Write-Host -Object "[$($Entry.Timestamp.ToString("u"))] - " -NoNewline switch ($Entry.EntryType) { "Information" { Write-Host -Object $Script:r.Info -ForegroundColor Cyan -NoNewline } "Warning" { Write-Host -Object $Script:r.Warn -ForegroundColor Yellow -NoNewline } "Error" { Write-Host -Object $Script:r.Errr -ForegroundColor Red -NoNewline } } $Message = $Entry.Message if ($Entry.Exception) { $Message += " - $($Script:r.Exception): $($Entry.Exception.Message)" } Write-Host -Object " - $Message" } } Function Write-PassThruLog { <# .SYNOPSIS Writes a log entry to one of the native PowerShell Streams. .DESCRIPTION Writes a log entry to one of the native PowerShell Streams. .PARAMETER Entry Specifies the log entry to write. #> [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [psobject]$Entry ) Process { switch ($Entry.EntryType) { "Information" { Write-Verbose -Message (Format-LogMessage -Entry $Entry) } "Warning" { Write-Warning -Message (Format-LogMessage -Entry $Entry) } "Error" { if ($Entry.Exception) { Write-Error -Message (Format-LogMessage -Entry $Entry) -Exception $Entry.Exception } else { Write-Error -Message (Format-LogMessage -Entry $Entry) } } } } } Function ConvertTo-HtmlUnorderedList { <# .SYNOPSIS Builds an HTML UnorderedList from the supplied input and returns its string. .DESCRIPTION Builds an HTML UnorderedList from the supplied input and returns its string. .PARAMETER FormatScript Specifies a script block to invoke for each object passed into the Cmdlet. .PARAMETER InputObject Specifies one or more objects to write to the unordered list. .OUTPUTS String. #> [CmdletBinding()] [OutputType([string])] Param ( [Parameter()] [scriptblock]$FormatScript = $null, [Parameter( Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )] $InputObject ) Begin { $OutputText = "<ul>`n" } Process { @($InputObject) | ForEach-Object -Process { $OutputText += "<li>" if ($FormatScript) { $OutputText += Invoke-Command -ScriptBlock $FormatScript } else { $OutputText += $_ } $OutputText += "</li>`n" } } End { $OutputText += "</ul>`n" $OutputText } } #------------------------------------------------------------------------------- # Deprecated Cmdlets #------------------------------------------------------------------------------- Function Enable-FileLog { [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [string]$FilePath, [Parameter()] [ValidateSet("Information", "Warning", "Error")] [string]$LogLevel = "Error", [Parameter()] [switch]$Append ) Process { Write-Warning -Message ([string]::Format($Script:r.CmdletDeprecated_F0, "Start-FileLog")) Start-FileLog -FilePath $FilePath -LogLevel $LogLevel -Append:$Append } } Function Disable-FileLog { [CmdletBinding()] Param () Process { Write-Warning -Message ([string]::Format($Script:r.CmdletDeprecated_F0, "Stop-FileLog")) Stop-FileLog } } Function Enable-EmailLog { [CmdletBinding()] Param ( [Parameter()] [switch]$ClearEntryCache ) Process { Write-Warning -Message ([string]::Format($Script:r.CmdletDeprecated_F0, "Start-EmailLog")) Start-EmailLog -ClearEntryCache:$ClearEntryCache } } Function Disable-EmailLog { [CmdletBinding()] Param ( [Parameter()] [switch]$RetainEntryCache ) Process { Write-Warning -Message ([string]::Format($Script:r.CmdletDeprecated_F0, "Stop-EmailLog")) Stop-EmailLog } } Function Enable-EventLogLog { [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [string]$Source, [Parameter()] [ValidateSet("Information", "Warning", "Error")] [string]$LogLevel = "Error", [Parameter()] [string]$LogName = "Application" ) Process { Write-Warning -Message ([string]::Format($Script:r.CmdletDeprecated_F0, "Start-EventLogLog")) Start-EventLogLog -Source $Source -LogLevel $LogLevel -LogName $LogName } } Function Disable-EventLogLog { [CmdletBinding()] Param () Process { Write-Warning -Message ([string]::Format($Script:r.CmdletDeprecated_F0, "Stop-EventLogLog")) Stop-EventLogLog } } Function Enable-HostLog { [CmdletBinding()] Param ( [Parameter()] [ValidateSet("Information", "Warning", "Error")] [string]$LogLevel = "Error" ) Process { Write-Warning -Message ([string]::Format($Script:r.CmdletDeprecated_F0, "Start-HostLog")) Enable-HostlLog -LogLevel $LogLevel } } Function Disable-HostLog { [CmdletBinding()] Param () Process { Write-Warning -Message ([string]::Format($Script:r.CmdletDeprecated_F0, "Stop-HostLog")) Stop-HostLog } } Function Enable-PassThruLog { [CmdletBinding()] Param ( [Parameter()] [ValidateSet("Information", "Warning", "Error")] [string]$LogLevel = "Error" ) Process { Write-Warning -Message ([string]::Format($Script:r.CmdletDeprecated_F0, "Start-PassThruLog")) Start-PassThruLog -LogLevel $LogLevel } } Function Disable-PassThruLog { [CmdletBinding()] Param () Process { Write-Warning -Message ([string]::Format($Script:r.CmdletDeprecated_F0, "Stop-PassThruLog")) Stop-PassThruLog } } Export-ModuleMember -Function Enable-*, Disable-*, Start-*, Stop-*, Write-Log, Send-EmailLog |