Browse Source

添加日志规范

Michael Wang 6 years ago
parent
commit
a0ec1d93ff
2 changed files with 26 additions and 3 deletions
  1. 2 3
      README.md
  2. 24 0
      docs/日志规范.md

+ 2 - 3
README.md

@@ -76,9 +76,8 @@ vue-cli
 | src/utils/      | 共享的工具类。 跟业务有关的工具方法放在 src/features/中                                                                                                                                                                                                                                                            |
 | src/router.js   | vue-router,可以引用 src/modules 下面的 routes                                                                                                                                                                                                                                                                     |
 | src/store.js    | 使用 Vuex 管理状态的单一 store. 可以引用 src/modules 下面的 store                                                                                                                                                                                                                                                  |
-
-| static/ | 不需要 Webpack 处理的静态文件 |
-| tests/ | 单元测试和 E2E 测试 |
+| static/         | 不需要 Webpack 处理的静态文件                                                                                                                                                                                                                                                                                      |
+| tests/          | 单元测试和 E2E 测试                                                                                                                                                                                                                                                                                                |
 
 ## 错误处理
 

+ 24 - 0
docs/日志规范.md

@@ -0,0 +1,24 @@
+# 日志规范
+
+## 日志的作用
+
+- 明确程序的执行状态
+- 发生错误后,根据日志追根溯源
+- 日志的规模可以反映出一些规律,日志对技术和业务都有帮助
+
+## 日志的种类
+
+- 开发过程中的日志,使用 console.debug
+- 关键操作的过程,使用 console.log
+- 关键操作的抽无,使用 console.error
+- JS 运行错误,捕获后上报
+
+## 日志的存储和上报
+
+目前有 4 种日志:
+
+- 打印在控制台,并没有存储
+- 可以存放到 IndexedDB 里面
+- 如果是 Electron 应用,可以存日志文件到硬盘
+- 可以将重要的日志存储通过接口存储到自己的服务器
+- 通过百度统计的事件记录下来