# bonree-log-jsagent

> 采集browser中日志数据

Latest version **1.0.4** (published 2026-08-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install bonree-log-jsagent
pnpm add bonree-log-jsagent
yarn add bonree-log-jsagent
bun add bonree-log-jsagent
```

## Health

**Score 50/100 (C)** — status: active.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2026-08-13 |
| First published | 2023-04-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 60.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | @DEM/js-agent |
| Maintainers | bonreejsagent |
| Keywords | log, agent, dem-js, data-collection |

## Links

- npm: https://www.npmjs.com/package/bonree-log-jsagent
- npm.io page: https://npm.io/package/bonree-log-jsagent

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.0.4 (latest) — 2026-08-13
- 1.0.3 — 2025-02-27
- 1.0.2 — 2024-11-13
- 1.0.1 — 2023-05-25
- 1.0.0 — 2023-04-20

## README

# bonree-log-jsagent

bonreelog用于采集browser中的日志数据，bonreelog可自动采集上报网络错误、js错误、控制台console输出的日志数据及自定义的日志数据。

### 如何使用

- 安装

  ```js
  npm install bonree-log-jsagent --save
  ```

- 导出

  ```js
  import { BRLogStart } from 'bonree-log-jsagent'
  ```

- 初始配置

  ```js
  BRLogStart({
      appID:'b5a8ce5e-a3a8-11ed-b908-0e832fe4bb04',
      uploadAddrHttp:'http://oneupload.bonree.com/logs/otel/v1/logs',
      uploadAddrHttps:'https://oneupload.bonree.com/logs/otel/v1/logs',
  })
  ```

- 代码中使用

  ```js
  window.BRLog&&window.BRLog.logger.info('this is a log from web')
  ```

### 配置

| 属性             | 值                                    | 默认值 | 必填 | 描述                                                         |
| ---------------- | ------------------------------------- | ------ | ---- | ------------------------------------------------------------ |
| appID            | string                                | 无     | 是   | 账号标识                                                     |
| uploadAddrHttp   | string                                | 无     | 是   | 数据上传地址，与uploadAddrHttps需配置其一。http页面需配置uploadAddrHttp |
| uploadAddrHttps  | string                                | 无     | 是   | 数据上传地址，与uploadAddrHttp需配置其一。https页面需配置uploadAddrHttps |
| uploadPeriod     | string                                | 15     | 否   | 上报频率 单位:秒                                             |
| enable           | boolean                               | true   | 否   | 控制探针开启，默认开启                                       |
| debug            | boolean                               | false  | 否   | 是否开启logger输出，开启debug模式，默认关闭                  |
| consoleCollector | ['log','info','debug','warn','error'] | []     | 否   | 配置是否采集console.log\| info \| debug \| warn \|error的日志数据，默认关闭 |
| netCollector     | boolean                               | false  | 否   | 配置是否采集网络错误数据，默认关闭                           |
| errorCollector   | boolean                               | false  | 否   | 配置是否采集JS错误数据，默认关闭                             |

> 注：如果页面中使用了bonree的js探针，且无法保证js探针在log之前初始化，请勿配置netCollector和errorCollector，否则将导致error或network数据缺失

### 日志级别

| level | status |
| ----- | ------ |
| debug | 0      |
| info  | 1      |
| warn  | 2      |
| error | 3      |

### 用法

##### 自定义日志

bonreeLog初始化成功后，使用API直接向平台发送自定义日志，支持传入message自定义日志数据，支持传入Error对象

```js
logger.debug | info | warn | error (message: string,error?: Error)
```

###### 用例

```js
try {
  ...
  throw new Error('Wrong behavior')
  ...
} catch (error) {
  window.BRLog&&window.BRLog.logger.error('Error occurred', error)
}
```

##### 完全自定义日志

bonreeLog初始化成功后，使用API直接向平台发送自定义日志，支持自定义日志级别（debug、info、warn、error），支持传入message自定义日志数据，支持传入Error对象，支持自定义属性attribute，attribute仅支持传入{key:value,...}格式对象

```js
logger.log (level:'debug'|'info'|'warn'|'error', message: string ,error?: Error ,attribute?:object)
```

###### 用例

```js
try {
  ...
  throw new Error('Minor misbehavior')
  ...
} catch (error) {
  window.BRLog&&window.BRLog.logger.log('info', 'Minor misbehavior occurs',error,{JSON:'JSON parsing failed'})
}
```

### 高级用法

##### 过滤日志

bonreeLog初始化成功后，使用 API 设置记录的最低日志级别，低于该日志级别的日志数据将被过滤

```js
setLevel (level: 'debug' | 'info' | 'warn' | 'error')
```

###### 用例

```js
 window.BRLog&&window.BRLog.logger.setLevel('info')
```

##### 设置日志前缀

bonreeLog初始化成功后，使用 API 设置日志前缀名

```js
setPrefix('bonree')
```

###### 用例

```js
window.BRLog&&window.BRLog.logger.setPrefix('bonree')
```

##### 添加属性

bonreeLog初始化成功后，使用 API 记录添加全局日志属性

```js
addAttribute(key:string,value:string)
```

###### 用例

```js
 window.BRLog&&window.BRLog.addAttribute('original','logger')
```

##### 移除属性

bonreeLog初始化成功后，使用 API 记录移除全局日志属性

```js
removeAttribute(key:string)
```

###### 用例

```js
window.BRLog&&window.BRLog.removeAttribute('original')
```

---
_Source: https://npm.io/package/bonree-log-jsagent · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
