Fixes snapshot plugin exception in case vdisk was removed from VM

Icinga · Jun 1, 2023 · 5fc5fe5 · 5fc5fe5
1 parent d8f175b
commit 5fc5fe5
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 26 deletions.
diff --git a/doc/31-Changelog.md b/doc/31-Changelog.md
@@ -7,6 +7,14 @@ documentation before upgrading to a new release.
 
 Released closed milestones can be found on [GitHub](https://github.com/Icinga/icinga-powershell-hyperv/milestones?state=closed).
 
+## 1.3.0 (2023-06-16)
+
+[Issue and PRs](https://github.com/Icinga/icinga-powershell-hyperv/milestone/4?closed=1)
+
+### Bugfixes
+
+* [#67](https://github.com/Icinga/icinga-powershell-hyperv/issues/67) Fixes Hyper-V Snapshot plugin throwing an exception in case vdisks were deleted from disk or removed from the virtual machine object in Hyper-V Manager
+
 ## 1.2.0 (2022-08-30)
 
 [Issue and PRs](https://github.com/Icinga/icinga-powershell-hyperv/milestone/3?closed=1)

diff --git a/plugins/Invoke-IcingaCheckHyperVSnapshot.psm1 b/plugins/Invoke-IcingaCheckHyperVSnapshot.psm1
@@ -221,22 +221,28 @@ function Invoke-IcingaCheckHyperVSnapshot()
                 )
             );
 
-            $SnapshotMainCheck.AddCheck(
-                (
-                    New-IcingaCheck `
-                        -Name ([string]::Format('{0} {1} Total Snapshot Size', $virtualMachine.ElementName, $part)) `
-                        -Value $Partition.TotalUsed `
-                        -BaseValue $virtualMachine.CurrentUsage `
-                        -Unit 'B' `
-                        -MetricIndex $virtualMachine.ElementName `
-                        -MetricName 'summary' `
-                        -MetricTemplate 'hypervsnapshotdata'
-                ).WarnOutOfRange(
-                    $TotalSnapshotSizeWarning
-                ).CritOutOfRange(
-                    $TotalSnapshotSizeCritical
-                )
-            );
+            if ([string]::IsNullOrEmpty($virtualMachine.CurrentUsageError)) {
+                $SnapshotMainCheck.AddCheck(
+                    (
+                        New-IcingaCheck `
+                            -Name ([string]::Format('{0} {1} Total Snapshot Size', $virtualMachine.ElementName, $part)) `
+                            -Value $Partition.TotalUsed `
+                            -BaseValue $virtualMachine.CurrentUsage `
+                            -Unit 'B' `
+                            -MetricIndex $virtualMachine.ElementName `
+                            -MetricName 'summary' `
+                            -MetricTemplate 'hypervsnapshotdata'
+                    ).WarnOutOfRange(
+                        $TotalSnapshotSizeWarning
+                    ).CritOutOfRange(
+                        $TotalSnapshotSizeCritical
+                    )
+                );
+            } else {
+                $IcingaCheck = New-IcingaCheck -Name ([string]::Format('Snapshots: {0} for location "{1}" and virtual machine "{2}"', $virtualMachine.CurrentUsageError, $virtualMachine.Partition, $virtualMachine.ElementName)) -NoPerfData;
+                $IcingaCheck.SetUnknown() | Out-Null;
+                $SnapshotMainCheck.AddCheck($IcingaCheck);
+            }
 
             $AverageSnapshotSize     = [System.Math]::Truncate([System.Math]::Round($Partition.TotalUsed / $SnapshotsCount));
             $CalculateTotalSnapshots = [System.Math]::Truncate([System.Math]::Round($Partition.FreeSpace / ([math]::Max($AverageSnapshotSize, 1)), 2));

diff --git a/provider/vcomputer/Get-IcingaVirtualComputerInfo.psm1 b/provider/vcomputer/Get-IcingaVirtualComputerInfo.psm1
@@ -231,12 +231,12 @@ function Get-IcingaVirtualComputerInfo()
                 'Path'                                 = ([string]::Format('{0}{1}{2}', $snapshot.ConfigurationDataRoot, '\', $snapshot.ConfigurationFile));
             };
 
-            if (Test-Path $SnapshotContent.Path -ErrorAction SilentlyContinue) {
-                $SnapshotSize = Get-ChildItem -Path $SnapshotContent.Path | Select-Object Length;
+            try {
+                $SnapshotSize = Get-ChildItem -Path $SnapshotContent.Path -ErrorAction Stop | Select-Object Length;
                 $SnapshotContent.Add('Error', $null);
-            } else {
-                $SnapshotSize = @{ 'Length' = 0};
-                $SnapshotContent.Add('Error', 'PermissionDenied');
+            } catch {
+                $SnapshotSize = @{ 'Length' = 0 };
+                $SnapshotContent.Add('Error', $_.Exception.GetType().Name);
             }
 
             $SnapshotContent.Add('Size', $SnapshotSize.Length);
@@ -284,6 +284,13 @@ function Get-IcingaVirtualComputerInfo()
         # Sort our Snapshots based on the creation Time
         $details.Snapshots.List = $details.Snapshots.List | ConvertTo-IcingaSecureSortedArray -MemberName 'CreationTime' -Descending;
 
+        # Add some base data to prevent the plugin from crashing
+        $details += @{
+            'Partition'         = 'Unassigned';
+            'CurrentUsage'      = 0;
+            'CurrentUsageError' = 'No virtual disk assigned to this virtual machine';
+        };
+
         # We are going to loop through all available vm partitions
         foreach ($vmPartition in $VmPartitionsPath) {
             # We filter out the drive letter where the VMs are stored
@@ -305,12 +312,15 @@ function Get-IcingaVirtualComputerInfo()
                 'AutomaticAllocation'   = $vmPartition.AutomaticAllocation;
                 'AutomaticDeallocation' = $vmPartition.AutomaticDeallocation;
                 'HostResource'          = $vmPartition.HostResource;
-                'Partition'             = $vmPath;
-                'CurrentUsage'          = 'PermissionDenied';
             };
 
-            if (Test-Path -Path ([string]$vmPartition.HostResource)) {
-                $details.CurrentUsage = (Get-Item -Path ([string]$vmPartition.HostResource) | Select-Object Length).Length;
+            $details.Partition         = $vmPath;
+            $details.CurrentUsageError = '';
+
+            try {
+                $details.CurrentUsage = (Get-Item -Path ([string]$vmPartition.HostResource) -ErrorAction Stop | Select-Object Length).Length;
+            } catch {
+                $details.CurrentUsageError = $_.Exception.GetType().Name;
             }
 
             # If the partition doesn't exist in StorageOverCommit hashtable then add ones
@@ -372,7 +382,7 @@ function Get-IcingaVirtualComputerInfo()
                 $VComputerData.Resources.StorageOverCommit[$details.Partition].Bytes += ($details.DiskCapacity);
             }
 
-            if ($details.CurrentUsage -ne 'PermissionDenied') {
+            if ([string]::IsNullOrEmpty($details.CurrentUsageError)) {
                 $CurrentVmsUsage += $details.CurrentUsage;
             } else {
                 $AccessDeniedVms += $vcomputer.ElementName;