Git Product home page Git Product logo

egg-lookout's Introduction

egg-lookout

SOFALookout plugin for egg framework

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

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

egg-lookout's People

Contributors

gxcsoccer avatar xadillax avatar zhoukk avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

xadillax zhoukk

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.