egg-logger-sentry
egg 框架的 sentry 插件
此插件基于 @sentry/node 进行二次封装，针对egg机制进行定制化功能开发：
- 高并发环境下，会话日志面包屑数据污染问题
- 默认接入应用请求会话和curl Performance Monitoring 功能
- 适配EggJS日志API
- 适配EggJS日志分类
安装
$ npm i egg-logger-sentry --save开启插件
// config/plugin.js
exports.loggerSentry = {
enable: true,
package: 'egg-logger-sentry',
};详细配置
基于 Sentry for Node.js Configuration 扩展配置：
| 配置项 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| disableLoggers | {Array<string>} |
[] |
指定日志分类不进行日志捕获，详情查看Egg日志分类 |
// config/config.[env].js
const os = require('os');
config.loggerSentry = {
dsn: "https://12345@sentry.example.com/1",
environment: appInfo.env,
serverName: os.hostname(),
release: process.env.GIT_COMMIT_HASH || '', // git commit hash
disableLoggers: [],
};用例
默认用法是基于 eggjs 打印日志API进行扩展，支持 sentry 的 Tag、Extra、User、Fingerprint 属性。
每条日志都会追加默认的 Tag 和 Extra 属性：
Tag
| 配置项 | 类型 | 说明 |
|---|---|---|
app.type |
{String} |
标记日志是 application 日志还是 agent 日志 |
logger.entry |
{String} |
标记日志分类： appLogger、 coreLogger、 errorLogger、 agentLogger、 scheduleLogger，关于EGG的日志分类说明
|
Extra
| 配置项 | 类型 | 说明 |
|---|---|---|
egg |
{String} |
应用 egg 依赖包的版本号 |
egg-scripts |
{String} |
应用 egg-scripts 依赖包的版本号 |
egg-alinode |
{String} |
应用 egg-alinode 依赖包的版本号 |
Context/App/Agent Logger
Context级别
this.ctx.logger.debug('debug info', {
tags: {
'tag1-key': 'tag1-value',
'tag2-key': 'tag2-value',
},
extra: {
'extra1-key': 'extra-value',
'extra2-key': {
'extra2-1': 'extra2-1.value',
'extra2-2': 'extra2-2.value',
'extra2-3': 'extra2-3.value',
},
},
user: {
id: 123456789,
email: 'kidneyleung@gmail.com',
}
});
this.ctx.logger.info('some request data: %j', ctx.request.body);
this.ctx.logger.warn('WARNNING!!!!');
// 错误日志记录，直接会将错误日志完整堆栈信息记录下来，并且输出到 errorLog 中
// 为了保证异常可追踪，必须保证所有抛出的异常都是 Error 类型，因为只有 Error 类型才会带上堆栈信息，定位到问题。
this.ctx.logger.error(new Error('whoops'));
// 对于框架开发者和插件，会使用 ctx.coreLogger
this.ctx.coreLogger.info('info');App级别
// app.js
module.exports = app => {
app.coreLogger.info('启动耗时 %d ms', Date.now() - start);
};Agent级别
// agent.js
module.exports = agent => {
agent.logger.debug('debug info');
agent.logger.info('启动耗时 %d ms', Date.now() - start);
agent.logger.warn('warning!');
agent.logger.error(someErrorObj);
};性能监控链路追踪
利用sentry提供的 @sentry/tracing 组件，对应用进行性能监控，覆盖范围可达多个服务（Nodejs、Browser、GO、Java、PHP等），获知整个应用的吞吐量、耗时等指标。
Sentry Performance Monitoring文档
例子：
const parentSpan = ctx.sentryScope.getSpan();
const span = parentSpan.startChild({
description: '获取会员信息',
op: 'service',
});
await this.ctx.curl(/* http://... */);
span.finish();由NodeJS到浏览器页面跨服务追踪
NodeJS render.js
const Controller = require('egg').Controller;
class HomeController extends Controller {
async index() {
const renderData = {
sentryTrace: ctx.sentryScope.getSpan().toTraceparent(),
};
await this.ctx.render('index.nj', renderData);
}
}index.nj
客户端可配合 JavaScript SDK 使用
<!doctype html>
<html lang="zh-cmn-Hans">
<head>
<meta charset="utf-8">
<meta name="sentry-trace" content="{{ sentryTrace }}" />
</head>
<body>
</body>
</html>提问交流
请到 egg-logger-sentry issues 交流。