@google-cloud/trace-agent

中文文档
8.0.0发布于 2024/02/08Apache-2.0TypeScriptCommonJS近 30 天下载 40.9万

StackDriver Trace 的节点.js 支持

此软件包已被标记为弃用

This package is deprecated. We encourage users to use https://opentelemetry.io/docs/languages/js/libraries/ instead

中文使用文档
文档目录15 节
  1. 快速启动
  2. 在你开始之前
  3. 安装客户端库
  4. 使用量
  5. 追踪的是什么
  6. 追踪其他模块
  7. 自定义追踪 API
  8. 访问 API
  9. 自动追踪如何运作?
  10. 追踪被捆绑或网络包装的服务器代码.
  11. 样本
  12. 支持的节点.js版本
  13. 版本
  14. 捐款
  15. 许可证

Google Cloud Platform logo

云追踪:节点.js客户端

release level npm version

StackDriver Trace 的节点.js 支持

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

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

目录 :

快速启动

在你开始之前

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

安装客户端库

npm install @google-cloud/trace-agent

3⁄4 ̄ ̧漯B

cloud-trace-nodejs 处于维护状态。 这表示我们将继续修复虫子 添加安全补丁。 我们将考虑合并新的功能贡献(取决于 (a) 与预计维修费用有关的费用。 但我们不会自己开发出新的功能.

特别是,我们不支持新的主要图书馆.

我们鼓励用户迁移到 OpenTeleometry JS 仪器 换句话说.

这个模块为Cloud Trace的Node.js应用程序提供自动追踪. 云迹 是一个特征 谷歌云平台 从应用程序中收集延迟数据(跟踪),并在 谷歌云控台。 。 。 .

Cloud Trace Overview

使用量

Trace Agent支持节点8+.

说明: 使用 Trace Agent 需要一个 Google Cloud 工程, 并使用 启用 Cloud Trace API 以及相关的全权证书。 如果应用程序运行在Google Cloud平台上,这些值会被自动检测出. 如果您的应用程序不是运行在 GCP 上, 您需要通过配置对象指定工程 ID 和 证书, 或者使用环境变量 。 见 为节点.js建立云轨 更多细节.

说明: Trace Agent目前没有与Google Cloud函数(或Firebase Cloud函数)的外出操作. 见 725号 关于追踪问题和如何围绕这个问题开展工作的细节.

仅要求并启动 Trace Agent 作为您应用程序的第一个模块:

require('@google-cloud/trace-agent').start();
// ...

如果你想使用的话 import,您需要进行下列工作来导入所有所需的类型:

import * as TraceAgent from '@google-cloud/trace-agent';

你可以选择通过一个 配置对象 页:1 start() 函数如下:

require('@google-cloud/trace-agent').start({
  samplingRate: 5, // sample 5 traces per second, or at most 1 every 200 milliseconds.
  ignoreUrls: [ /^\/ignore-me/ ] // ignore the "/ignore-me" endpoint.
  ignoreMethods: [ 'options' ] // ignore requests with OPTIONS method (case-insensitive).
});
// ...

该天体由 start() 可用于创建 自定义痕量跨度数字 :

const tracer = require('@google-cloud/trace-agent').start();
// ...

app.get('/', async () => {
  const customSpan = tracer.createChildSpan({name: 'my-custom-span'});
  await doSomething();
  customSpan.endSpan();
  // ...
});

追踪的是什么

追踪剂可以自动追踪下列网络框架:

该代理也会自动从以下模块中追踪RPC:

你可以用这个 自定义追踪 API 以追踪应用程序中的其他模块.

请求为本列表以外的模块提供自动追踪支持,请 提交问题。或者,你可以 自己写插件。 。 。 .

追踪其他模块

要装入额外的插件, 请在代理配置中指定 :

require('@google-cloud/trace-agent').start({
  plugins: {
    // You may use a package name or absolute path to the file.
    'my-module': '@google-cloud/trace-agent-plugin-my-module',
    'another-module': path.join(__dirname, 'path/to/my-custom-plugins/plugin-another-module.js')
  }
});

此插件列表会与内置插件列表合并,由插件加载器加载. 每个插件只有在其补丁的模块被加载时才会被加载;换句话说,没有用于列出未用模块插件的计算间接费用.

自定义追踪 API

自定义跟踪 API 可用于创建自定义跟踪跨度. A 类 间距 是追踪中的特定工作单位,例如RPC请求. Spans可能筑巢;最外侧的跨度称为a 根间距即使没有巢中的孩子横跨。 根跨通常与收到的请求相对应,而 儿童间距 通常对应发出的请求,或者响应收到的请求而触发的其他工作. 这意味着根间距不应该在已经存在根间距的上下文中创建;在这里,孩子间距更合适. 相反地,应当建立根跨来跟踪在请求生命周期之外完全发生的工作,例如定期排定的工作。 举例说明:

const tracer = require('@google-cloud/trace-agent').start();
// ...

app.get('/', (req, res) => {
  // We are in an automatically created root span corresponding to a request's
  // lifecycle. Here, we can manually create and use a child span to track the
  // time it takes to open a file.
  const readFileSpan = tracer.createChildSpan({ name: 'fs.readFile' });
  fs.readFile('/some/file', 'utf8', (err, data) => {
    readFileSpan.endSpan();
    res.send(data);
  });
});

// For any significant work done _outside_ of the request lifecycle, use
// runInRootSpan.
tracer.runInRootSpan({ name: 'init' }, rootSpan => {
  // ...
  // Be sure to call rootSpan.endSpan().
});

对于我们提供的任何网络框架 内建插件,当收到收到的请求时,会自动启动根间距(换言之,所有中间软件已经在根间距内运行)。 如果您想要在其中任何一个框架之外记录一段间距,任何被追踪的代码都必须在您创建的根间距内运行.

访问 API

呼叫电话 start 函数返回实例 Tracer,它提供了追踪的接口:

const tracer = require('@google-cloud/trace-agent').start();

它也可以通过以后的电话检索到 get 其他地方:

// after start() is called
const tracer = require('@google-cloud/trace-agent').get();

A 类 Tracer 对象被这两个调用保证返回,即使代理已禁用.

全面详细概述 Tracer 对象可用 这里。 。 。 .

自动追踪如何运作?

Trace Agent 自动补丁了众所周知的模块,将调用插入到启动,标签和结束等函数上,以测量 RPC (如 mysql, redis等) 和来取请求(如快取,popi等)的延迟度. 由于每项保护责任通常都是代表收到的请求执行的,我们必须确保这种关联在跨度数据中得到准确反映。 为了提供一种统一、笼统的追踪RPC所属的来函请求的方法,我们依赖 async_hooks 以跟踪跨越同步边界的"跟踪上下文".

async_hooks 在大多数情况下,效果很好。 然而,它确实有一些限制,可以阻止我们适当传播追踪背景:

  • 一个模块有可能自行排出调用函数的队列 — — 有效地将同步执行环境合并起来。 例如,人们可能写一个 http 请求缓冲库, 将请求排入队列, 然后在一个镜头中分批进行 。 在这种情况下,当所有的回调都起火时,它们将在冲出队列的上下文中执行,而不是在队列中添加回调的上下文. 这个问题叫做集合问题或 用户空间排队问题,也是JavaScript的一个基本限制. 如果您的应用程序使用这样的代码, 您将会注意到许多请求中的 RPC 正在以单一的跟踪显示, 或者您出局的 RPC 的某些部分没有被追踪 。 在这种情况下,我们试图通过猴子补丁来绕过这个问题,或者通过与图书馆作者合作来修正代码以正确传播上下文. 然而,找到有问题的代码并不总是微不足道的.
  • 这个 async_hooks API已经 问题跟踪背景 周围 await——"可证明"(而不是真实的承诺). 请求发自 then 在这样的用户空间中“可验证”的执行可能无法被跟踪。 这在很大程度上是一个非常规案例,但存在于 knex 模块, 用于调用蓝鸟承诺的原型. 使用时 knex (英文: raw 函数),参见 946号 关于您是否受到影响的更详细信息,以及建议的工作.

追踪被捆绑或网络包装的服务器代码.

不支持

Trace Agent 不支持捆绑的服务器代码,因此捆绑者如webpack或@zeit/nc不会工作.

样本

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

样本源代码试试看
应用源代码Open in Cloud Shell
片断源代码Open in Cloud Shell

这个 Cloud Trace Node.js 客户端 API 参考 文档 还包含样品.

支持的节点.js版本

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

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

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

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

版本

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

这个库被认为是在 预览这意味着它仍然是 工作正在进行中,正在积极发展。 任何释放均须遵守 随时向后不相容的变化.

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

捐款

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

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

许可证

Apache 版本 2.0

见 自由主义

版本与发布记录

@google-cloud/trace-agent 共发布 67 个版本,首次发布于 2017/03/02;过去 12 个月发布了 0 个版本。

版本发布日期距今
8.0.0latest2024/02/082 年前
7.1.22022/09/264 年前
7.1.12022/08/304 年前
7.1.02022/08/114 年前
7.0.02022/08/114 年前
5.1.6legacy-102021/11/164 年前

其他发布通道:legacy-8 → 4.2.5,next → 5.0.0-beta.0,legacy-10 → 5.1.6。

关于 @google-cloud/trace-agent 的常见问题

@google-cloud/trace-agent 是什么?

StackDriver Trace 的节点.js 支持注意:该包已被作者标记为弃用——This package is deprecated. We encourage users to use https://opentelemetry.io/docs/languages/js/libraries/ instead

如何安装 @google-cloud/trace-agent?

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

@google-cloud/trace-agent 支持 TypeScript 吗?

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

@google-cloud/trace-agent 支持 ESM 还是 CommonJS?

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

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

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

@google-cloud/trace-agent 可以商用吗?

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

@google-cloud/trace-agent 的下载量有多少?

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

@google-cloud/trace-agent 还在维护吗?

最新版本 8.0.0 发布于 2024/02/08(2 年前);至今共发布 67 个版本,其中过去 12 个月发布了 0 个;首次发布于 2017/03/02。作者已将其标记为弃用,新项目建议寻找替代方案。