Amazon Toolkit for Visual Studio 故障排除 - Amazon Toolkit with Amazon Q
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

Amazon Toolkit for Visual Studio 故障排除

以下各部分包含有关 Amazon Toolkit for Visual Studio 和在该工具包中使用 Amazon 服务的常规问题排查信息。

注意

本用户指南的排查安装问题主题中提供了特定于安装和设置的问题排查信息。

问题排查最佳实践

以下是推荐使用的 Amazon Toolkit for Visual Studio 问题排查最佳实践。

  • 修复 Visual Studio 并重新启动系统

  • 在发送报告之前,尝试重现问题或错误。

  • 详细记录重现过程中的每个步骤、设置和错误消息。

  • 收集 Amazon Toolkit 日志。有关如何找到 Amazon Toolkit 日志的详细说明,请参阅本指南主题中的如何找到 Amazon 日志步骤。

  • 在 Amazon Toolkit for Visual Studio GitHub 存储库的 Amazon Toolkit for Visual Studio Issues 部分查看未解决的请求、已知的解决方案或报告未解决的问题。

修复 Visual Studio 并重新启动系统
  1. 关闭所有正在运行的 Visual Studio 实例。

  2. 从 Windows“开始”菜单中启动 Visual Studio 安装程序

  3. 对受影响的 Visual Studio 安装运行“修复”。这允许 Visual Studio 重新构建其已安装扩展的索引。

  4. 在重新启动 Visual Studio 之前重新启动 Windows。

如何查找 Amazon Toolkit 日志
  1. 在 Visual Studio 主菜单中,展开扩展

  2. 选择 Amazon Toolkit 以展开 Amazon Toolkit 菜单,然后选择查看 Toolkit 日志

  3. 在操作系统中打开 Amazon Toolkit 日志文件夹后,按日期对文件进行排序,然后找到任何包含与当前问题相关的信息的日志文件。

查看和筛选 Amazon Q 安全扫描

要在 Visual Studio 中查看 Amazon Q 安全扫描,请通过在 Visual Studio 主菜单中展开查看标题并选择错误列表,来打开 Visual Studio 错误列表

默认情况下,Visual Studio 错误列表会显示您的代码库的所有警告和错误。要从 Visual Studio 错误列表中筛选出 Amazon Q 安全扫描结果,请完成以下流程以创建筛选器。

注意

只有当运行了安全扫描并且检测出问题后,才会显示 Amazon Q 安全扫描结果。

Amazon Q 安全扫描结果会以警告形式显示在 Visual Studio 中。要从错误列表查看 Amazon Q 安全扫描结果,必须选择错误列表标题中的警告选项。

  1. 从 Visual Studio 主菜单中展开查看标题,选择错误列表以打开错误列表窗格。

  2. 错误列表窗格中,右键单击标题行,以打开上下文菜单。

  3. 在上下文菜单中,展开显示列,然后在展开的菜单中选择工具

  4. 工具列已添加到您的错误列表中。

  5. 工具列标题中,选择筛选图标,选择 Amazon Q 以筛选 Amazon Q 安全扫描结果。

Amazon Toolkit 安装不正确

问题:

在启动 Visual Studio 以及 Amazon Toolkit for Visual Studio 后的一分钟内,输出窗格和信息栏中将分别显示以下消息:

Some Toolkit components could not be initialized. Some functionality may not work during this IDE session.

The Amazon Toolkit is not properly installed.

解决方案:

更新或安装某个扩展可能会导致 Visual Studio 的某些内部缓存文件不同步。以下过程介绍如何让 Visual Studio 在下次启动时重新生成这些文件。

注意

此解决方案可能会影响您的 Visual Studio 自定义设置。完成此过程后,Amazon Toolkit 扩展应显示为已安装且不再报告错误消息。如果您在完成以下步骤后仍然遇到此问题,请参阅 Amazon Toolkit for Visual Studio GitHub 存储库中的问题 #452 以获取更多信息。

  1. 安装 Visual Studio 2022 的最新版本。

    注意

    要求的最低版本为 17.11.5。

  2. 关闭所有正在运行的 Visual Studio 实例。

  3. 在 Windows 系统中,以管理员身份打开开发者命令提示符

  4. 开发者命令提示符下,运行以下命令:devenv /updateconfiguration /resetExtensions,然后等待命令完成。

  5. 命令完成后,重新启动 Visual Studio。

  6. 在 Visual Studio 中,该 Amazon 扩展现在显示为已安装,且不再报告此问题顶部列出的错误消息。

防火墙和代理设置

排查防火墙和代理设置故障

安全扫描软件可能会删除您从 Amazon Toolkit 语言服务器下载的文件或完全阻止下载,从而干扰您的下载能力。

要检查您的防火墙和代理设置,请使用与 Visual Studio 实例在同一个系统上的互联网浏览器导航到 https://aws-toolkit-language-servers.amazonaws.com/codewhisperer/0/manifest.json。如果您遇到错误或页面无法加载,则表明可能有防火墙或代理过滤器在阻止您访问 aws-toolkit-language-servers.amazonaws.com

自定义证书

Amazon Toolkit for Visual Studio 使用在 Node.js 运行时上运行的一个语言服务器。有关如何检查您的网络是否使用自定义证书的详细信息,请参阅《Amazon Command Line Interface用户指南(版本 1)》中的Amazon CLI 中的配置和凭证文件设置

要配置代理设置和定义证书,必须配置 HTTPS_PROXY 环境变量并为 NODE_OPTIONSNODE_EXTRA_CA_CERTS 键创建 Windows 环境变量。

要配置 HTTPS_PROXY 环境变量,请完成以下步骤:

  1. 从 Visual Studio 主菜单中选择工具,然后选择选项

  2. 选项菜单中展开 Amazon Toolkit,然后选择代理

  3. 代理菜单中,定义您的主机端口

注意

有关从 Amazon CLI 配置 HTTPS_PROXY 的信息,请参阅《Amazon Command Line Interface用户指南》中的在 Amazon CLI 中使用 HTTP 代理主题。

为以下键创建 Windows 环境变量。

  • NODE_OPTIONS = --use-openssl-ca

  • NODE_EXTRA_CA_CERTS = Path/To/Corporate/Certs

注意

有关提取企业根证书的更多信息,请参阅 learn.microsoft.com 上的使用私有密钥导出证书一文。有关 Windows 环境变量键的详细信息,请参阅 nodejs.org 上的 Node.js v23.3.0 文档

允许列表和额外步骤

除了干扰 Amazon Toolkit 语言服务器外,防火墙设置还可以阻止 Amazon Q 上传到 Amazon S3 并调用服务 API。为了尽量避免这些错误,建议允许在端口 443(HTTPS)上对以下端点进行出站互联网访问:

  • https://codewhisperer.us-east-1.amazonaws.com/

  • https://amazonq-code-transformation-us-east-1-c6160f047e0.s3.amazonaws.com/

  • https://aws-toolkit-language-servers.amazonaws.com/

  • https://q.us-east-1.amazonaws.com

  • https://client-telemetry.us-east-1.amazonaws.com

  • https://cognito-identity.us-east-1.amazonaws.com

  • https://oidc.us-east-1.amazonaws.com

有关端点的详细列表,请参阅本用户指南中的更新防火墙和网关以允许访问主题。有关为 Amazon Q 配置公司代理的详细信息,请参阅《Amazon Q 开发者版用户指南》中的在 Amazon Q 中配置公司代理主题。如果您仍然遇到防火墙和代理问题,请收集 Amazon Toolkit 日志,并通过 Amazon Toolkit for Visual Studio GitHub 存储库的 Amazon Toolkit for Visual Studio 问题部分联系 Amazon Toolkit for Visual Studio 团队寻求帮助。有关收集 Amazon Toolkit 日志的详细信息,请查看本用户指南主题的问题排查最佳实践一节。