SimplePSLog.psm1
|
<# .SYNOPSIS This function creates a log file with the specified path and name. .DESCRIPTION The Start-Log function takes two optional parameters: $LogPath and $LogName. If the log file does not exist, it is created. .PARAMETER LogPath The path to the directory where the log file will be created. .PARAMETER LogName The name of the log file. .EXAMPLE Start-Log -LogPath "C:\Logs" -LogName "MyLog.txt" This example creates a log file named "MyLog.txt" in the "C:\Logs" directory. #> function Start-Log { [CmdletBinding()] param ( [ValidateNotNullOrEmpty()][string]$LogPath = "$env:ProgramData\Logs", [ValidateNotNullOrEmpty()][string]$LogName = "SimplePSLog.txt" ) Write-Verbose "Generating the fullpath of the file" $script:LogFullPath = Join-Path $LogPath $LogName if (!(Test-Path $script:LogFullPath)) { try { Write-Verbose "Triyng to create $script:LogFullPath" New-Item -Path $script:LogFullPath -Force Write-Verbose "Writing creation timestamp inside $script:LogFullPath" New-log -Type Information -Message "This file as been created" } catch { Write-Error "Failed to create log file: $_" } } else { Write-Verbose "$script:LogFullPath already exist" } Write-Output -InputObject "File located at $script:LogFullPath" } <# .SYNOPSIS This function returns a timestamp in the format "dd/MM/yyyy ; HH:mm:ss ; ". .DESCRIPTION The Set-Timestamp function takes no parameters and returns a timestamp in the format "dd/MM/yyyy ; HH:mm:ss ; ". .EXAMPLE $timestamp = Set-Timestamp This example sets the variable $timestamp to the current timestamp in the format "dd/MM/yyyy ; HH:mm:ss ; ". #> function Set-Timestamp { [CmdletBinding()] param() return Get-Date -Format "dd/MM/yyyy ; HH:mm:ss ; " } <# .SYNOPSIS This function writes messages to the log file with a timestamp and message type (Error, Warning, or Information). .DESCRIPTION The New-Log function takes two parameters: $Type and $Message. It writes messages to the log file with a timestamp and message type (Error, Warning, or Information). .PARAMETER Type The type of message to write to the log file (Error, Warning, or Information). .PARAMETER Message The message to write to the log file. .EXAMPLE New-Log -Type "Error" -Message "An error has occurred" This example writes an error message to the log file with a timestamp. #> function New-log { [CmdletBinding()] param ( [ValidateSet("Error","Warning","Information")] $Type, [string]$Message = 'Information' ) Write-Verbose "Checking if $script:LogFullPath exist" if (!($script:LogFullPath)) { Write-Error 'Run the Start-Log command before generating logs' exit } Write-Verbose "Generating timestamp" $Timestamp = Set-Timestamp Write-Verbose "Generating message" $Message = $Timestamp + "["+$type+"] ; " +$Message try { Write-Verbose "Adding the message to log file" Add-Content -Value $Message -Path $script:LogFullPath Write-Output $Message } catch { Write-Error "Failed to write to log file: $_" } } <# .SYNOPSIS This function closes the log file and completes the logging process. .DESCRIPTION The Stop-Log function closes the log file and completes the logging process. It can be used to finalize the log file and prevent further writing. .EXAMPLE Stop-Log This example stops the logging process and closes the log file. #> function Stop-Log { [CmdletBinding()] param() Write-Verbose "Closing the log file" try { $script:LogFullPath = $null } catch { Write-Error "Failed to close the log file: $_" } } |