xadillax / egg-lookout

SOFALookout plugin for egg

egg-lookout

SOFALookout plugin for egg framework

SOFALookout plugin for egg framework

Install

$ npm i egg-lookout --save

Usage

Enable the plugin

Change ${app_root}/config/plugin.js to enable SOFALookout plugin:

exports.lookout = {
  enable: true,
  package: 'egg-lookout',
};

Configuration

exports.lookout = {
  agentHost: 'lookout server host',
  agentPort: 7200,
  maxMetricNum: 3000,
  reportBatchSize: 1700,
  compressThreshold: 100,
  autoPoll: true,
};

• agentHost: the report service host
• agentPort: the report service port
• maxMetricNum: the maxinum number of metrics that can be created, default value is 3000
• reportBatchSize: the number of items reported to server at one time, default value is 1700
• compressThreshold: sets the minimum block size for which compression is to occur
• autoPoll: whether report to server automatically

Example

You can access to lookout APIs by using app.lookout. More detail please refer to sofa-lookout-node

const id = app.lookout.createId('http_request_count');
const counter = app.lookout.counter(id);
counter.inc();

How to Contribute

Please let us know how can we help. Do check out issues for bug reports or suggestions first.

To become a contributor, please follow our contributing guide.

License

MIT