Skip to content
/ diudiu Public

一个轻量的企业级BFF框架,集成xprofiler能力,可直接使用其强大的监控告警能力。

License

Notifications You must be signed in to change notification settings

SKHon/diudiu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

          _ _ _ _     _ _ _ _      _       _      _ _ _ _      _ _ _ _      _       _
         | _ _ _ |   |_ _ _ _|    | |     | |    | _ _ _ |    |_ _ _ _|    | |     | |
         | |   | |      | |       | |     | |    | |   | |       | |       | |     | |
         | |   | |      | |       | |     | |    | |   | |       | |       | |     | |
         | |  | |     __| |__     | |_ _ _| |    | |  | |      __| |__     | |_ _ _| |
         | | / /     |_ _ _ _|    |_ _ _ _ _|    | | / /      |_ _ _ _|    |_ _ _ _ _|

一个基于koa的BFF框架,内置路由、模板、日志、mysql、redis、elasticsearch等模块。也支持用户自定义中间件能力。

使用指南

  1. 全局安装脚手架
npm i -g diudiu-cli
  1. 初始化项目
diudiu-cli new my-diudiu
  1. 安装依赖
npm i
  1. 启动项目
npm run dev

xprofiler监控告警能力

  1. 按照部署监控服务端,完成前置部署能力,并分别启动相关服务(包括xprofiler-console、xtransit-manager、xtransit-server)。

  2. 访问http://127.0.0.1:8443/,创建新应用,并生成appId和appSecret,并将两个参数写到diudiu项目中的xtransit.js配置中,像下面这样:

const xtransit = require('xtransit');
const path = require('path');
const config = {
  server: `ws://127.0.0.1:9190`, 
  appId: 2, // 创建应用得到的应用 ID
  appSecret: '4201aef5fa50505fbca34b8aec28e94d', // 创建应用得到的应用 Secret
  logDir: path.resolve(__dirname, 'xprofiler')  // 这里的路径要和xprofiler的log_dir要保持完全一致
};
xtransit.start(config);
  1. 在diudiu中config/config.development.ts中配置xprofiler:
import path from 'path';
export default app => {
  return {
    // ...
    xprofiler: {
      log_dir: 'xprofiler'  // 默认会在diudiu目录下生成,注意该目录和xtransit.js中的logDir一定要保持一致
    }
  }
}

这里注意一点:2中的logDir,和3中的log_dir一定要保持一致,因为xtransit就是要读取xprofiler生成的日志目录,然后通过socket传给1中的xtransit-server。

  1. 执行diudiu项目并启动xtransit(这里用pm2单独进程启动了xtransit,是因为xtransit这里只起agent作用,不可放在业务进程中)
npm run dev
npm run xtransit
  1. 等1~2分钟,就可以在http://127.0.0.1:8443/创建的应用中,看到node服务的监控指标了。相关详细指标可参考告警上下文

开发指南

  1. 将diudiu工程最新代码拉下来
  2. 目录介绍
    • lib:核心工程
    • example:调试工程,
    • cli:脚手架工程。
  3. 在主工程diudiu下,按顺序执行
    • npm run lerna
    • npm run dev

pr规范

对于 Pull Request,请遵守以下几点要求:

  1. 标题请写明本次 PR 的目的(做了 什么 工作,修复了 什么 问题)。
  2. 内容请简要叙述修改的内容。如果修复了一个 issue 的问题,请在内容中添加 fix #xxxx 字段,其中 xxxx 代表 issue 的编号。
  3. 推荐删除 pull request message 中的模板信息(“首先,十分感谢……”这一段)。 对于 Pull Request 的标题,推荐使用如下格式书写:
<修改类型>(<文件名>): <修改的内容> (<对应 issue 的编号>)

修改类型分为如下几类:

  • feat: 新增特性或功能
  • fix: 修复问题
  • docs: 修改文档
  • style: 修改代码格式
  • refactor: 代码重构,不引入新功能和修复问题
  • perf: 性能优化
  • test: 新增、修改测试用例
  • chore: 构建过程或者辅助工具的变动
  • merge: 代码合并

官方群

qq group

License

如有引用,请标明出处。 MIT

About

一个轻量的企业级BFF框架,集成xprofiler能力,可直接使用其强大的监控告警能力。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published