编辑

通过

在 Visual Studio 中进行快照调试的常见问答解答

  • 常见问题解答

下面列出了在使用 Snapshot Debugger 调试实时 Azure 应用程序时可能出现的问题。

获取快照的性能成本是什么？

当 Snapshot Debugger 捕获应用快照时，它会创建应用进程的分支并挂起分支的副本。 调试快照时，将针对进程的分支副本进行调试。 此过程只需 10-20 毫秒，但不会复制应用的完整堆。 而是仅复制页表并将页设置为写入时复制。 如果堆上的某些应用对象发生更改，则会复制其相应页。 这就是每个快照具有较小的内存中成本的原因（对于大多数应用，大约具有数百千字节）。

如果我有一个横向扩展的 Azure 应用服务（多个应用实例），会发生什么情况？

具有多个应用实例时，快照点会应用于每个实例。 只有符合指定条件的第一个快照点才会创建快照。 如果你有多个快照点，则后续快照将来自创建了第一个快照的同一个实例。 发送到输出窗口的记录点将仅显示来自一个实例的消息，而发送到应用程序日志的记录点将发送来自所有实例的消息。

Snapshot Debugger 如何加载符号？

若要使用 Snapshot Debugger，本地应用程序或部署到 Azure 应用服务的应用程序必须具有匹配的符号。 （目前不支持嵌入的 PDB。）Snapshot Debugger 将自动从 Azure 应用服务下载符号。 自 Visual Studio 2017 版本 15.2 起，部署到 Azure 应用服务时，也会同时部署应用的符号。

Snapshot Debugger 是否适用于我的应用程序的发布版本？

是 - Snapshot Debugger 适用于发布版本。 当快照点置于某个函数中时，该函数被重新编译回调试版本，使其可调试。 停止 Snapshot Debugger 会将函数返回到发布版本的版本。

记录点是否可能在我的生产应用程序中产生副作用？

否 - 添加到应用的任何日志消息都会进行虚拟评估。 它们不会对你的应用程序产生任何副作用。 但是，可能无法使用记录点访问某些本机属性。

如果我的服务器处于负载中，Snapshot Debugger 是否会运行？

是，快照调试可用于处于负载中的服务器。 当服务器上的可用内存量较少时，Snapshot Debugger 会进行限制，并且不会捕获快照。

如何卸载快照调试器？

可以通过执行以下步骤来卸载应用服务上的 Snapshot Debugger 站点扩展：

  1. 通过 Visual Studio 中的 Cloud Explorer 或 Azure 门户禁用应用服务。
  2. 导航到应用服务的 Kudu 站点（即，yourappservice.scm.azurewebsites.net）并导航到“站点扩展”。
  3. 单击 Snapshot Debugger 站点扩展上的 X 以将其删除。

为什么在 Snapshot Debugger 会话期间打开端口？

Snapshot Debugger 必须打开一组端口才能调试在 Azure 中获取的快照，这些端口与远程调试所需的端口相同。 可以在此处找到端口列表。

如何禁用远程调试器扩展？

对于应用服务：

  1. 通过 Azure 门户为应用服务禁用远程调试器扩展。
  2. Azure 门户 > 你的应用程序服务资源边栏选项卡 >“应用程序设置”
  3. 导航到“调试”部分，然后单击“远程调试”的“关闭”按钮 。

对于 AKS：

  1. 更新 Dockerfile，以删除与 Docker 映像上的 Visual Studio Snapshot Debugger 对应的部分。
  2. 重新生成并重新部署修改后的 Docker 映像。

对于虚拟机/虚拟机规模集，请按照以下步骤删除远程调试器扩展、证书、KeyVault 和入站 NAT 池：

  1. 删除远程调试器扩展

    可通过多种方法为虚拟机和虚拟机规模集禁用远程调试器：

    • 通过 Cloud Explorer 禁用远程调试器

      • Cloud Explorer > 你的虚拟机资源 >“禁用调试”（对于 Cloud Explorer 上的虚拟机规模集，不存在“禁用调试”）。

    • 使用 PowerShell 脚本/Cmdlet 禁用远程调试器

      对于虚拟机：

      Remove-AzVMExtension -ResourceGroupName $rgName -VMName $vmName -Name Microsoft.VisualStudio.Azure.RemoteDebug.VSRemoteDebugger

      对于虚拟机规模集：

      $vmss = Get-AzVmss -ResourceGroupName $rgName -VMScaleSetName $vmssName
$extension = $vmss.VirtualMachineProfile.ExtensionProfile.Extensions | Where {$_.Name.StartsWith('VsDebuggerService')} | Select -ExpandProperty Name
Remove-AzVmssExtension -VirtualMachineScaleSet $vmss -Name $extension

    • 通过 Azure 门户禁用远程调试器

      • Azure 门户 > 你的虚拟机/虚拟机规模集资源边栏选项卡 >“扩展”
      • 卸载 Microsoft.VisualStudio.Azure.RemoteDebug.VSRemoteDebugger 扩展

      注意

      虚拟机规模集：门户不允许删除 DebuggerListener 端口。 你将需要使用 Azure PowerShell。 有关详细信息，请参见以下内容。

  2. 删除证书和 Azure KeyVault

    在为虚拟机或虚拟机规模集安装远程调试器扩展时，将同时创建客户端证书和服务器证书，以使用 Azure 虚拟机/虚拟机规模集资源对 Visual Studio 客户端进行身份验证。

    • 客户端证书

      此证书是自签名证书，位于 Cert:/CurrentUser/My/

      Thumbprint                                Subject
----------                                -------

1234123412341234123412341234123412341234  CN=ResourceName

      从计算机中删除此证书的一种方法是通过 PowerShell

      $ResourceName = 'ResourceName' # from above
Get-ChildItem -Path Cert:\CurrentUser\My | Where-Object {$_.Subject -match $ResourceName} | Remove-Item

    • 服务器证书

      • 相应的服务器证书指纹已作为机密部署到 Azure KeyVault。 Visual Studio 将尝试在对应于虚拟机或虚拟机规模集资源的区域中找到或创建带有 MSVSAZ* 前缀的 KeyVault。 因此，部署到该区域的所有虚拟机或虚拟机规模集资源都将共享同一 KeyVault。
      • 若要删除服务器证书指纹机密，请转到 Azure 门户，然后在托管资源的同一区域中找到 MSVSAZ* KeyVault。 删除标记为 remotedebugcert<<ResourceName>> 的机密
      • 你还需要通过 PowerShell 从资源中删除服务器机密。

      对于虚拟机：

      $vm.OSProfile.Secrets[0].VaultCertificates.Clear()
Update-AzVM -ResourceGroupName $rgName -VM $vm

      对于虚拟机规模集：

      $vmss.VirtualMachineProfile.OsProfile.Secrets[0].VaultCertificates.Clear()
Update-AzVmss -ResourceGroupName $rgName -VMScaleSetName $vmssName -VirtualMachineScaleSet $vmss

  3. 删除所有 DebuggerListener 入站 NAT 池（仅限虚拟机规模集）

    远程调试器引入了 DebuggerListener 入站 NAT 池，这些池应用于规模集的负载均衡器。

    $inboundNatPools = $vmss.VirtualMachineProfile.NetworkProfile.NetworkInterfaceConfigurations.IpConfigurations.LoadBalancerInboundNatPools
$inboundNatPools.RemoveAll({ param($pool) $pool.Id.Contains('inboundNatPools/DebuggerListenerNatPool-') }) | Out-Null

if ($LoadBalancerName)
{
   $lb = Get-AzLoadBalancer -ResourceGroupName $ResourceGroup -name $LoadBalancerName
   $lb.FrontendIpConfigurations[0].InboundNatPools.RemoveAll({ param($pool) $pool.Id.Contains('inboundNatPools/DebuggerListenerNatPool-') }) | Out-Null
   Set-AzLoadBalancer -LoadBalancer $lb
}

如何禁用 Snapshot Debugger？

对于应用服务：

  1. 通过 Azure 门户为应用服务禁用 Snapshot Debugger。

  2. Azure 门户 > 你的应用程序服务资源边栏选项卡 >“应用程序设置”

  3. 在 Azure 门户中删除以下应用设置，然后保存更改。

    • INSTRUMENTATIONENGINE_EXTENSION_VERSION
    • SNAPSHOTDEBUGGER_EXTENSION_VERSION

    警告

    对应用程序设置的所有更改都会启动应用重启。 有关应用程序设置的详细信息，请参阅在 Azure 门户中配置应用服务应用。

对于 AKS：

  1. 更新 Dockerfile，以删除与 Docker 映像上的 Visual Studio Snapshot Debugger 对应的部分。
  2. 重新生成并重新部署修改后的 Docker 映像。

对于虚拟机/虚拟机规模集：

有多种方法可以禁用 Snapshot Debugger：

  • Cloud Explorer > 你的虚拟机/虚拟机规模集资源 >“禁用诊断”

  • Azure 门户 > 你的虚拟机/虚拟机规模集资源边栏选项卡 >“扩展”> 卸载 Microsoft.Insights.VMDiagnosticsSettings 扩展

  • 来自 Az PowerShell 的 PowerShell Cmdlet

    虚拟机：

        Remove-AzVMExtension -ResourceGroupName $rgName -VMName $vmName -Name Microsoft.Insights.VMDiagnosticsSettings

    虚拟机规模集：

        $vmss = Get-AzVmss -ResourceGroupName $rgName -VMScaleSetName $vmssName
    Remove-AzVmssExtension -VirtualMachineScaleSet $vmss -Name Microsoft.Insights.VMDiagnosticsSettings

请参阅