NoUselessTech.PowerShellHelpers

0.0.7

Public/New-Log.ps1

Function New-Log {
    <#
        .SYNOPSIS
        This takes in some parameters to make it easier to consistently log.

        .PARAMETER Level
        This indicates the level based on predefined types.
        Info, Warn, Err, Debug

        .PARAMETER LogFile
        This should be a file path to a file.

        .PARAMETER Message
        This is a string that will be printed to the log and screen.

        .EXAMPLE
        PS> New-Log -LogFile 'test.log' -Level ([LogLevel]::Info) -Message "Test"
        20240525 04:46:34.4667: Test
    #>

    param(
        [Parameter(Mandatory=$False)]
        [string]$LogFile,

        [Parameter(Mandatory=$False)]
        [ValidateSet("Info", "Warn", "Err", "Debug")]
        [string]$Level,

        [Parameter(Mandatory=$True)]
        [string]$Message
    )

    Try {
        # Format the Log
        $Time = Get-Date -AsUTC -Format 'yyyyMMdd hh:mm:ss.ffff'
        $OutMessage = "$Time`: $Message"

        # Write to the log file
        if ($LogFile) {
            $OutMessage | Out-File $LogFile
        }

        # Write to the screen
        Switch ($Level) {
            (Info)  { Write-Output $OutMessage  }
            (Warn)  { Write-Warning $OutMessage }
            (Err)   { Write-Error $OutMessage   }
            (Debug) { Write-Debug $OutMessage   }
            default             { Write-Output $OutMessage  }
        }
    } Catch {
        # We were unable to write out...
        Throw "Unable to complete log update.`r`n$_" 
    }
}

# SIG # Begin signature block
# MIIDOQYJKoZIhvcNAQcCoIIDKjCCAyYCAQExDzANBglghkgBZQMEAgMFADCBmwYK
# KwYBBAGCNwIBBKCBjDCBiTA0BgorBgEEAYI3AgEeMCYCAwEAAAQQH8w7YFlLCE63
# JNLGKX7zUQIBAAIBAAIBAAIBAAIBADBRMA0GCWCGSAFlAwQCAwUABECMUCgWdOuL
# NSKEl166lvZ8voFXa5A1WZHkA84SNmfT4RDheZGW8KZe4c7Bql5/KmUMoJYhqS1N
# nfQr3drCO4PYoIIBRTCCAUEwgeigAwIBAgIUJUrhIyYe0Ijmq8lkl4K8jyNrTDUw
# CgYIKoZIzj0EAwIwIDEeMBwGA1UEAwwVY29ubm9yQG5vdXNlbGVzcy50ZWNoMCAX
# DTI0MDUwNTA0MDUyOVoYDzIyMjIxMjIyMDAwMDAwWjAgMR4wHAYDVQQDDBVjb25u
# b3JAbm91c2VsZXNzLnRlY2gwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAARFc0rS
# N95xEemn7/TlV7WGrIJs0xXd0L7IdY0nu5hVqaR9FJ7DD/lV/8tgAPgOw8756FTv
# r3889XN3rSir8uLlMAoGCCqGSM49BAMCA0gAMEUCIQD9FOnUCgckJaGI3Hgqkqzn
# n7cRN8O9FESkoAKapUA/8gIgD6P7+V2DIwzPSBPPY7W07BZ3X2r29L7KHZ8ZUcrS
# m2wxggEnMIIBIwIBATA4MCAxHjAcBgNVBAMMFWNvbm5vckBub3VzZWxlc3MudGVj
# aAIUJUrhIyYe0Ijmq8lkl4K8jyNrTDUwDQYJYIZIAWUDBAIDBQCgfjAQBgorBgEE
# AYI3AgEMMQIwADAZBgkqhkiG9w0BCQMxDAYKKwYBBAGCNwIBBDBPBgkqhkiG9w0B
# CQQxQgRA59ZTYvCmFKXnXy73cNOC5xKcxn2GsvxJaqOfrv2uXMTCuUZQl7r6o508
# VE1wGO2op2DWJ87/HfK+LP8rsocXgjALBgcqhkjOPQIBBQAESDBGAiEAmknSCdAV
# S1/FC7PK0lsrme5j1QnXXAmnWiL8XZ0S1hQCIQDTYDoFd1nYJ/x2RO7MdX1glTO/
# xV8XMqBRw9RmavSiCA==
# SIG # End signature block