Как сохранить ScriptStackTrace в исключении, вызванном Invoke-Command на удаленном компьютере?

Когда вы запускаете некоторый код, и он завершается с ошибкой, вы получаете ErrorRecord, отражающий код, который вы выполнили (локальный компьютер). Поэтому, когда вы используете throw "error", вы можете получить доступ к информации о вызове и исключению для этого кода.

Когда вы используете Invoke-Command, вы больше не выполняете throw "error", а удаленный компьютер. Вы (локальный компьютер) выполняете Invoke-Command ...., поэтому ErrorRecord, которое вы получаете, отражает это (а не настоящее исключение, как вы хотели). Так и должно быть, поскольку исключение может исходить от блока сценария, который выполнил удаленный компьютер, но это может быть и исключение из самого Invoke-Command, потому что он не может подключиться к удаленному компьютеру или что-то подобное.

Когда исключение изначально создается на удаленном компьютере, Invoke-Command/PowerShell выдает RemoteException на локальном компьютере.

#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 и SerializedRemoteInvocationInfo, которые содержат информацию об исключении, сгенерированном в удаленном сеансе. Используя их, вы можете получить «внутреннее» исключение.

• SerializedRemoteException: получает исходное исключение, созданное удаленным экземпляром Windows PowerShell.
• SerializedRemoteInvocationInfo: получает информацию о вызове удаленного экземпляра Windows PowerShell.

Образец:

#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

Я уверен, что кто-то с большим опытом может помочь, но я хотел бы дать вам кое-что, чтобы пожевать в то же время. Похоже, вы хотите использовать throw, так как ищете завершающие исключения. Write-Error пишет в поток ошибок, но не завершается. Независимо от вашего выбора, мое предложение остается прежним.

Захват исключения в переменную — хорошее начало для этого, поэтому я бы рекомендовал этот блок из вашего примера:

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

$exception в этом случае должно быть Deserialized.System.Management.Automation.ErrorRecord. Пользовательские объекты можно отправлять на throw...

Вы также можете создать объект ErrorRecord или исключение Microsoft .NET Framework.

но в этом случае это не работает, что, вероятно, связано с десериализацией. В какой-то момент я попытался создать свой собственный объект ошибки, но некоторые из необходимых свойств были доступны только для чтения, поэтому я пропустил это.

PS M:\Scripts> throw $exception
Test Error
At line:1 char:1
+ throw $return
+ ~~~~~~~~~~~~~
    + CategoryInfo          : OperationStopped: (Test Error:PSObject) [], RuntimeException
    + FullyQualifiedErrorId : Test Error

Однако простая запись в выходной поток дает вам правильную информацию, как вы видели.

PS M:\Scripts> $exception
Test Error
At line:4 char:9
+         throw "Test Error";
+         ~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : OperationStopped: (Test Error:String) [], RuntimeException
    + FullyQualifiedErrorId : Test Error

$exception - это объект со свойствами, которые содержат всю эту информацию, поэтому возможный способ получить то, что вам нужно, - это создать пользовательскую строку ошибки из нужных свойств. Однако это оказалось большим трудом, чем того стоило. Простым компромиссом было бы использование Out-String для преобразования этого полезного вывода, чтобы его можно было вернуть как ошибку.

PS M:\Scripts> throw ($return | out-string)
Test Error
At line:4 char:9
+         throw "Test Error";
+         ~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : OperationStopped: (Test Error:String) [], RuntimeException
    + FullyQualifiedErrorId : Test Error

At line:1 char:1
+ throw ($return | out-string)
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : OperationStopped: (Test Error
At ...Test Error

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

Итак, теперь у нас есть правильная завершающая ошибка с информацией как о блоке скрипта, так и о том, где в вызывающем коде генерируется ошибка. Очевидно, вы увидите некоторое повторение, но, возможно, это станет для вас началом.

Если есть другая информация, которая вам нужна конкретно, я бы углубился в объект $exception с Get-Member, чтобы посмотреть, сможете ли вы найти что-то конкретное, что вы ищете. Некоторые примечательные свойства здесь будут

$exception.ErrorCategory_Reason
$exception.PSComputerName
$exception.InvocationInfo.Line
$exception.InvocationInfo.CommandOrigin

Последний будет читать что-то вроде этого.

PS M:\Scripts> $exception.InvocationInfo.PositionMessage
At line:4 char:9
+         throw "Test Error";
+         ~~~~~~~~~~~~~~~~~~

Надеясь, что кто-то с большим опытом может прокомментировать это, мой комментарий, похоже, остался незамеченным.

Я нашел эту статью, которая предлагает некоторое понимание использования Enter-PSSession

Или, что еще лучше, создайте постоянный сеанс

$session = New-PSSession localhost
Invoke-Command $session {ping example.com}
Invoke-Command $session {$LASTEXITCODE}

Чтобы выполнить отладку с использованием трассировки, помните, что вам необходимо установить VerbosePreference, DebugPreference и т. д. в удаленном сеансе.

Invoke-Command $session {$VerbosePreference = ‘continue’}
Invoke-Command $session {Write-Verbose hi}