使用 Telemetry API

您可以将 Ops Agent 配置为使用遥测 (OTLP) API 将日志、指标和跟踪记录发送到您的 Google Cloud 项目。Telemetry API (telemetry.googleapis.com) 是对开源 OpenTelemetry 协议的实现。当您配置 Ops Agent 以使用此 API 时，Ops Agent 会使用 Telemetry API 而不是专有的 Cloud Monitoring API、Logging API 或 Trace API 来发送遥测数据。

如果您在 Ops Agent 中采用 Telemetry API，并且有用于监控 API 使用情况的图表或提醒政策，则必须更新这些制品，以监控 telemetry.googleapis.com 端点，而不是 monitoring.googleapis.com、logging.googleapis.com 或 cloudtrace.googleapis.com 端点。

准备工作

如需使用 Telemetry API，请执行以下操作：

  1. 在您的 Google Cloud 项目中启用 Telemetry API（如果尚未启用）。您可以运行以下命令来启用该 API：

    gcloud services enable telemetry.googleapis.com

  2. 如果默认值不够，请调整 Telemetry API 配额。 Telemetry API 的配额与 Cloud Monitoring API 和 Cloud Logging API 的配额是分开的。如需了解 Telemetry API 的配额和限制，请参阅以下内容：

    您可能需要调整这些配额，以适应您注入的遥测数据量。

  3. 如果您要收集跟踪记录，请向 Ops Agent 使用的服务账号授予 Cloud Telemetry Traces Writer (roles/telemetry.tracesWriter) 角色。此角色提供写入轨迹所需的权限。

配置 Ops Agent 以使用 Telemetry API

Ops Agent 提供了一个配置选项，用于在以下两种遥测数据发送方式之间切换：使用专有 API（默认）和使用 Telemetry API。如需使用 Ops Agent 和 Telemetry API 收集遥测数据，您必须执行以下操作（如以下部分所述）：

  1. 安装支持 Telemetry API 的 Ops Agent 版本。
  2. 更新 Ops Agent config.yaml 文件以设置配置选项。
  3. 重启 Ops Agent 以使更改生效。

使用 Ops Agent 2.71.0 版或更高版本

如需将 Telemetry API 与 Ops Agent 搭配使用，您必须安装 Ops Agent 2.71.0 版或更高版本。 如需了解如何安装 Ops Agent，请参阅在单个虚拟机上安装 Ops Agent。

设置配置选项

通过在代理的 config.yaml 文件中将 otlp_exporter 配置选项设置为 true，授予 Ops Agent 对 Telemetry API 的访问权限：

global:
   otlp_exporter: true

重启 Ops Agent

Linux

  1. 要重启代理，请在您的实例上运行以下命令： 
    sudo systemctl restart google-cloud-ops-agent
  2. 如需确认代理已重启，请运行以下命令并验证“Metrics Agent”和“Logging Agent”组件是否已启动： 
    sudo systemctl status "google-cloud-ops-agent*"

Windows

  1. 使用 RDP 或类似工具连接到您的实例，然后登录到 Windows。
  2. 右键点击 PowerShell 图标并选择 Run as Administrator，以管理员权限打开 PowerShell 终端
  3. 如需重启代理，请运行以下 PowerShell 命令： 
    Restart-Service google-cloud-ops-agent -Force
  4. 如需确认代理已重启，请运行以下命令并验证“Metrics Agent”和“Logging Agent”组件是否已启动： 
    Get-Service google-cloud-ops-agent*

将 Ops Agent 配置为不使用 Telemetry API

如需停止 Ops Agent 使用 Telemetry API 收集遥测数据，并恢复使用 Cloud Monitoring API、Logging API 和 Trace API 收集遥测数据，请执行以下操作：

  1. 从 config.yaml 文件中移除了 otlp_exporter 选项。 或者，您也可以将该选项设置为 false。

  2. 重启 Ops Agent 以使更改生效。

后续步骤