Merge branch 'release/docs'

Author: free100year

docs/sdk.md

@@ -57,7 +57,7 @@ const consoleErrorPlugin: BasePluginType<BrowserErrorTypes, BrowserClient> = {
             notify(BrowserErrorTypes.CE, args); // 将一阶段处理结果通过notify进行订阅
         };
     },
-    transform(args: any[]) { // use 中 watch 进行消息发布
+    transform(args: any[]) { // 参数格式转化,得到 最终格式的 上传数据
         const _reportData:ReportErrorData = {
             type: 'error',
             subType: BrowserErrorTypes.CE,
@@ -72,7 +72,7 @@ const consoleErrorPlugin: BasePluginType<BrowserErrorTypes, BrowserClient> = {
         };
         return _reportData;
     },
-    consumer(reportData: ReportErrorData) { // use 中 watch 进行消息发布
+    consumer(reportData: ReportErrorData) { // use 中 watch 进行消息发布, 观察者模式消费者进行消费
         this.report.send(reportData, true);
     }
 };

packages/browser/README.md

@@ -14,12 +14,46 @@ import { init } from '@qmonitor/browser';
 
 init({
     url: 'http://localhost:8083/reportData',
-    appName: '直客',
-    appID: 'zhike',
+    appName: '七猫',
+    appID: 'qimao',
     cacheNum: 10,
     vue: {
         Vue,
         router
     }
 });
 ```
+
+## api
+```js
+{   
+    url?: string; // 上报地址
+    appID?: string; // 项目ID
+    appName?: string; // 项目名称
+    userID?: string; // 用户ID
+    cacheNum?:number; // 缓存数据
+    sample?: number; // 采样率
+    vue?: { // vue项目需要
+        Vue?: VueInstance,
+        router?: VueRouter
+    }
+    disabledConsoleError?: boolean; // 是否禁止监控 控制台错误, 默认是false
+    disabledJsError?: boolean; // 是否禁止监控 JsError, 默认是false
+    disabledPromiseError?: boolean; // 是否禁止监控  PromiseError, 默认是false
+    disabledResourceError?: boolean; // 是否禁止监控  资源加载错误, 默认是false
+    disabledFirstPaint?: boolean; // 是否禁止监控 首次绘制, 默认是false
+    disabledFirstContentfulPaint?: boolean; // 是否禁止监控 首次有效绘制, 默认是false
+    disabledLargestContentfulPaint?: boolean; // 是否禁止监控 最大内容绘制, 默认是false
+    disabledFirstInputDelay?: boolean; // 是否禁止监控  首次输入延迟, 默认是false
+    disabledCumulativeLayoutShift?: boolean; // 是否禁止监控 绘画偏移分数, 默认是false
+    disabledNavigation?: boolean; // 是否禁止监控 页面关键时间点, 默认是false
+    disabledResource?: boolean; // 是否禁止监控 资源文件, 默认是false
+    disabledFetch?: boolean; // 是否禁止监控 api, 默认是false
+    disabledXhr?: boolean; // 是否禁止监控 api, 默认是false
+    disabledFirstMeaningPaint? : boolean; // 是否禁止监控 首次有效绘制, 默认是false
+    // 钩子方法
+    configReportXhr?(xhr: XMLHttpRequest, reportData: any): void // 钩子函数，配置发送到服务端的xhr, 一般浏览器使用beacon, 所以用不到
+    beforeDataReport?(event: ReportBaseInfo):Promise<ReportBaseInfo | CANCEL> | ReportBaseInfo | any | CANCEL // 在每次发送事件前会调用, 可自定义对上传数据进行更改
+    beforeAppAjaxSend?(config: IRequestHeaderConfig, setRequestHeader: IBeforeAppAjaxSendConfig): void // 拦截用户页面的ajax请求，并在ajax请求发送前执行该hook
+}
+```

packages/browser/src/index.ts

@@ -15,16 +15,20 @@ import { consoleErrorPlugin,
     navigationPlugin,
     resourceErrorPlugin} from './plugins';
 import { on_beforeunload, sampling, _global } from '@qmonitor/utils';
+import { BrowserEventTypes } from '@qmonitor/enums';
 
 function create_browser_instance(options:BrowserOptionsType = {}, plugins: BasePluginType[] = []) {
     const _browserClient = new BrowserClient(options);
     const _sample = _browserClient.getOptions().sample;
-    if (sampling(_sample)) {
-        const _browserPlugin = [
-            consoleErrorPlugin,
-            jsErrorPlugin,
-            resourceErrorPlugin,
-            promiseErrorPlugin,
+    let _browserPlugin:BasePluginType<BrowserEventTypes, BrowserClient>[] = [
+        consoleErrorPlugin,
+        jsErrorPlugin,
+        resourceErrorPlugin,
+        promiseErrorPlugin
+    ];
+    if (sampling(_sample)) { // 抽样上报
+        _browserPlugin = [
+            ..._browserPlugin,
             xhrPlugin,
             fetchPlugin,
             clsPlugin,
@@ -35,7 +39,6 @@ function create_browser_instance(options:BrowserOptionsType = {}, plugins: BaseP
             resourcePlugin,
             navigationPlugin
         ];
-        _browserClient.use([..._browserPlugin, ...plugins]);
         const _callback = () => {
             const _data = _browserClient.report.queue.get_cache();
             if (_data.length > 0) {
@@ -46,6 +49,7 @@ function create_browser_instance(options:BrowserOptionsType = {}, plugins: BaseP
         on_beforeunload(_global, _callback); // 当页面关闭前，将剩余所有数据进行上报
         return _browserClient;
     }
+    _browserClient.use([..._browserPlugin, ...plugins]);
     return;
 }