Skip to content

Latest commit

 

History

History
161 lines (107 loc) · 3.42 KB

README.zh-CN.md

File metadata and controls

161 lines (107 loc) · 3.42 KB
Raw

LiteMonitor

适用于 Node.js 和网络浏览器的数据埋点库

开发者总是希望能够获取软件运行时信息以便帮助他们进行迭代，而数据埋点有助于更好地采集和分析运行时数据。一个优秀的数据埋点库可以让这一切变得更加简单。

本项目包含以下内容：

  • 基础的数据埋点库，提供最大的灵活性和完整的事件定义
  • 适用于 Node.js 的数据埋点库，包含对 Express 和 Koa 的额外支持
  • 适用于网络浏览器的数据埋点库，包含对 React 的额外支持
  • 一些使用数据埋点库的工作示例，包括 Express 示例、Koa 示例和 React 示例
  • 处理数据埋点所得数据的软件系统，包括前端和后端

内容列表

背景

LiteMonitor 始于一个数据库在线考试实时监控系统。在开发该系统的过程中，我发现需要一个能够满足以下特性的数据埋点库：

  • 轻量级
  • 低侵入性
  • 定义良好
  • 兼容优秀

于是，我构建了一个 JavaScript 库并发布到 npm registry 上。2021 年 4 月，我开始开发项目的 1.0 版本。

安装

数据埋点库

它使用 Node.js 和它的包管理器。请确保本地安装了它们。

$ npm install @lite-monitor/base

或者

$ yarn add @lite-monitor/base

或者

$ pnpm add @lite-monitor/base

要获得对 Node.js 的更多支持：

$ npm install @lite-monitor/node

或者

$ yarn add @lite-monitor/node

或者

$ pnpm add @lite-monitor/node

要获得对网络浏览器的更多支持：

$ npm install @lite-monitor/web

或者

$ yarn add @lite-monitor/web

或者

$ pnpm add @lite-monitor/web

处理数据埋点所得数据的软件系统

它使用 Node.js 和 pnpm 工具。请确保本地安装了它们。

$ git clone https://github.com/peidongxie/lite-monitor
$ cd lite-monitor
$ pnpm install

使用

数据埋点库

它可以在 CommonJS 项目和 ESM 项目中使用。请参考示例。

处理数据埋点所得数据的软件系统

它可以以生产模式或开发模式启动。

对于生产模式：

$ pnpm build:app
$ pnpm start:app

对于开发模式：

$ pnpm dev:app

示例

本项目提供一些使用数据埋点库的工作示例。

相关工作

维护者

@peidongxie

如何贡献

欢迎提 issue 或 PR。

使用许可

MIT © 谢沛东