Began to implement logging

[psmysqlbackup.git] / psmysqlbackup.ps1

diff --git a/psmysqlbackup.ps1 b/psmysqlbackup.ps1
index e7b2f5fbfd43e416beeb9397a207656a7df4dbf2..cdc6afa26f7bae0d0685cd8ae074069bbf6c6903 100644 (file)
--- a/psmysqlbackup.ps1
+++ b/psmysqlbackup.ps1
@@ -27,6 +27,9 @@ $configBackupDir = "backup"
 # Number of backups to keep, set to 0 to keep all backups
 $configRotate = 7
 
 # Number of backups to keep, set to 0 to keep all backups
 $configRotate = 7
 

+$configLogDir = "log"
+$configLogRotate = 7
+

 # Databases to backup, leave empty to backup all databases
 $configDbBackup = @()
 # If $configDbBackup is empty, don't backup the databases defined here
 # Databases to backup, leave empty to backup all databases
 $configDbBackup = @()
 # If $configDbBackup is empty, don't backup the databases defined here


@@ -36,6 +39,122 @@ $configDbExcludePattern = @()
 
 # End of config
 
 
 # End of config
 

+<# 
+.Synopsis 
+   Write-Log writes a message to a specified log file with the current time stamp. 
+.DESCRIPTION 
+   The Write-Log function is designed to add logging capability to other scripts. 
+   In addition to writing output and/or verbose you can write to a log file for 
+   later debugging. 
+.NOTES 
+   Created by: Jason Wasser @wasserja 
+   Modified: 11/24/2015 09:30:19 AM   
+ 
+   Changelog: 
+    * Code simplification and clarification - thanks to @juneb_get_help 
+    * Added documentation. 
+    * Renamed LogPath parameter to Path to keep it standard - thanks to @JeffHicks 
+    * Revised the Force switch to work as it should - thanks to @JeffHicks 
+ 
+   To Do: 
+    * Add error handling if trying to create a log file in a inaccessible location. 
+    * Add ability to write $Message to $Verbose or $Error pipelines to eliminate 
+      duplicates. 
+.PARAMETER Message 
+   Message is the content that you wish to add to the log file.  
+.PARAMETER Path 
+   The path to the log file to which you would like to write. By default the function will  
+   create the path and file if it does not exist.  
+.PARAMETER Level 
+   Specify the criticality of the log information being written to the log (i.e. Error, Warning, Informational) 
+.PARAMETER NoClobber 
+   Use NoClobber if you do not wish to overwrite an existing file. 
+.EXAMPLE 
+   Write-Log -Message 'Log message'  
+   Writes the message to c:\Logs\PowerShellLog.log. 
+.EXAMPLE 
+   Write-Log -Message 'Restarting Server.' -Path c:\Logs\Scriptoutput.log 
+   Writes the content to the specified log file and creates the path and file specified.  
+.EXAMPLE 
+   Write-Log -Message 'Folder does not exist.' -Path c:\Logs\Script.log -Level Error 
+   Writes the message to the specified log file as an error message, and writes the message to the error pipeline. 
+.LINK 
+   https://gallery.technet.microsoft.com/scriptcenter/Write-Log-PowerShell-999c32d0 
+#>
+function Write-Log 
+{ 
+    [CmdletBinding()] 
+    Param 
+    ( 
+        [Parameter(Mandatory=$true, 
+                   ValueFromPipelineByPropertyName=$true)] 
+        [ValidateNotNullOrEmpty()] 
+        [Alias("LogContent")] 
+        [string]$Message, 
+ 
+        [Parameter(Mandatory=$false)] 
+        [Alias('LogPath')] 
+        [string]$Path='C:\Logs\PowerShellLog.log', 
+         
+        [Parameter(Mandatory=$false)] 
+        [ValidateSet("Error","Warn","Info")] 
+        [string]$Level="Info", 
+         
+        [Parameter(Mandatory=$false)] 
+        [switch]$NoClobber 
+    ) 
+ 
+    Begin 
+    { 
+        # Set VerbosePreference to Continue so that verbose messages are displayed. 
+        $VerbosePreference = 'Continue' 
+    } 
+    Process 
+    { 
+         
+        # If the file already exists and NoClobber was specified, do not write to the log. 
+        if ((Test-Path $Path) -AND $NoClobber) { 
+            Write-Error "Log file $Path already exists, and you specified NoClobber. Either delete the file or specify a different name." 
+            Return 
+            } 
+ 
+        # If attempting to write to a log file in a folder/path that doesn't exist create the file including the path. 
+        elseif (!(Test-Path $Path)) { 
+            Write-Verbose "Creating $Path." 
+            $NewLogFile = New-Item $Path -Force -ItemType File 
+            } 
+ 
+        else { 
+            # Nothing to see here yet. 
+            } 
+ 
+        # Format Date for our Log File 
+        $FormattedDate = Get-Date -Format "yyyy-MM-dd HH:mm:ss" 
+ 
+        # Write message to error, warning, or verbose pipeline and specify $LevelText 
+        switch ($Level) { 
+            'Error' { 
+                Write-Error $Message 
+                $LevelText = 'ERROR:' 
+                } 
+            'Warn' { 
+                Write-Warning $Message 
+                $LevelText = 'WARNING:' 
+                } 
+            'Info' { 
+                Write-Verbose $Message 
+                $LevelText = 'INFO:' 
+                } 
+            } 
+         
+        # Write log entry to $Path 
+        "$FormattedDate $LevelText $Message" | Out-File -FilePath $Path -Append 
+    } 
+    End 
+    { 
+    } 
+}
+

 function Get-Databases() {
     $databaseString = (& $configMysqlCli --host=$configMysqlHost --port=$configMysqlPort --user=$configMysqlUser --password=$configMysqlPassword --batch --skip-column-names -e "SHOW DATABASES;")
     
 function Get-Databases() {
     $databaseString = (& $configMysqlCli --host=$configMysqlHost --port=$configMysqlPort --user=$configMysqlUser --password=$configMysqlPassword --batch --skip-column-names -e "SHOW DATABASES;")
     


@@ -71,6 +190,8 @@ function Rotate-Backups($backupDir) {
 
         if($keepBackupsCount -eq -1) {
             Write-Output "Deleting backup $($_.FullName)"
 
         if($keepBackupsCount -eq -1) {
             Write-Output "Deleting backup $($_.FullName)"

+            #Write-Log "Deleting backup $($_.FullName)"
+

             Remove-Item -Force $_.FullName
         }
     }
             Remove-Item -Force $_.FullName
         }
     }


@@ -80,13 +201,23 @@ $defaultDbExclude = @("information_schema", "performance_schema")
 
 $currDaytime = Get-Date -format "yyyyMMdd-HHmmss"
 
 
 $currDaytime = Get-Date -format "yyyyMMdd-HHmmss"
 

+$logFile = "$configLogDir\log-$currDaytime.log"
+
+$startTime = Get-Date -format "yyyy-MM-dd HH:mm:ss"
+Write-Log "Started at $startTime" -Path $logFile
+

 # Get a list of all databases
 try {
     $databases = Get-Databases | Where-Object {!($_ -in $defaultDbExclude)}
 }
 catch {
 # Get a list of all databases
 try {
     $databases = Get-Databases | Where-Object {!($_ -in $defaultDbExclude)}
 }
 catch {

+    Write-Log "Failed to get list of databases" -Path $logFile -Level Error
+    Write-Log $_ -Path $logFile -Level Error
+    Write-Log "Exiting" -Path $logFile -Level Error
+

     Write-Output "Failed to get list of databases"
     Write-Output $_
     Write-Output "Failed to get list of databases"
     Write-Output $_

+

     exit 1
 }
 
     exit 1
 }
 


@@ -100,6 +231,7 @@ if($configDbBackup -and $configDbBackup.count -gt 0) {
             $databasesToBackup += $cDb
         }
         else {
             $databasesToBackup += $cDb
         }
         else {

+            Write-Log "Not backing up database $cDb, because it does not exist" -Path $logFile -Level Warn

             Write-Warning "Not backing up database $cDb, because it does not exist"
         }
     }
             Write-Warning "Not backing up database $cDb, because it does not exist"
         }
     }


@@ -130,13 +262,20 @@ foreach($d in $databasesToBackup) {
             New-Item -ItemType directory -Path "$databaseBackupDir" -ErrorAction Stop | Out-Null
         }
         catch {
             New-Item -ItemType directory -Path "$databaseBackupDir" -ErrorAction Stop | Out-Null
         }
         catch {

+            Write-Log "Failed to create directory $databaseBackupDir" -Path $logFile -Level Error
+            Write-Log $_ -Path $logFile -Level Error
+            Write-Log "Exiting" -Path $logFile -Level Error
+

             Write-Output "Failed to create directory $databaseBackupDir"
             Write-Output $_
             Write-Output "Failed to create directory $databaseBackupDir"
             Write-Output $_

+

             exit 1
         }
     }
 
     $databaseBackupFile = Join-Path -Path $databaseBackupDir -ChildPath "backup-$d-$currDaytime.sql"
             exit 1
         }
     }
 
     $databaseBackupFile = Join-Path -Path $databaseBackupDir -ChildPath "backup-$d-$currDaytime.sql"

+
+    Write-Log "Backing up $d to $databaseBackupFile..." -Path $logFile

     Write-Output "Backing up $d to $databaseBackupFile..."
     
     try {
     Write-Output "Backing up $d to $databaseBackupFile..."
     
     try {


@@ -144,7 +283,13 @@ foreach($d in $databasesToBackup) {
         Rotate-Backups $databaseBackupDir
     }
     catch {
         Rotate-Backups $databaseBackupDir
     }
     catch {

+        Write-Log "Could not backup database $d to $databaseBackupFile" -Path $logFile -Level Error
+        Write-Log $_ -Path $logFile -Level Error
+

         Write-Output "Could not backup database $d to $databaseBackupFile"
         Write-Output $_
     }
         Write-Output "Could not backup database $d to $databaseBackupFile"
         Write-Output $_
     }

-}
\ No newline at end of file
+}
+
+$endTime = Get-Date -format "yyyy-MM-dd HH:mm:ss"
+Write-Log "Ended at $endTime" -Path $logFile
\ No newline at end of file