对 C# 应用进行插桩处理以进行 Error Reporting

您可以通过 C# 将错误报告发送到 Error Reporting 如何使用 Google Cloud 中的 <ph type="x-smartling-placeholder"></ph> Google.Cloud.Diagnostics 库集合 。 使用 Google.Cloud.Diagnostics 库集合 针对以下情况创建错误组:

  • 您的日志存储桶包含客户管理的加密密钥 (CMEK)
  • 您的日志存储分区不在 global 区域中。
  • 您想要报告自定义错误事件。

Error Reporting 已与某些 Google Cloud 服务集成,例如 App EngineCompute EngineGoogle Kubernetes Engine。Error Reporting 可显示在这些服务上运行的应用记录到 Cloud Logging 中的错误。如需了解详情,请参阅 在 Google Cloud 上运行 页面。

您还可以使用 Logging 将错误数据发送到 Error Reporting。如需了解数据格式设置要求,请参阅设置 Logging 中的错误消息格式

准备工作

  1. 登录您的 Google Cloud 账号。如果您是 Google Cloud 新手,请创建一个账号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金,用于运行、测试和部署工作负载。
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. 确保您的 Google Cloud 项目已启用结算功能

  4. 启用 Error Reporting API 。

    启用 API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  6. 确保您的 Google Cloud 项目已启用结算功能

  7. 启用 Error Reporting API 。

    启用 API

安装客户端库

通过 Google.Cloud.Diagnostics 库集合 您可以监控和查看 几乎可在任何位置运行的 C# 应用。

  1. 对于以 ASP.NET Core 3 或更高版本为目标的应用,请使用 Google.Cloud.Diagnostics.AspNetCore3 库。您可以从 NuGet 安装此库。
  2. 对于针对早期版本的 ASP.NET Core 的应用,请使用 该 Google.Cloud.Diagnostics.AspNetCore 库。您可以从 NuGet 安装此库。
  3. 对于以非 ASP.NET Core 框架为目标的应用,请使用 Google.Cloud.Diagnostics.Common 库。您可以从以下位置安装此库: NuGet.

如需详细了解如何安装,请参阅 Google.Cloud.Diagnostics 库集的文档。您还可以使用问题跟踪器来报告问题。

配置客户端库

如需了解详情和示例,请参阅以下资源:

  • <ph type="x-smartling-placeholder"></ph> Google.Cloud.Diagnostics.AspNetCore3 文档
  • <ph type="x-smartling-placeholder"></ph> Google.Cloud.Diagnostics.AspNetCore 文档
  • <ph type="x-smartling-placeholder"></ph> Google.Cloud.Diagnostics.Common 文档
  • 在 Google Cloud 上运行应用

    要使用以下方法创建错误组: projects.events.report,您的服务账号需要 Error Reporting 写入者角色 (roles/errorreporting.writer)。

    某些 Google Cloud 服务会自动 Error Reporting Writer 角色 (roles/errorreporting.writer) 服务账号。但是,您必须将此角色授予相应的服务 使用部分服务

    App Engine 柔性环境

    App Engine 会将 Error Reporting Writer 角色 (roles/errorreporting.writer) 您的默认服务账号

    通过 Google.Cloud.Diagnostics 库集合 而无需明确提供 凭据。

    系统会自动为 App Engine 柔性环境应用启用 Error Reporting。无需进行额外设置。 Error Reporting 将对从 App Engine 写入到 stderr 的消息进行分析;如果发现包含堆栈轨迹,则显示这些消息。

    有关说明,请参阅查看错误 在 Google Cloud 控制台。

    Google Kubernetes Engine

    如需将 Error Reporting 与 Google Kubernetes Engine 搭配使用, 执行以下操作:

    1. 确保容器要使用的服务账号已 授予了 Error Reporting 写入者角色 (roles/errorreporting.writer)。

      您可以使用 Compute Engine 默认服务账号 或自定义服务账号

      如需了解如何授予角色,请参阅 管理对项目、文件夹和组织的访问权限

    2. 创建集群并向该集群授予 cloud-platform 访问权限范围

      例如,以下 create 命令指定了 cloud-platform 访问权限范围和服务账号:

      gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
      

    Compute Engine

    如需将 Error Reporting 与 Compute Engine 虚拟机实例搭配使用,请执行以下操作: 执行以下操作:

    1. 确保已为您的虚拟机实例使用服务账号 授予了 Error Reporting 写入者角色 (roles/errorreporting.writer)。

      您可以使用 Compute Engine 默认服务账号 或自定义服务账号

      如需了解如何授予角色,请参阅 管理对项目、文件夹和组织的访问权限

    2. 在 Google Cloud 控制台中,转到虚拟机实例页面:

      前往虚拟机实例

      如果您使用搜索栏查找此页面,请选择子标题为 Compute Engine 的结果。

    3. 选择要接收 cloud-platform 访问权限范围

    4. 点击停止,然后点击修改

    5. 身份和 API 访问权限部分,选择服务账号 具有 Error Reporting Writer 角色 (roles/errorreporting.writer)。

    6. 访问权限范围部分中, 选择允许所有 Cloud API 的全面访问权限,然后保存更改。

    7. 点击启动/恢复

    示例

    如需了解详情和示例,请参阅以下资源:

  • <ph type="x-smartling-placeholder"></ph> Google.Cloud.Diagnostics.AspNetCore3 文档
  • <ph type="x-smartling-placeholder"></ph> Google.Cloud.Diagnostics.AspNetCore 文档
  • <ph type="x-smartling-placeholder"></ph> Google.Cloud.Diagnostics.Common 文档
  • 在本地开发环境中运行应用

    要使用 Google.Cloud.Diagnostics 库集合 在本地开发环境中 例如在自己的工作站上运行库,则必须提供 您的 Google.Cloud.Diagnostics 库集合 替换为本地应用默认凭据 如需了解详情,请参阅向 Error Reporting 进行身份验证

    如需在本地开发环境中使用本页面上的 .NET 示例,请安装并初始化 gcloud CLI,然后使用您的用户凭据设置应用默认凭据。

    1. 安装 Google Cloud CLI。
    2. 如需初始化 gcloud CLI,请运行以下命令:

      gcloud init
    3. 为您的 Google 账号创建本地身份验证凭据:

      gcloud auth application-default login

    如需了解详情,请参阅 Set up authentication for a local development environment

    projects.events.report 方法也支持 API 密钥。 如果您要使用 API 密钥进行身份验证,则无需设置本地应用默认凭据文件。如需了解详情,请参阅 在 Google Cloud 身份验证文档中创建 API 密钥

    查看错误报告

    在 Google Cloud 控制台中,转到 Error Reporting 页面:

    前往 Error Reporting

    您也可以使用搜索栏查找此页面。

    如需了解详情,请参阅查看错误