docs: add core/logger.md #204

shaoshuai0102 · 2017-01-08T13:51:34Z

No description provided.

mention-bot · 2017-01-08T13:51:34Z

@shaoshuai0102, thanks for your PR! By analyzing the history of the files in this pull request, we identified @fengmk2, @popomore and @dead-horse to be potential reviewers.

popomore · 2017-01-08T14:02:04Z

docs/source/zh-cn/core/logger.md

+## 日志路径
+
+- 所有日志文件默认都放在 `${appInfo.root}/logs/${appInfo.name}` 路径下，例如 `/home/admin/logs/example-app`。
+- 在本地开发环境(env: local) 和单元测试环境(env: unittest)，为了避免冲突以及集中管理，日志会打印在项目目录下的 logs 目录，例如 `/path/to/example-app/logs/example-app`。


改成 serverEnv

popomore · 2017-01-08T14:08:21Z

docs/source/zh-cn/core/logger.md

+如果想自定义日志路径：
+
+```js
+// config/config.${env}.js


- config.${env}.js + config.${serverEnv}.js

popomore · 2017-01-08T14:14:08Z

docs/source/zh-cn/core/logger.md

+};
+```
+
+可通过 `app.loggers.xxLogger` 获取，最终的打印结果和 coreLogger 类似。


这里可以用 app.getLogger('xxLogger')

popomore · 2017-01-08T14:17:31Z

docs/source/zh-cn/core/logger.md

+ctx.logger.warn('WARNNING!!!!');
+
+// 错误日志记录，直接会将错误日志完整堆栈信息记录下来，并且输出到 errorLog 中
+ctx.logger.error(someErrorObj);


这里加个 new Error，然后�强调下为何用 error 实例

popomore · 2017-01-08T14:18:05Z

docs/source/zh-cn/core/logger.md

+ctx.logger.error(someErrorObj);
+```
+
+对于框架开发者和插件开发者会使用到的 ctx logger 还有 `ctx.coreLogger`。


这里的 ctx logger 要不要用 context，只有在代码里叫 ctx.xxx

popomore · 2017-01-08T14:22:40Z

docs/source/zh-cn/core/logger.md

+app.coreLogger.info('启动耗时 %d ms', Date.now() - start);
+```
+
+### agent logger


agent 感觉这里不用说明

这里简单提了下，给 plugin 编写减少点负担吧

popomore · 2017-01-08T14:24:47Z

docs/source/zh-cn/core/logger.md

+
+默认只会输出 `INFO` 及以上(`WARN` 和 `ERROR`)的日志到终端中。
+
+- `logger.consoleLevel` (可选): 输出到终端日志的级别，默认为 `INFO`


这个应用启动后会关闭。

https://github.com/eggjs/egg-logger/blob/73f4039dbdc797473ac8247a5f5542494f88476e/lib/transports/console.js#L23

还可以用环境变量来控制

这个不提了，太细节了

popomore · 2017-01-08T14:28:43Z

docs/source/zh-cn/core/logger.md

+### 高级自定义日志
+
+日志默认是打印到日志文件中，当本地开发时同时会打印到终端。
+但是，有时候我们会有需求把日志打印到其他媒介上，这时候我们就需要自定义日志的 transport。


这个没有空行就接着上面写吧

可以介绍下 transport，transport 是一种传输通道，一个 logger 可包含多个传输通道。比如默认的 logger 就有 fileTransport 和 consoleTransport

popomore · 2017-01-08T14:33:12Z

docs/source/zh-cn/core/logger.md

+
+### 按照文件大小切割
+
+我们也可以按照文件大小进行切割。例如，当文件超过 50G 时进行切割。


popomore · 2017-01-08T14:37:29Z

docs/source/zh-cn/core/logger.md

+
+
+
+更多详细配置请参考 [egg-logger](https://github.com/eggjs/egg-logrotator)。


这个链接是不是错了

popomore

LGTM

fengmk2 · 2017-01-08T15:15:58Z

config/config.default.js

@@ -134,7 +134,6 @@ module.exports = appInfo => {
   * logger options
   * @member Config#logger
   * @property {String} dir - 日志存储目录
-   * @property {String} rotateLogDirs - 自动按日切割的目录
   * @property {String} encoding - 日志文件编码，预发和生产环境默认是 gbk，其他环境是 utf8


这些注释都改成英文？

encoding 默认都是 utf8的，不会有 gbk

fengmk2 · 2017-01-08T15:26:37Z

docs/source/zh-cn/core/logger.md

+app.logger.warn('warning!');
+
+// 错误日志记录，直接会将错误日志完整堆栈信息记录下来，并且输出到 errorLog 中
+// 为了保证异常可追踪，必须保证所有抛出的异常都是 Error 类型，因为只有 Error 类型才会带上堆栈信息，定位到问题。


这句重复的应该不需要写了，上面有说过，读者会知道的。

fengmk2 · 2017-01-08T15:27:15Z

docs/source/zh-cn/core/logger.md

+agent.logger.warn('warning!');
+
+// 错误日志记录，直接会将错误日志完整堆栈信息记录下来，并且输出到 errorLog 中
+// 为了保证异常可追踪，必须保证所有抛出的异常都是 Error 类型，因为只有 Error 类型才会带上堆栈信息，定位到问题。


同上，去掉

fengmk2 · 2017-01-08T15:27:49Z

docs/source/zh-cn/core/logger.md

+agent.logger.error(someErrorObj);
+```
+
+详细了解 agent 进程，请参考插件开发文档。


“如需详细了解 agent 进程，请参考插件开发文档。”

dead-horse · 2017-01-08T15:27:58Z

docs/source/zh-cn/core/logger.md

+
+日志对于 web 开发的重要性毋庸置疑，它对于监控应用的运行状态、问题排查等都有非常重要的意义。
+
+框架内置了强大的企业级日志支持，由 [egg-logger](https://github.com/eggjs/egg-logger) 插件提供。


fengmk2 · 2017-01-08T15:29:08Z

docs/source/zh-cn/core/logger.md

+
+### 文件日志级别
+
+默认只会输出 `INFO` 及以上(`WARN` 和 `ERROR`)的日志到文件中。


使用中文的（）

fengmk2 · 2017-01-08T15:29:43Z

docs/source/zh-cn/core/logger.md

+
+### 终端日志级别
+
+默认只会输出 `INFO` 及以上(`WARN` 和 `ERROR`)的日志到终端中。


fengmk2 · 2017-01-08T15:33:35Z

docs/source/zh-cn/core/logger.md

+    let log;
+    if (args[0] instanceof Error) {
+      const err = args[0];
+      log util.format('%s: %s\n%s\npid: %s\n', err.name, err.message, err.stack, process.pid);


fengmk2 · 2017-01-08T15:34:08Z

docs/source/zh-cn/core/logger.md

+      const err = args[0];
+      log util.format('%s: %s\n%s\npid: %s\n', err.name, err.message, err.stack, process.pid);
+    } else {
+      log = util.format.apply(null, args);


log = util.format(...args);

fengmk2 · 2017-01-08T15:35:00Z

docs/source/zh-cn/core/logger.md

+      log = util.format.apply(null, args);
+    }
+    co(function* () {
+      yield app.curl('http://url/to/remote/error/log/service/logs', {


app 怎么来的？

fengmk2 · 2017-01-08T15:39:19Z

docs/source/zh-cn/core/logger.md

+
+
+
+更多详细配置请参考 [egg-logger](https://github.com/eggjs/egg-logger) 和 [egg-logrotator](https://github.com/eggjs/egg-logrotator)。


更多详细信息请参考，不要说配置。

codecov-io · 2017-01-08T15:46:21Z

Current coverage is 97.65% (diff: 100%)

No coverage report found for master at b72e9df.

Powered by Codecov. Last update b72e9df...b6482fd

shaoshuai0102 · 2017-01-08T15:47:13Z

done 再看看

fengmk2 · 2017-01-08T15:58:53Z

config/config.default.js

@@ -1,4 +1,4 @@
-'use strict';


为啥要删除？

fengmk2

LGTM

shaoshuai0102 force-pushed the doc-core-logger branch from b6482fd to 645d423 Compare January 8, 2017 13:52

shaoshuai0102 requested review from fengmk2, popomore, leoner and dead-horse January 8, 2017 13:52

shaoshuai0102 assigned popomore Jan 8, 2017

shaoshuai0102 added the type: document label Jan 8, 2017

shaoshuai0102 added this to the v1.x milestone Jan 8, 2017

shaoshuai0102 force-pushed the doc-core-logger branch from 645d423 to 72a1f6d Compare January 8, 2017 13:53

popomore changed the title ~~Doc core logger~~ docs: add core/logger.md Jan 8, 2017

shaoshuai0102 force-pushed the doc-core-logger branch from 72a1f6d to b4fce85 Compare January 8, 2017 14:16

popomore reviewed Jan 8, 2017

View reviewed changes

shaoshuai0102 force-pushed the doc-core-logger branch from b4fce85 to b24326e Compare January 8, 2017 14:53

popomore mentioned this pull request Jan 8, 2017

中文文档 #34

Closed

31 tasks

popomore approved these changes Jan 8, 2017

View reviewed changes

fengmk2 reviewed Jan 8, 2017

View reviewed changes

dead-horse reviewed Jan 8, 2017

View reviewed changes

fengmk2 reviewed Jan 8, 2017

View reviewed changes

shaoshuai0102 force-pushed the doc-core-logger branch 2 times, most recently from 15eb433 to e4919ed Compare January 8, 2017 15:46

fengmk2 reviewed Jan 8, 2017

View reviewed changes

config/config.default.js

@@ -1,4 +1,4 @@

'use strict';

Copy link

Member

fengmk2 Jan 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

为啥要删除？

docs: add core/logger.md

e7c4ce7

shaoshuai0102 force-pushed the doc-core-logger branch from e4919ed to e7c4ce7 Compare January 8, 2017 16:00

fengmk2 approved these changes Jan 8, 2017

View reviewed changes

fengmk2 merged commit cbf1ee8 into master Jan 8, 2017

fengmk2 deleted the doc-core-logger branch January 8, 2017 16:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add core/logger.md #204

docs: add core/logger.md #204

shaoshuai0102 commented Jan 8, 2017

mention-bot commented Jan 8, 2017

popomore Jan 8, 2017

popomore Jan 8, 2017

popomore Jan 8, 2017

popomore Jan 8, 2017

popomore Jan 8, 2017

popomore Jan 8, 2017

shaoshuai0102 Jan 8, 2017

popomore Jan 8, 2017

popomore Jan 8, 2017

shaoshuai0102 Jan 8, 2017

popomore Jan 8, 2017

popomore Jan 8, 2017

shaoshuai0102 Jan 8, 2017

popomore Jan 8, 2017

popomore Jan 8, 2017

popomore left a comment

fengmk2 Jan 8, 2017

fengmk2 Jan 8, 2017

fengmk2 Jan 8, 2017

fengmk2 Jan 8, 2017

dead-horse Jan 8, 2017

fengmk2 Jan 8, 2017

fengmk2 Jan 8, 2017

fengmk2 Jan 8, 2017

fengmk2 Jan 8, 2017

fengmk2 Jan 8, 2017

fengmk2 Jan 8, 2017

codecov-io commented Jan 8, 2017 •

edited

Loading

shaoshuai0102 commented Jan 8, 2017

fengmk2 Jan 8, 2017

fengmk2 left a comment


		默认只会输出 `INFO` 及以上(`WARN` 和 `ERROR`)的日志到终端中。

		- `logger.consoleLevel` (可选): 输出到终端日志的级别，默认为 `INFO`


		### 按照文件大小切割

		我们也可以按照文件大小进行切割。例如，当文件超过 50G 时进行切割。




		更多详细配置请参考 [egg-logger](https://github.com/eggjs/egg-logrotator)。


		日志对于 web 开发的重要性毋庸置疑，它对于监控应用的运行状态、问题排查等都有非常重要的意义。

		框架内置了强大的企业级日志支持，由 [egg-logger](https://github.com/eggjs/egg-logger) 插件提供。


		### 文件日志级别

		默认只会输出 `INFO` 及以上(`WARN` 和 `ERROR`)的日志到文件中。


		### 终端日志级别

		默认只会输出 `INFO` 及以上(`WARN` 和 `ERROR`)的日志到终端中。

docs: add core/logger.md #204

docs: add core/logger.md #204

Conversation

shaoshuai0102 commented Jan 8, 2017

mention-bot commented Jan 8, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

popomore left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Jan 8, 2017 • edited Loading

Current coverage is 97.65% (diff: 100%)

shaoshuai0102 commented Jan 8, 2017

Choose a reason for hiding this comment

fengmk2 left a comment

Choose a reason for hiding this comment

codecov-io commented Jan 8, 2017 •

edited

Loading