{"id":16454138,"url":"https://github.com/duheng/sniperjs","last_synced_at":"2025-03-23T10:32:26.149Z","repository":{"id":42821273,"uuid":"247903852","full_name":"duheng/sniperjs","owner":"duheng","description":" sniperjs: 简单可依赖的前端错误日志搜集上报SDK。支持微信、支付宝、百度、头条、快应用等小程序，以及浏览器端。","archived":false,"fork":false,"pushed_at":"2023-01-06T07:14:50.000Z","size":4065,"stargazers_count":10,"open_issues_count":15,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-12T10:18:05.056Z","etag":null,"topics":["bug","debugger","error","error-log","error-monitoring","errors","javascript","javascript-errors","miniprogram","repoter"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/duheng.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-17T07:17:24.000Z","updated_at":"2024-07-16T09:58:03.000Z","dependencies_parsed_at":"2023-02-05T14:45:49.186Z","dependency_job_id":null,"html_url":"https://github.com/duheng/sniperjs","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/duheng%2Fsniperjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/duheng%2Fsniperjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/duheng%2Fsniperjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/duheng%2Fsniperjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/duheng","download_url":"https://codeload.github.com/duheng/sniperjs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221849336,"owners_count":16891426,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bug","debugger","error","error-log","error-monitoring","errors","javascript","javascript-errors","miniprogram","repoter"],"created_at":"2024-10-11T10:18:09.294Z","updated_at":"2024-10-28T15:32:49.340Z","avatar_url":"https://github.com/duheng.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sniperjs 前端错误日志无侵入搜集和上报\n\n简单可依赖的自动搜集前端错误并上报，支持小程序（微信、百度、支付宝、头条、快应用）、浏览器。\n\n# 特性\n1. 无侵入搜集 Js 报错。\n2. 自动搜集 Http 错误。\n3. 自动捕捉 Promise rejection。\n4. 还原报错时用户操作历史。 [pending]\n5. 自定义上报方式。\n   \n\n# 安装\n\n```\nnpm install @sniperjs/miniwx-error-reporter\n```\n\n# 使用方式\n\n\u003e sniperjs 需在入口文件 App() 函数调用之前之前完成实例化\n\n1. 引用对应端的的SDK。\n2. 实例化。\n\n### 引用（目前只支持微信小程序）\n```\n// app.js\n\n// 微信小程序\nimport ErrorReporter from '@sniperjs/miniwx-error-reporter'; \n\n```\n\n### 实例化\n```\nnew ErrorReporter({\n    url: 'your request api'\n});\n\n// your app code\nApp();\n```\n\n### 日志格式\n```\n{\n\t\"agent\": \"WX_MINI_APP\",\n\t\"env\": \"\",\n\t\"appVersion\": \"\",\n\t\"system\": {\n\n\t},\n\t\"logs\": [{\n\t\t\"stack\": \"thirdScriptError\\nabc is not defined;at \\\"pages/index/index\\\" page lifeCycleMethod onReady function\\nReferenceError: abc is not defined\\n    at Ctor.componentDidMount (http://127.0.0.1:20424/appservice/pages/index/index.js:72:17)\\n    at Se.onReady (http://127.0.0.1:20424/appservice/ReactWX.js:3084:11)\\n    at Se.\u003canonymous\u003e (http://127.0.0.1:20424/appservice/__dev__/WAService.js:2:1674902)\\n    at Se.p.__callPageLifeTime__ (http://127.0.0.1:20424/appservice/__dev__/WAService.js:2:1674647)\\n    at http://127.0.0.1:20424/appservice/__dev__/WAService.js:2:1698166\\n    at Function.\u003canonymous\u003e (http://127.0.0.1:20424/appservice/__dev__/WAService.js:2:1698955)\\n    at http://127.0.0.1:20424/appservice/__dev__/WAService.js:2:1666024\\n    at http://127.0.0.1:20424/appservice/__dev__/WAService.js:2:726686\\n    at http://127.0.0.1:20424/appservice/__dev__/WAService.js:2:724745\\n    at n (http://127.0.0.1:20424/appservice/__dev__/asdebug.js:1:27894)\",\n\t\t\"line\": \"72\",\n\t\t\"col\": \"17\",\n\t\t\"file\": \"http://127.0.0.1:20424/appservice/pages/index/index.js\",\n\t\t\"type\": \"ReferenceError\",\n\t\t\"value\": \"abc is not defined\",\n\t\t\"time\": 1586930000288,\n\t\t\"pageRoute\": {\n\t\t\t\"path\": \"pages/index/index\",\n\t\t\t\"query\": {}\n\t\t},\n\t\t\"breadcrumbs\": []\n\t}]\n}\n```\n\n### 配置参数说明\n\n| 参数 | 说明 | 类型   | 默认值 | 必选 |\n| --- | --- | --- | --- | --- |\n| url | 上报接口地址  | String  | ''  | 是  |\n| ignoreErrors | 上报错误类型忽略 | Array\u003cRegExp\\|String\u003e | [] | 否  |\n| random | 随机上报 | Number | 1 | 否  |\n| repeat | 重复记录次数、超过该记录的错误不上报 | Number | 5 | 否 |\n| delay | 延迟后合并上报 | Number | 1000（毫秒） | 否 |\n| env | 环境变量 | String | '' | 否 |\n| appVersion | 你的应用版本 | String | '' | 否 |\n| autoBreadcrumbs | 是否上报用户操作历史 | Boolean | true | 否 |\n| breadcrumbsMax | 最多记录最近几次用户操作记录 | Number | 5 | 否  |\n| beforeReport | 上报前回调函数，可在这里劫持上报日志做处理，或者在这里自定义上报方式 |  Function| function(log){return log}  |否  |\n\n\n# 常见问题\n- FAQ\n\n# 开发\n```\n# 克隆仓库\ngit clone https://github.com/taotao9125/sniperjs.git\n\n# 安装依赖\nnpm install\n\n# Bootstrap lerna 依赖包\nnpm run bootstrap\n\n# watch\nnpm run watch\n```\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fduheng%2Fsniperjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fduheng%2Fsniperjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fduheng%2Fsniperjs/lists"}