@google-cloud/logging-min

中文文档
12.1.0发布于 2026/09/16Apache-2.0TypeScriptCommonJS近 30 天下载 171.9万

Cloud 登录节点客户端库

中文使用文档
文档目录16 节
  1. 快速启动
  2. 在你开始之前
  3. 安装客户端库
  4. 使用客户端库
  5. 剪接写
  6. 写入 Stdout
  7. 输入 Http 请求元数据
  8. 自动追踪/扫描ID提取
  9. 从 OpenTeleometry 上下文提取追踪/扩展 ID
  10. 从 HTTP 信头中提取 Trace/ span ID
  11. 写入或同步删除日志处理出错
  12. 样本
  13. 支持的节点.js版本
  14. 版本
  15. 捐款
  16. 许可证

Google Cloud Platform logo

云日志:节点.js客户端

release level npm version

谷歌云记录 允许你存储,搜索,分析, 监控,并提醒来自Google Cloud平台和Amazon Web Services的日志数据和事件.

如果需要轻量级依赖性,则使用实验、精密版本 此库可在 @google-cloud/ logb- min 页面存档备份,存于互联网档案馆。 。 。 . 说明: logging-min 是实验性的,其特征表面有变化. 要安装 @google-cloud/logging-min 库运行以下命令 :

npm install @google-cloud/logging-min

关于在节点.js应用程序中使用客户端库的交互式教程,请点击 Guide Me:

Guide Me

各版本的更改一览表载于 变化。 。 。 .

更多信息,请访问Cloud APIs的客户端库,包括老年人 Google APIs 客户端图书馆, in 客户端图书馆解释。 。 。 .

目录 :

快速启动

在你开始之前

  1. 选择或创建云平台项目。 。 。 .
  2. 启用云日志 API。 。 。 .
  3. 用服务账户设置认证 这样你就可以访问 当地工作站的API.

安装客户端库

npm install @google-cloud/logging

使用客户端库

// Imports the Google Cloud client library
const {Logging} = require('@google-cloud/logging');

async function quickstart(
  projectId = 'YOUR_PROJECT_ID', // Your Google Cloud Platform project ID
  logName = 'my-log' // The name of the log to write to
) {
  // Creates a client
  const logging = new Logging({projectId});

  // Selects the log to write to
  const log = logging.log(logName);

  // The data to write to the log
  const text = 'Hello, world!';

  // The metadata associated with the entry
  const metadata = {
    resource: {type: 'global'},
    // See: https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity
    severity: 'INFO',
  };

  // Prepares a log entry
  const entry = log.entry(metadata, text);

  async function writeLog() {
    // Writes the log entry
    await log.write(entry);
    console.log(`Logged: ${text}`);
  }
  writeLog();
}

剪接写

高吞吐量应用程序应避免等待伐木机的呼叫:

await log.write(logEntry1);
await log.write(logEntry2);

相反,应用应当使用 火和忘记 办法:

log.write(logEntry1);
log.write(logEntry2);

这个 @google-cloud/logging 库将处理批量和调度 这些日志行到 API.

写入 Stdout

这个 LogSync 类帮助用户轻松写入内容丰富的结构日志 stdout 或任何海关运输。 它提取额外的日志属性,例如 从 HTTP 信头中追踪上下文, 并可作为上下切换 写入 API 或 写入 stdout 地方发展时期.

日志写入到 stdout 然后由记录器在程序外进行采集 在相应的GCP环境中的代理人。 日志代理商可以添加更多 属性,然后将其流到日志 API.

更多信息 伐木代理人。 。 。 .

Cloud 函数、 Cloud 运行和 App 引擎等无服务器应用程序 高度建议使用 LogSync 可丢弃async日志的类 由于缺乏CPU.

更多信息 结构化伐木。 。 。 .

// Optional: Create and configure a client
const logging = new Logging();
await logging.setProjectId()
await logging.setDetectedResource()

// Create a LogSync transport, defaulting to `process.stdout`
const log = logging.logSync(logname);
const meta = { // optional field overrides here };
const entry = log.entry(meta, 'Your log message');
log.write(entry);

// Syntax sugar for logging at a specific severity
log.alert(entry);
log.warning(entry);

输入 Http 请求元数据

Http 请求的元数据是 结构化日志信息 可以在每个日志条目中捕捉到。 它可以为应用程序日志和 用于在负载平衡器请求日志下组合多个日志条目。 见 样本 如何输入 Http 请求的日志条目元数据 .

如果你已经有一个"raw" Http request 对象,您可以指定它 entry.metadata.httpRequest 直接说 更多关于 怎么样 request 被解释为原始的,可见于 代码。 。 。 .

自动追踪/扫描ID提取

使用云记录库 追踪日志输入中的字段 能够捕捉到微量背景 日志和痕迹的关联性和分布式追踪故障. 这些追踪领域,包括: 追踪, (中文(简体) ), 宽度,以及 跟踪样本,定义一个 LogEntry。 。 。 .

如果没有在日志输入中明确提供, Cloud 日志库将自动填充 trace, (中文(简体) ), span_id,以及 trace_sampled 字段,来自检测到的 OpenTeleometry 横跨上下文,或来自 HTTP 请求头.

从 OpenTeleometry 上下文提取追踪/扩展 ID

如果您在使用 OpenTeleometry 而 OpenTeleometry 上下文中有一个活动跨度,则 trace, (中文(简体) ), span_id,以及 trace_sampled 字段。 可找到更多关于 OpenTelection 的信息 这里。 。 。 .

从 HTTP 信头中提取 Trace/ span ID

如果未明确提供跟踪字段,也没有检测到OpenTeleometry上下文,则 trace 编号 : span_id 字段自动取自 HTTP 信头. 追踪信息可以从 W3C 追踪母 或者说 X- Cloud- Trace- Context 图像 头.

写入或同步删除日志处理出错

这个 Log 类为用户提供了同步写入和删除日志的能力. 不过,有些情况是记录条目 无法写入或删除, 错误会被丢弃 - 如果错误处理不当, 它可能会崩溃应用程序 . 抓住错误的一个可能方法是 await 日志写入/删除调用并包装 try/catch 例如:

    // Write log entry and and catch any errors
    try {
      await log.write(entry);
    } catch (err) {
      console.log('Error is: ' + err);
    }

然而,在等待每一个 log.write 或者说 log.delete 电话可能会造成延误,可以通过下列方式避免: 只需像下面的例子那样添加回调。 这样日志条目就可以排队处理和代码 将继续执行,不再拖延。 操作完成后, 调用将会被调用 :

    // Asynchronously write the log entry and handle respone or any errors in provided callback
    log.write(entry, err => {
      if (err) {
        // The log entry was not written.
        console.log(err.message);
      } else {
        console.log('No error in write callback!');
      }
    });

添加回调到每个 log.write 或者说 log.delete 电话可能是一个负担,特别是如果代码 处理错误总是相同的。 为此,我们引入了提供默认回调的能力 页:1 Log 可设置的类 LogOptions 转至 Log 如下示例所示的构造器 - 此 您可以一次性定义全球召回 log.write 财务报告和审定财务报表 log.delete 电话和能够处理错误 :

  const {Logging} = require('@google-cloud/logging');
  const logging = new Logging();
  
  // Create options with default callback to be called on every write/delete response or error
  const options = {
    defaultWriteDeleteCallback: function (err) {
      if (err) {
        console.log('Error is: ' + err);
      } else {
        console.log('No error, all is good!');
      }
    },
  };

  const log = logging.log('my-log', options);

完整样本见 writeLogWithCallback 函数 这里。 。 。 .

样本

样本在 samples/ 目录。 每个样本 README.md 有运行样本的指示.

样本源代码试试看
流畅源代码Open in Cloud Shell
日志 HTTP 请求源代码Open in Cloud Shell
日志源代码Open in Cloud Shell
快速启动源代码Open in Cloud Shell
银色源代码Open in Cloud Shell

这个 Cloud 日志节点.js 客户端 API 参考 文档 还包含样品.

支持的节点.js版本

我们的客户端图书馆跟着 节点.js发布时间表。 。 。 . 图书馆兼容所有当前 活动 财务报告和审定财务报表 维修 版本 节点.js. 如果你在使用"节点"(Node.js)的报废版本,我们建议你更新 尽快到积极支持的LTS版本.

Google 的客户端库支持在 a 上的 Node.js runtimes 的遗留版本 以下列警告为依据:

  • 后遗症版本不进行连续整合测试.
  • 一些安全补丁和特性不能被后移植.
  • 依赖关系不能不断更新.

设有针对Node.js的一些报废版本的客户端图书馆,以及 可以通过 npm 安装 秒数。 。 。 . 立面遵循命名惯例 legacy-(version)。 。 。 . 譬如说, npm install @google-cloud/logging@legacy-8 安装客户端库 用于兼容Node.js 8的版本.

版本

这个图书馆跟随 语义版本。 。 。 .

这个图书馆被认为是 稳定。代码表面不会改变向后兼容的方式 除非绝对必要(例如,由于关键的安全问题)或 大量贬值期。 问题和要求 稳定 图书馆 以最高优先处理.

更多信息 : 谷歌云平台启动阶段

捐款

欢迎捐款! 见 贡献指南。 。 。 .

请注意: README.md,则 samples/README.md, (中文(简体) ), 和该寄存器中的各种配置文件(包括 .nycrc 财务报告和审定财务报表 tsconfig.json(中文(简体) ) 从中央模板生成。 要编辑这些文件之一, 请编辑 输入模板 目录。 。 。 .

许可证

Apache 版本 2.0

见 自由主义

版本与发布记录

@google-cloud/logging-min 共发布 56 个版本,首次发布于 2021/05/24;过去 12 个月发布了 2 个版本。

版本发布日期距今
12.1.0latest2026/09/162 个月前
11.2.22026/06/055 个月前
11.2.02024/09/112 年前
10.4.02023/01/313 年前
10.3.32022/12/203 年前
10.3.22022/12/023 年前

关于 @google-cloud/logging-min 的常见问题

@google-cloud/logging-min 是什么?

Cloud 登录节点客户端库

如何安装 @google-cloud/logging-min?

在项目目录运行 npm install @google-cloud/logging-min,或使用 pnpm add / yarn add / bun add。

@google-cloud/logging-min 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@google-cloud/logging-min 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@google-cloud/logging-min 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@google-cloud/logging-min 可以商用吗?

@google-cloud/logging-min 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@google-cloud/logging-min 的下载量有多少?

根据 npm 官方下载统计,@google-cloud/logging-min 在 2026/10/17 – 2026/11/15 这 30 天内被下载 1,719,007 次,日均约 57,300 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@google-cloud/logging-min 还在维护吗?

最新版本 12.1.0 发布于 2026/09/16(2 个月前);至今共发布 56 个版本,其中过去 12 个月发布了 2 个;首次发布于 2021/05/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。