首页IT科技全链路追踪traceid(Node.js 应用全链路追踪技术——全链路信息存储)

全链路追踪traceid(Node.js 应用全链路追踪技术——全链路信息存储)

时间2025-09-19 10:44:00分类IT科技浏览4901
导读:作者:vivo 互联网前端团队- Yang Kun...

作者:vivo 互联网前端团队- Yang Kun

本文是上篇文章《Node.js应用全链路追踪技术——全链路信息获取》的后续               。阅读完              ,再来看本文                      ,效果会更佳哦                     。

本文主要介绍在Node.js应用中       ,如何用全链路信息存储技术把全链路追踪数据存储起来       ,并进行相应的展示                      ,最终实现基于业界通用OpenTracing标准的Zipkin的Node.js方案       。

一              、背景

目前业界主流的做法是使用分布式链路跟踪系统               ,其理论基础是来自 Google 的一篇论文 《大规模分布式系统的跟踪系统》               。

论文如下图所示:

(图片来源:网络)

在此理论基础上       ,诞生了很多优秀的实现                     ,如 zipkin                      、jaeger                      。同时为了保证API兼容               ,他们都遵循OpenTracing标准       。那 OpenTracing 标准是什么呢?

OpenTracing翻译为开发分布式追踪,是一个轻量级的标准化层                     ,它位于应用程序/类库和链路跟踪系统之间的一层       。 这一层可以用下图表示:

从上图可以知道                      ,OpenTracing具有以下优势:

统一了API,使开发人员能够方便的添加追踪系统的实现                      。

OpenTracing已进入CNCF              ,正在为全球的分布式链路跟踪系统                      ,提供统一的模型和数据标准              。

大白话解释下:它就像手机的接口标准       ,当今手机基本都是typeC接口              ,这样方便各种手机能力的共用       。因此                      ,做全链路信息存储       ,需要按照业界公认的OpenTracing标准去实现                      。

本篇文章将通过已有的优秀实现 ——zipkin       ,来给大家阐述Node.js应用如何对接分布式链路跟踪系统              。

二       、zipkin

2.1 zipkin 是什么?

zipkin是Twitter基于Google的分布式追踪系统论文的开发实现                      ,其遵循OpenTracing标准。

zipkin用于跟踪分布式服务之间的应用数据链路                      。

2.2 zipkin 架构

官方文档上的架构如下图所示:

为了更好的理解               ,我这边对架构图进行了简化       ,简化架构图如下所示:

从上图可以看到                     ,分为三个部分

第一部分:全链路信息获取               ,我们不使用zipkin自带的全链路信息获取,我们使用zone-context去获取全链路信息

第二部分:传输层                     ,使用zipkin提供的传输api                      ,将全链路信息传递给zipkin

第三部分:zipkin核心功能,各个模块介绍如下:

collector就是信息收集器,作为一个守护进程              ,它会时刻等待客户端传递过来的追踪数据                      ,对这些数据进行验证       、存储以及创建查询需要的索引                     。

storage是存储组件。zipkin默认直接将数据存在内存中       ,此外支持使用ElasticSearch和MySQL               。

search是一个查询进程              ,它提供了简单的JSON API来供外部调用查询                     。

web UI是zipkin的服务端展示平台                      ,主要调用search提供的接口       ,用图表将链路信息清晰地展示给开发人员       。

至此       ,zipkin的整体架构就介绍完了                      ,下面我们来进行zipkin的环境搭建               。

2.3 zipkin 环境搭建

采用docker搭建               , 这里我们使用docker中的docker-compose来快速搭建zipkin环境                      。

docker-compose.yml文件内容如下:

version: 3.8 services: elasticsearch: image: docker.elastic.co/elasticsearch/elasticsearch:7.5.0 container_name: elasticsearch restart: always ports: - 9200:9200 healthcheck: test: ["CMD-SHELL", "curl --silent --fail localhost:9200/_cluster/health || exit 1"] interval: 30s timeout: 10s retries: 3 start_period: 40s environment: - discovery.type=single-node - bootstrap.memory_lock=true - "ES_JAVA_OPTS=-Xms512m -Xmx512m" - TZ=Asia/Shanghai ulimits: memlock: soft: -1 hard: -1 zipkin: image: openzipkin/zipkin:2.21 container_name: zipkin depends_on: - elasticsearch links: - elasticsearch restart: always ports: - 9411:9411 environment: - TZ=Asia/Shanghai - STORAGE_TYPE=elasticsearch - ES_HOSTS=elasticsearch:9200

在上面文件所在的目录下执行docker-compose up -d即可完成本地搭建       。

搭建完成后       ,在浏览器中打开地址 http://localhost:9411                      ,会看到如下图所示页面:

接着打开地址 http://localhost:9200               ,会看到如下图所示页面:

至此,zipkin的本地环境就搭建好啦       。 下面我就将介绍Node.js应用如何对接zipkin                      。

三                      、Node.js 接入 zipkin

3.1 搞定全链路信息获取

这个我在 《Node.js 应用全链路追踪技术——全链路信息获取》 文章中                     ,已经详细阐述了                      ,如何去获取全链路信息              。

3.2 搞定传输层

因为zipkin是基于OpenTracing标准实现的       。因此我们只要搞定了zipkin的传输层,也就搞定了其他主流分布式追踪系统                      。

这里我们用到了zipkin官方提供的两个npm包              ,分别是:

zipkin

zipkin-transport-http

zipkin包是官方对支持 Node.js的核心包              。zipkin-transport-http包的作用是将数据通过HTTP异步发送到 zipkin。

下面我们将详细介绍在传输层                      ,如何将将数据发送到zipkin                      。

3.3传输层基础封装

核心代码实现和相关注释如下:

const { BatchRecorder, Tracer, // ExplicitContext, jsonEncoder: { JSON_V1, JSON_V2 }, } = require(zipkin) const { HttpLogger } = require(zipkin-transport-http) // const ctxImpl = new ExplicitContext(); // 配置对象 const options = { serviceName: zipkin-node-service, targetServer: 127.0.0.1:9411, targetApi: /api/v2/spans, jsonEncoder: v2 } // http 方式传输 async function recorder ({ targetServer, targetApi, jsonEncoder }) => new BatchRecorder({ logger: new HttpLogger({ endpoint: `${targetServer}${targetApi}`, jsonEncoder: (jsonEncoder === v2 || jsonEncoder === V2) ? JSON_V2 : JSON_V1, }) }) // 基础记录 const baseRecorder = await recorder({ targetServer: options.targetServer targetApi: options.targetApi jsonEncoder: options.jsonEncoder })

至此       ,传输层的基础封装就完成了              ,我们抽离了baseRecorder出来                      ,下面将会把全链路信息接入到传输层中                     。

3.4 接入全链路信息

这里说下官方提供的接入SDK,代码如下:

const { Tracer } = require(zipkin) const ctxImpl = new ExplicitContext() const tracer = new Tracer({ ctxImpl, recorder: baseRecorder }) // 还要处理请求头               、手动层层传递等事情

上面的方式缺点比较明显       ,需要额外去传递一些东西       ,这里我们使用上篇文章提到的Zone-Context                      , 代码如下:

const zoneContextImpl = new ZoneContext() const tracer = new Tracer({ zoneContextImpl, recorder: baseRecorder }) // 仅此而已               ,不再做额外处理

对比两者       ,明显发现                     ,Zone-Context的实现方式更加的隐式               ,对代码入侵更小。这也是单独花一篇文章介绍Zone-Context技术原理的价值体现               。

自此,我们完成了传输层的适配                     , Node.js应用接入zipkin的核心步骤基本完成                     。

3.5 搞定 zipkin 收集       、存储                     、展示

这部分中的收集               、展示功能                      ,zipkin官方自带完整实现,无需进行二次开发       。存储这块              ,提供了MySQL、Elasticsearch 等接入方式               。可以根据实际情况去做相应的接入                      。本文采用 docker-compose集成了ElasticSearch       。

四                     、总结

自此                      ,我们已经完成基于业界通用OpenTracing标准实现的zipkin的 Node.js方案       。希望大家看完这两篇文章       ,对 Node.js全链路追踪              ,有一个整体而清晰的认识                      。

参考资料:

zipkin 官网

声明:本站所有文章                      ,如无特殊说明或标注       ,均为本站原创发布              。任何个人或组织       ,在未征得本站同意时                      ,禁止复制                      、盗用、采集              、发布本站内容到任何网站                      、书籍等各类媒体平台       。如若本站内容侵犯了原著者的合法权益               ,可联系我们进行处理                      。

创心域SEO版权声明:以上内容作者已申请原创保护,未经允许不得转载,侵权必究!授权事宜、对本内容有异议或投诉,敬请联系网站管理员,我们将尽快回复您,谢谢合作!

展开全文READ MORE
win10怎么开启护眼(Win10专业版如何开启护眼模式?)