tachybase_todo/docs/en-US/welcome/release/logger.md

68 lines
1.4 KiB
Markdown
Raw Normal View History

2023-01-11 12:30:13 +08:00
# v0.9.0NocoBase 的 Logging 系统
2022-11-13 23:00:59 +08:00
## `@nocobase/logger`
基于 Winston 实现,提供了便捷的创建 logger 实例的方法。
```ts
const logger = createLogger();
logger.info('Hello distributed log files!');
const { instance, middleware } = createAppLogger(); // 用于 @nocobase/server
app.logger = instance;
app.use(middleware);
```
## 新增的环境变量
logger 相关环境变量有:
- [LOGGER_TRANSPORT](/api/env#logger_transport)
- [LOGGER_BASE_PATH](/api/env#logger_base_path)
2022-11-13 23:00:59 +08:00
## Application 的 logger 配置
```ts
const app = new Application({
logger: {
async skip(ctx) {
return false;
},
requestWhitelist: [],
responseWhitelist: [],
transports: ['console', 'dailyRotateFile'],
},
})
```
更多配置项参考 [Winston 文档](https://github.com/winstonjs/winston#table-of-contents)
## app.logger & ctx.logger
ctx.logger 带有 reqId整个 ctx 周期里都是一个 reqId
```ts
ctx.logger = app.logger.child({ reqId: ctx.reqId });
```
`app.logger``ctx.logger` 都是 Winston 实例,详细用法参考 [Winston 文档](https://github.com/winstonjs/winston#table-of-contents)
## 自定义 Transports
除了 Winston 的方式以外NocoBase 还提供了一种更便捷的方式
```ts
import { Transports } from '@nocobase/logger';
Transports['custom'] = () => {
return new winston.transports.Console();
};
const app = new Application({
logger: {
transports: ['custom'],
},
})
```