如何在远程计算机上的 Invoke-Command 引发的异常中保留 ScriptStackTrace？

我正在编写一个 Powershell 脚本，它执行构建/部署过程中的步骤之一，并且需要在远程计算机上运行一些操作。该脚本相对复杂，因此如果在远程活动期间发生错误，我需要详细的堆栈跟踪来了解脚本中发生错误的位置（在已生成的日志记录之上）。

出现问题的原因是，当从远程计算机中继终止异常时，Invoke-Command 会丢失堆栈跟踪信息。如果在本地计算机上调用脚本块：

Invoke-Command -ScriptBlock {
    throw "Test Error";
}

返回所需的异常详细信息：

Test Error
At C:\ScriptTest\Test2.ps1:4 char:2
+     throw "Test Error";
+     ~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : OperationStopped: (Test Error:String) [], RuntimeException
    + FullyQualifiedErrorId : Test Error

但如果远程运行：

Invoke-Command -ComputerName $remoteComputerName -ScriptBlock {
    throw "Test Error";
}

异常堆栈跟踪指向整个 Invoke-Command 块：

Test Error
At C:\ScriptTest\Test2.ps1:3 char:1
+ Invoke-Command -ComputerName $remoteComputerName -ScriptBlock {
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : OperationStopped: (Test Error:String) [], RuntimeException
    + FullyQualifiedErrorId : Test Error

我可以手动将异常传输回本地计算机：

$exception = Invoke-Command -ComputerName $remoteComputerName -ScriptBlock {
    try
    {
        throw "Test Error";
    }
    catch
    {
        return $_;
    }
}

throw $exception;

但重新抛出它会丢失堆栈跟踪：

Test Error
At C:\ScriptTest\Test2.ps1:14 char:1
+ throw $exception;
+ ~~~~~~~~~~~~~~~~
    + CategoryInfo          : OperationStopped: (Test Error:PSObject) [], RuntimeException
    + FullyQualifiedErrorId : Test Error

如果我将异常写入输出：

$exception = Invoke-Command -ComputerName $remoteComputerName -ScriptBlock {
    try
    {
        throw "Test Error";
    }
    catch
    {
        return $_;
    }
}

Write-Output $exception;

我得到了正确的堆栈跟踪信息：

Test Error
At line:4 char:3
+         throw "Test Error";
+         ~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : OperationStopped: (Test Error:String) [], RuntimeException
    + FullyQualifiedErrorId : Test Error

但由于它不在错误流中，因此我的构建工具无法正确拾取它。如果我尝试 Write-Error，我会遇到类似的问题，重新抛出异常，并且堆栈跟踪指向脚本的错误部分。

所以我的问题是 - 如何让 Powershell 报告来自远程计算机的异常，就好像它是在本地引发的一样，具有相同的堆栈跟踪信息和错误流？

当您运行某些代码并且失败时，您会收到一个ErrorRecord反映了代码you（本地计算机）执行。所以当你使用throw "error"您可以访问该代码的调用信息和异常。

当你使用Invoke-Command，你没有执行throw "error"不再是远程计算机了。您（本地计算机）正在执行Invoke-Command ....，这就是为什么ErrorRecord你得到的反映了这一点（而不是你想要的真正的例外）。这是必须的方式，因为异常可能来自远程计算机执行的脚本块，但也可能来自Invoke-Command本身，因为它无法连接到远程计算机或类似的东西。

当异常最初是在远程计算机上引发时，Invoke-Command/PowerShell 抛出一个远程异常 https://msdn.microsoft.com/en-us/library/system.management.automation.remoteexception(v=vs.85).aspx在本地计算机上。

#Generate errors
try { Invoke-Command -ComputerName localhost -ScriptBlock { throw "error" } }
catch { $remoteexception = $_ }

try { throw "error" }
catch { $localexception = $_ }

#Get exeception-types
$localexception.Exception.GetType().Name
RuntimeException

$remoteexception.Exception.GetType().Name
RemoteException

这个异常类型有一些额外的属性，包括SerializedRemoteException and SerializedRemoteInvocationInfo其中包含远程会话中引发的异常的信息。使用这些，您可以接收“内部”异常。

• 序列化远程异常 https://msdn.microsoft.com/en-us/library/system.management.automation.remoteexception.serializedremoteexception(v=vs.85).aspx：获取 Windows PowerShell 远程实例引发的原始异常。
• 序列化远程调用信息 https://msdn.microsoft.com/en-us/library/system.management.automation.remoteexception.serializedremoteinvocationinfo(v=vs.85).aspx：获取Windows PowerShell 远程实例的调用信息。

Sample:

#Show command that threw error 
$localexception.InvocationInfo.PositionMessage

At line:4 char:7
+ try { throw "error" }
+       ~~~~~~~~~~~~~

$remoteexception.Exception.SerializedRemoteInvocationInfo.PositionMessage    

At line:1 char:2
+  throw "error"
+  ~~~~~~~~~~~~~

然后，您可以编写一个简单的函数来动态提取信息，例如：

function getExceptionInvocationInfo ($ex) {
    if($ex.Exception -is [System.Management.Automation.RemoteException]) {
        $ex.Exception.SerializedRemoteInvocationInfo.PositionMessage
    } else {
        $ex.InvocationInfo.PositionMessage
    }
}

function getException ($ex) {
    if($ex.Exception -is [System.Management.Automation.RemoteException]) {
        $ex.Exception.SerializedRemoteException
    } else {
        $ex.Exception
    }
}

getExceptionInvocationInfo $localexception

At line:4 char:7
+ try { throw "error" }
+       ~~~~~~~~~~~~~

getExceptionInvocationInfo $remoteexception
At line:1 char:2
+  throw "error"
+  ~~~~~~~~~~~~~

请注意，SerializedRemoteExpcetion显示为PSObject由于网络传输期间的序列化/反序列化，因此如果您要检查异常类型，则需要从中提取它psobject.TypeNames.

$localexception.Exception.GetType().FullName
System.Management.Automation.ItemNotFoundException

$remoteexception.Exception.SerializedRemoteException.GetType().FullName
System.Management.Automation.PSObject

#Get TypeName from psobject
$remoteexception.Exception.SerializedRemoteException.psobject.TypeNames[0]
Deserialized.System.Management.Automation.ItemNotFoundException