1.0.1 • Published 1 year ago

monitor-report v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

前端日志收集

介绍

一个用来帮助前端收集错误、操作、pv / uv 统计等,采用ts全程编写,一套完整的库 ,适用于 react , vue , 原生html 等前端技术

主要围绕三个维度收集数据

  1. 错误日志
  2. 操作日志埋点
  3. pv / uv 统计

安装教程

npm i monitor-report

使用说明

简单使用

import monitorReport from 'monitor-report'
monitorReport({
  errorOptions: {
    url: "http://127.0.0.1:8888/monitor/error/report",
  },
  mode: "History",
  log: true 
})

成功后日志中会出现成功标识

options

errorOptions 错误配置

type: object | false

default: false

属性说明默认值备注
url上报的后端地址false
asyncErrorOptions待开发
promiseErrorOptions待开发
resourceErrorOptions待开发

behaviorOptions 操作配置

type: object | false

default: false

属性说明默认值备注
url上报的后端地址false

PvUvOptions pvuv配置

type: object | false

default: false

属性说明默认值备注
url上报的后端地址false

mode 路由模式

type: 'Hash' | 'History'

default: 'History'

log 是否打印日志

type: boolean

default: true

isReport 是否上报数据

type: boolean

default: fasle

customFields 自定义上传字段

type: object

default: {}

上报内容

公共数据

属性说明默认值备注
host上报设备 主机
hostname上报设备 主机名
port上报设备 端口
protocol上报设备协议
requestURL上报设备请求地址

错误上报

属性说明默认值备注
message错误信息
name错误名称
rank错误分类"001" ( 普通)|"002" (一般) |"003" (严重 )|"101" 内部错误 101:internalError 001: resourcError, asyncError002: promisError003: requestError
type错误类型internalError(内部异常)| resourcError(资源错误) | promisError(promise 的错误) | requestError (请求错误) | asyncError(普通错误)
url错误地址错误地址根据类型来看, 如果是 async, promise 错误 就是当前页面地址, 若 resourcError 和 requestError 则是错误地址

实例

import monitorReport from 'monitor-report'
monitorReport({
  errorOptions: {
    url: "http://127.0.0.1:8888/monitor/error/report",
  },
  mode: "History",
  log: true 
})

操作上报

属性说明默认值备注
tag操作标签地址
name名字
type类型onclick
text操作按钮名称这个有时候获取不到, 因为我这边只去了button的操作名称,当然你也可以给标签加个自定义属性 data-info 最后这个值最后就给text

注:

提供了两个自定义标签属性 no-use(不触发上报) 、data-info(上报的数据)

实例

import monitorReport from 'monitor-report'
monitorReport({
  behaviorOptions: {
    url: "http://127.0.0.1:8888/monitor/error/report",
  },
  mode: "History",
  log: true 
})

pv uv 上报

属性说明默认值备注
stayTime停留时长
currentPath当前页面
prePath从哪来
type跳转类型'pushState' | 'replaceState' | 'load' | 'unload' | 'popstate'

实例

import monitorReport from 'monitor-report'
monitorReport({
  pvUvOptions: {
    url: "http://127.0.0.1:8888/monitor/error/report",
  },
  mode: "History",
  log: true 
})

自定义上报

实例

import monitorReport from 'monitor-report'
const {errorReporting, behaviorReporting,pvUvReporting }=  monitorReport({
  pvUvOptions: {
    url: "http://127.0.0.1:8888/monitor/error/report",
  },
  mode: "History",
  log: true 
})

errorReporting: 错误上报, 参数同上

behaviorReporting: 操作上报 参数同上

pvUvReporting: pvuv上报 参数同上

1.0.1

1 year ago

0.0.0-test0.0.1

1 year ago

0.0.0-test0.0.2

1 year ago

0.0.0-test0.0.3

1 year ago

0.0.0-bate1.0.0

1 year ago

0.0.0-bate1.5.0

1 year ago

0.0.0-bate1.8.0

1 year ago

0.0.0-bate1.7

1 year ago

0.0.0-bate1.6

1 year ago

0.0.0-bate1.1

1 year ago

0.0.0-bate0.2

1 year ago

0.0.0-bate1.0

1 year ago

0.0.0-bate0.1

1 year ago

0.0.0-bate1.5

1 year ago

0.0.0-bate0.6

1 year ago

0.0.0-bate0.5

1 year ago

0.0.0-bate1.3

1 year ago

0.0.0-bate0.4

1 year ago

0.0.0-bate1.2

1 year ago

0.0.0-bate0.3

1 year ago

0.0.1

1 year ago

0.0.0

1 year ago

0.0.0-bate0.9

1 year ago

0.0.0-bate0.8

1 year ago

0.0.0-bate0.7

1 year ago

1.0.0

5 years ago