您应该使用哪个:Logging 代理还是客户端库?

本文档提供了所需信息,帮助您决定是使用客户端库还是使用日志记录代理以编程方式将应用日志发送到 Cloud Logging。Logging 代理会将写入文件(如 stdout 或文件)的数据作为日志发送到 Cloud Logging。Google Kubernetes Engine、App Engine 柔性环境和 Cloud Functions 等服务包含集成式日志记录代理。对于 Compute Engine,您可以安装 Ops Agent 或旧版 Cloud Logging 代理。这些代理从已知文件位置或日志记录服务(如 Windows Event Logjournaldsyslogd)收集日志。

如果无法使用客户端库或 Logging 代理,或者只想要实验,您可以使用 gcloud logging write 命令或将 HTTP 命令发送到 Cloud Logging API 端点 entries.write 来写入日志。Cloud Logging API 支持 HTTP 和 gRPC 调用。Ops Agent 和大多数 Logging 客户端库会调用 gRPC Logging API。部分语言的旧版 Logging 代理和客户端库会调用 REST Logging API。

选择代理或客户端库

在代理或客户端库之间做出决定时,请考虑以下问题:

您的应用是否在 Google Cloud 之外运行?

如果您的应用未在 Google Cloud 上运行,您需要通过某种方式将日志发送到 Logging API。如需将日志从本地系统路由到 Logging,我们建议您使用 observIQ 提供的 BindPlane。如需详细了解 BindPlane,请参阅 observIQ 和 BindPlane

或者,您也可以使用客户端库直接从应用将日志路由到 Logging。对于临时环境(如无服务器计算),您必须使用客户端库直接调用 Logging API。

运行应用的 Google Cloud 服务是否支持
stdoutstderr 内容写入您的项目?

某些 Google Cloud 服务是全代管式服务,因此您无需使用代理将日志发送到 Google Cloud 项目。在默认支持 stdoutstderr 的产品中,您可以使用任何已建立的日志记录框架(例如 Go、Node.js 和 Python)将日志发送到 Logging。依赖 stdoutstderr 而不使用客户端库的一个好处是,应用崩溃不会中断向项目发送日志。如需了解如何通过 stdoutstderr 发送结构化日志,请参阅您的应用是否可以灵活地更改日志格式?部分。

您可以使用 Logging 客户端库,但请注意,这可能会在 Logging 中引入用于本地测试的依赖项(您不一定需要它时)。使用客户端库可能还需要使用更复杂的编码来明确处理缓冲和重试。此外,每次使用 Logging 客户端库都会创建指向 API 的新连接流。这些新连接会增加复杂性,使用其他端口,并且仅使用应用中的日志发送单独的请求,如果没有太多日志,这可能会造成浪费。

是否需要能够在本地环境中访问应用日志?

如果您需要在本地环境中访问应用日志,以便进行调试和其他目的,则可以使用某些语言的日志记录模块输出到 stdoutstderr。部分语言的 Logging 客户端库支持将日志路由到 stdoutstderr

在不支持自动将写入 stdoutstderr 的日志发送到 Google Cloud 项目的 Google Cloud 服务中运行您的应用时,您可以收集磁盘文件中的 stdoutstderr 日志,并将代理配置为爬取这些日志并将其发送到 Logging。如需了解详情,请参阅 Ops Agent 或旧版 Logging 代理的配置指南。

代理安装流程是手动还是自动完成?

某些服务会自动安装代理,或者允许您自行安装代理。如果您使用的服务不允许安装代理,您必须使用客户端库才能使用 Logging。

您是否已在系统中运行 Fluentd?

旧版 Logging 代理基于 Fluentd。

如果您的系统中已经运行了 Fluentd,并且想要使用该守护程序将日志发送到 Logging,请使用适用于 fluentd 的 Google Cloud Logging 插件

您是否还收集 Cloud Monitoring 的应用指标?

在 Compute Engine 虚拟机中,Ops Agent 可以收集日志和大多数指标。如需了解详情,请参阅 Ops Agent 功能

如果 Ops Agent 无法处理您的使用场景,则您可以使用旧版 Monitoring 代理Monitoring 客户端库来收集指标。

您的应用是否能够灵活地更改日志格式?

此问题可帮助您确定应用是否可以生成结构化日志。如果您以结构化日志记录格式将日志发送到 Logging API,则 Logging 可以识别这些日志。客户端库提供了处理此格式的方法。

写入结构化日志的方法有两种:一种方法是LogEntry 信封中设置特定自动字段,另一种方法是LogEntry 信封中设置 jsonPayload 字段。前者的架构由 Cloud Logging 决定,而后者的架构由用户决定。

您必须配置代理才能识别结构化日志。默认情况下,代理配置为检测 JSON 格式的日志并将其作为结构化日志处理。如果您的应用有自己的日志格式,您无法更改,但您希望将日志识别为结构化日志,则必须以结构化日志记录格式(通常为 JSON)将日志写入 stdoutstderr,以便代理可以将它们识别为结构化日志。否则,您必须配置代理以了解您自己的格式。

每个选项的摘要

日志记录模式图

  • Cloud Logging 客户端库

    • 优点

      • 您可以将日志直接路由到 Cloud Logging API。
      • 某些语言可以使用该库将日志输出到 stdoutstderr
    • 缺点

      • 应用崩溃会导致日志无法发送到您的 Google Cloud 项目。
  • Ops Agent

    • 优点
      • Ops Agent 可以使用稳定的开源技术发送日志和指标:Fluent Bit 用于日志收集,OpenTelemetry Collector 用于指标收集。
      • 您可以从许多常见应用中收集日志和指标;请参阅监控和收集第三方应用的日志
      • 您可以在本地环境中保留日志。
      • 您或许可以从应用崩溃中恢复日志。
      • Ops Agent 正在积极开发中。
  • 旧版 Logging 代理

    • 优点
      • 该代理使用 Fluentd 收集日志。
      • 您可以在本地环境中保留日志。
      • 您或许可以从应用崩溃中恢复日志。
    • 缺点
      • 代理目前受支持,但未处于积极开发阶段。
  • stdoutstderr 日志自动发送到您的 Google Cloud 项目

    • 优点
      • 此过程是向本地环境发出日志的常用方法。
      • 您可以使用任意日志记录库。
      • 您或许可以从应用崩溃中恢复日志。
    • 缺点
      • 并非所有环境都会自动将日志路由到 Logging。