1 Star 6 Fork 7

前端代码工具库 / rebugger

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

项目说明

rebugger-embed: 埋点项目

可以收集系统捕获异常和手动上报数据、其中异常包括 unCaught 自动捕获js异常、httpError 接口异常、sourceError 静态资源加载

异常、unhandledRejection 未处理promise异常 handledRejection 已处理promise异常 caught 手动上报异常 warn 手动上报警 

告信息、info 手动上报日志信息

rebugger-service: 接口服务项目

所用技术 koa2 + typescript + mysql + redis + sequelize + jwt + pm2 + memory-cache(本地缓存和redis可以随时切换)

rebugger-admin: 控制台项目

vue2 + vuex + vue-router + element-ui + echarts 等技术

rebugger-schedule: 定时任务项目 用于报表统计等任务开发

待补充、可用于用于分析、浏览器设备占比分析、地区分析、操作系统分析、屏幕大小占比分析、等前端决策性数据

该项目为本人业余时间从0开始纯手写项目、项目已在公司多项目中实践,已收集百万异常数据和日志数据,为多项目提前发现大量异常点,保证了项目的稳定和质量

埋点接入

静态文件脚本引入

// 获取城市信息 必须引入
<script src="http://pv.sohu.com/cityjson?ie=utf-8"></script>
// 埋点引入
<script id="rebugger" useCustomField="true" silentDev="false" reportMode="onError" apikey="API-KEY"
 src="/static/js/front_rebugger.min.js" crossorigin="anonymous"></script>

动态引入

// 获取城市信息 必须引入
<script src="http://pv.sohu.com/cityjson?ie=utf-8"></script>
// 动态埋点引入
<script type="text/javascript">

function loadScript(url, apikey) {
    var script = document.createElement("script");
    script.type = "text/javascript";
    script.src = url;
    script.setAttribute("id", "rebugger");
    script.setAttribute("apikey", apikey);
    script.setAttribute("reportMode", "onError");
    document.body.appendChild(script);
}

loadScript("/static/js/front_rebugger.min.js", "API-KEY")
</script>

项目控制台截图

解决github图片不显示问题

解决方法,打开路径C:\Windows\System32\drivers\etc下的hosts文件 添加如下地址

# GitHub Start 
192.30.253.112 github.com
192.30.253.119 gist.github.com
151.101.184.133 assets-cdn.github.com
151.101.184.133 raw.githubusercontent.com
151.101.184.133 gist.githubusercontent.com
151.101.184.133 cloud.githubusercontent.com
151.101.184.133 camo.githubusercontent.com
151.101.184.133 avatars0.githubusercontent.com
151.101.184.133 avatars1.githubusercontent.com
151.101.184.133 avatars2.githubusercontent.com
151.101.184.133 avatars3.githubusercontent.com
151.101.184.133 avatars4.githubusercontent.com
151.101.184.133 avatars5.githubusercontent.com
151.101.184.133 avatars6.githubusercontent.com
151.101.184.133 avatars7.githubusercontent.com
151.101.184.133 avatars8.githubusercontent.com

修改hosts文件后,刷新githab页面

埋点属性

埋点属性提供了apikey 、环境禁用设置、异常上传模式、自定义字段收集等配置信息

属性配置方式,只需要将配置script标签属性即可 例如:

  <script id="rebugger" useCustomField="true" silentDev="false" reportMode="onError" apikey="API-KEY" src="/static/js/front_rebugger.min.js" crossorigin="anonymous"></script>

动态接入属性配置 通过setAttribute方法配置埋点属性 例如

<script type="text/javascript">

function loadScript(url, apikey) {
    var script = document.createElement("script");
    script.type = "text/javascript";
    script.src = url;
    script.setAttribute("id", "rebugger");
    script.setAttribute("apikey", apikey);
    script.setAttribute("reportMode", "onError");
    document.body.appendChild(script);
}

loadScript("/static/js/front_rebugger.min.js", "API-KEY")
</script>

埋点属性

params Type Description
id String 必填, 且值为rebugger
apikey String 必填, 用于项目区分,不同项目apikey不一样
silent Boolean 选填默认false, 如果为true,禁用rebugger不收集任何数据
silentDev Boolean 选填默认false, 如果为true,不再收集开发环境的错误
silentTest Boolean 选填默认false, 如果为true,不再收集测试环境的错误
silentPre Boolean 选填默认false, 如果为true,不再收集预发布环境的错误
reportMode String 选填默认onError, 异常上传模式 onError 立即上传 byNum 按天存储满多少个上传 byDay 按天上传 onErrorOffline 立即上报且支持线下缓存
useCustomField Boolean 选填默认false, 是否收集自定义字段,保存在metaData里面
customField Object 选填, 通过埋点设置必须是json字符串建议在埋点后script标签里面定义,配置的数据将被保存在metaData字段里面
silentVideo Boolean 选填默认false, 是否开启视频录制, 异常场景还原, 该功能待开发,

其它配置属性

params Type Description
reportNum Number 选填默认10, byNum上传模式满n个上传数据,缓解服务端压力
limitNum Number 选填默认20, byDay上传模式默认超过20个会主动上传数据
baseUrl String 选填默认http://localhost:9090,定义上报服务器地址
customField Object 选填和埋点属性同一个属性, 自定义保存字段 数据将会保存在metaData里面 origin: localStorage / sessionStorage / window / cookie 不能获取跨域信息 需要将js文件下载
<script id="rebugger" useCustomField="true" silentDev="false" reportMode="onError" apikey="API-KEY" src="/static/js/rebugger_logger.min.js"></script>
// 定义属性配置
<script>
    if(Rebugger){
        // 配置自定义上报字段 这些字段将会以JSON字符串的形式保存在metaDta字段里
        Rebugger.default.options.customField = {
            userName: {
                origin: "localStorage",
                paths: "user.userName"
            },
            userId: {
                origin: "localStorage",
                paths: "user.id"
            }
        }
        Rebugger.default.options.baseUrl = "http://xxx...";
    }
</script>

上报接口

代码中主动上报 使用全局Rebugger对象

    // 使用日志对象时必须先判断该对象是否存在
    if ( Rebugger ) {
        ...
        Rebugger.default.上报方法(上报信息对象);
    }
    // 安全使用 添加try catch
    try {
        if ( Rebugger ) {
        ...
        Rebugger.default.上报方法(上报信息对象);
        }
    } catch (error) {
        
    }

1、日志收集

  Rebugger.default.reportInfo(errorInfo);

2、警告信息

 Rebugger.default.reportWarning(errorInfo);

3、http请求异常

Rebugger.default.reportHttpError(errorInfo);

4、js异常收集

Rebugger.default.reportError(errorInfo);

5、promise异常上报

Rebugger.default.reportHandledRejection(errorInfo);

errorInfo 字段信息对照

  // 异常字段
  ReportFieldV = {
    日志名称: "name",
    异常信息: "message",
    异常堆栈: "stack",
    异常文件: "fileName",
    所在文件行: "lineNumber",
    所在文件列: "columnNumber",
    其它信息: "metaData",
    异常组件: "componentName",
    组件参数: "propsData",
    资源接口地址: "src",
    状态码: "status",
    状态内容: "statusText",
  }

安装部署

rebugger-embed

    打包埋点文件 npm run build:em

rebugger-admin

    npm install
    npm run dev
    npm run build

rebugger-service 和 rebugger-schedule

    npm run serve 开始调试模式
    部署模式需要环境全局安装pm2
    npm install -g pm2 // 安装pm2
    npm run restart:dev // 部署到开发环境
    npm run restart:test // 部署到测试环境
    npm run restart:prod // 部署到生产环境

Changelog

2019.07.18

v0.0.1 * 初始化项目

2019.08.01

v0.0.1 * rebugger-embed 开发完成

2019.08.12

v0.0.1 * rebugger-server 和 rebugger-admin 开发完成

2019.08.20

v0.0.1 * 项目开始应用于生产

2019.10.15

v0.0.2 * 更新异常上传方式和rebugger-schedule

2019.12.15

v0.1.1 * 开始迁移到github,开源此项目

2020.2.9

v0.1.3 * 拆分项目

For detailed explanation on how things work, consult the docs for vue-loader.

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

bug collection,bug detection,前端异常监控系统 性能监控 埋点接入 多项目管理 异常日志收集 异常处理 异常分析 异常报表 设备分析 用户分析 区域分析 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/tomxiang/rebugger.git
git@gitee.com:tomxiang/rebugger.git
tomxiang
rebugger
rebugger
master

搜索帮助