# @aliyun-sls/web-track-browser 中文文档
规范地址：https://npmcn.com/package/%40aliyun-sls/web-track-browser/
版本：0\.3\.9
npm 元数据更新时间：2025-04-07T06:33:00.799Z
中文译文更新时间：2026-11-05T20:30:32.421Z
软件包许可：未声明
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40aliyun-sls/web-track-browser
原文对照：https://npmcn.com/package/%40aliyun-sls/web-track-browser/?lang=original
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：21.5 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2022-05-05T08:21:49.885Z
- 最新版本发布：2024-12-25T09:32:29.006Z
- 近 30 天下载量：26893（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 0 个）
## 中文简介
## 背景信息
## 安装
```sh
npm install @aliyun-sls/web-track-browser
```
也可以使用：`pnpm add @aliyun-sls/web-track-browser`、`yarn add @aliyun-sls/web-track-browser`、`bun add @aliyun-sls/web-track-browser`
## README
# SLS WebTracking JavaScript SDK
## 背景信息
Web Tracking 可以采集各种浏览器、iOS APP 或 Android APP 的用户信息，例如：
- 用户使用的浏览器、操作系统、分辨率等信息。
- 用户浏览行为记录（例如：用户在网站上的单击行为、购买行为等）。
- 用户在 APP 中的停留时间、是否活跃等。
## 适用平台
@aliyun-sls/web-track-browser 只支持浏览器端。
小程序参见 [@aliyun-sls/web-track-mini](https://www.npmjs.com/package/@aliyun-sls/web-track-mini)
## 注意事项
- 使用 Web Tracking 则表示该 Logstore 打开互联网匿名写入权限，没有经过有效鉴权，可能产生脏数据。
- POST 请求每次写入的日志数量上限为 3MB 或者 4096 条，详情请参见[PutLogs](https://help.aliyun.com/document_detail/29026.%5Dhtml#reference-a5t-kxr-zdb)。
## 数据采集
控制台配置
1. 登录[日志服务控制台](https://sls.console.aliyun.com/)。
2. 单击目标 Project。
3. 找到目标 Logstore，单击下的**修改**。
4. 在**Logstore 属性**页面，单击右上方的**修改**。
5. 打开**WebTracking**开关，并单击**保存**。
通过 SDK 采集数据
**1.安装依赖包**
```javascript
npm install --save @aliyun-sls/web-track-browser
```
**2.`import`在您的应用程序模块。**
```javascript
import SlsTracker from '@aliyun-sls/web-track-browser'
```
**3.使用CDN包(注意修改版本号)**
```
window.SLS_Tracker &&
new SLS_Tracker({
project: 'xxx',
logstore: 'xxx',
host: 'xxx',
})
```
**4.配置参数 opts。**
| **参数** | **说明** | **是否填写** |
| :-: | :-: | :-: |
| **host** | **日志服务所在地域的 Endpoint，详情请参见**[**服务入口**](https://help.aliyun.com/document_detail/29008.html#reference-wgx-pwq-zdb)。支持自定义域名，此时 host 格式为 https://自定义域名 或者 http://自定义域名 | **必填** |
| **project** | **控制台创建的 project 名称。** | **必填** |
| **logstore** | **控制台创建的 logstore 名称。** | **必填** |
| **time** | **发送消息的时间间隔,数据格式为 Number 的方式,time\*1000(毫秒)。** | **选填(默认是 10 秒)** |
| **count** | **发送消息的数量大小,数据格式为 Number 的方式。** | **选填(默认是 10 条数据)** |
| **topic** | **日志主题。** | **选填, string** |
| **source** | **日志来源。** | **选填, string** |
| **tags** | **日志标签。** | **选填, Record** |
```javascript
const opts = {
host: '${host}', // 所在区域的host
project: '${project}', // project名称
logstore: '${logstore}', // logstore名称
time: 10, // 定义时间，默认是10秒，number类型，选填
count: 10, // 定义数据条数，默认是10条，number类型，选填
topic: 'topic',
source: 'source',
tags: {
tags: 'tags',
},
}
```
**5.创建 SlsTracker 对象。**
```javascript
const tracker = new SlsTracker(opts)
```
**6.上传日志。**
```javascript
tracker.send({
customer: 'zhangsan',
product: 'iphone 12',
price: 7998,
})
```
## 核心功能
**send()**
说明: 单条数据上传。
参数：Object 类型
示例：
```javascript
tracker.send({
customer: 'zhangsan',
product: 'iphone 12',
price: 7998,
})
```
**sendImmediate()**
说明: 单条数据立即上传，time 和 count 参数此时配置不生效。
参数：Object 类型
示例：
```javascript
tracker.sendImmediate({
customer: 'zhangsan',
product: 'iphone 12',
price: 7998,
})
```
**sendBatchLogs()**
说明: 批量数据上传。
参数：Object 类型
示例：
```javascript
tracker.sendBatchLogs([
{
customer: 'zhangsan',
product: 'iphone 12',
price: 7998,
},
{
customer: 'zhangsan',
product: 'iphone 12',
price: 7998,
},
])
```
**sendBatchLogsImmediate()**
说明: 批量数据上传，time 和 count 参数此时配置不生效。
参数：Object 类型
示例：
```javascript
tracker.sendBatchLogsImmediate([
{
customer: 'zhangsan',
product: 'iphone 12',
price: 7998,
},
{
customer: 'zhangsan',
product: 'iphone 12',
price: 7998,
},
])
```
## 常见问题
### @aliyun-sls/web-track-browser 是什么？
背景信息
### 如何安装 @aliyun-sls/web-track-browser？
在项目目录运行 npm install @aliyun-sls/web-track-browser，或使用 pnpm add / yarn add / bun add。
### @aliyun-sls/web-track-browser 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
### @aliyun-sls/web-track-browser 支持 ESM 还是 CommonJS？
同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。
### @aliyun-sls/web-track-browser 可以商用吗？
@aliyun-sls/web-track-browser 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。
### @aliyun-sls/web-track-browser 的下载量有多少？
根据 npm 官方下载统计，@aliyun-sls/web-track-browser 在 2026/10/06 – 2026/11/04 这 30 天内被下载 26,893 次，日均约 896 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
### @aliyun-sls/web-track-browser 还在维护吗？
最新版本 0\.3\.9 发布于 2024/12/25（1\.9 年前）；至今共发布 25 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/05/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。