@tuia/tuia-egg-cat

tuia-egg-cat

Usage no npm install needed!

<script type="module">
  import tuiaTuiaEggCat from 'https://cdn.skypack.dev/@tuia/tuia-egg-cat';
</script>

README

egg-t

NPM version build status Test coverage David deps Known Vulnerabilities npm download

Install

$ npm i @tuia/tuia-egg-cat --save

Usage

// {app_root}/config/plugin.js
exports.t = {
  enable: true,
  package: '@tuia/tuia-egg-cat',
};

Configuration

// {app_root}/config/config.default.js
exports.catClient = {
  client: {
    appKey: 'tuia-yourapp',
    coverXml: false, // 用于本地改写xml配置,容器不要改动
    connection: {
      ip: '172.16.80.101', // 本地测开发环境,容器不需要写
      port: '2280',
      httpPort: '8080',
    },
  },
};

How to use

class HomeController extends Controller {
  async index() {
    this.ctx.body = 'hi, egg';

    // 获取初始化好的cat对象
    let cat = this.ctx.app.catClient;
    threadCat = new cat.Cat(true);
    //创建一个transaction实例
    const trans = threadCat.newTransaction('TestTran', 'DDD');
    //添加数据
    trans.addData('key', 'value');
    trans.logEvent('EventTransaction', 'E1111');
    const subTrans = a.newTransaction('TestSubTran', 'GGGGG');
    subTrans.addData('subKey', 'subValue');
    trans.setStatus(cat.STATUS.SUCCESS);
    setTimeout(function() {
      trans.complete();
    }, 1000);

    // Event 
    cat.logEvent('Event', 'E1');
    cat.logEvent('Event', 'E2', cat.STATUS.FAIL);
    cat.logEvent('Event', 'E3', 'failed');
    // Error
    cat.logError('ErrorInTransaction', new Error());
  }
}

module.exports = HomeController;

see config/config.default.js for more detail.

Example

Questions & Suggestions

Please open an issue here.

License

MIT