Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willin/koa-api-logger
API Logger for Koa
https://github.com/willin/koa-api-logger
api koa logger
Last synced: 4 months ago
JSON representation
API Logger for Koa
- Host: GitHub
- URL: https://github.com/willin/koa-api-logger
- Owner: willin
- License: mit
- Created: 2017-06-23T04:47:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T03:26:00.000Z (about 2 years ago)
- Last Synced: 2024-04-14T05:40:01.432Z (10 months ago)
- Topics: api, koa, logger
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/koa-api-logger
- Size: 499 KB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# koa-api-logger
[](https://npmjs.org/package/koa-api-logger) [](https://npmjs.org/package/koa-api-logger) [](https://npmjs.org/package/koa-api-logger) [](https://codecov.io/gh/willin/koa-api-logger) [](https://travis-ci.org/willin/koa-api-logger)
[中文说明](https://github.com/willin/koa-api-logger/blob/master/README_zh.md#koa-api-logger)
## Usage
### Install
```bash
yarn add koa-api-logger
# or
npm i -S koa-api-logger
```
### Use
```js
const Koa = require('koa');
const router = require('koa-router')();
const logger = require('koa-api-logger');
const app = new Koa();
app.use(
logger({
// options
})
);
router.get('/user/:name', ctx => {
ctx.body = name;
});
app.use(router.routes()).use(router.allowedMethods());
app.listen(3000);
```
### Options
```js
{
err: async (ctx, err) => {
// codes to handle error
},
// Such as: ['/upload']
ignore: [],
redis: {
host: '127.0.0.1',
port: 6379,
db: 0, // db to store
keyPrefix: 'kal:', // redis store prefix
ttl: 86400 * 180 // saving logs for 180 days
}
}
```
## Design
### Redis Hash Table
`key:20170808`
| key | val |
| -------- | ------------------------------------- |
| total | {count:1,success:1,avg:1,max:1,min:1} |
| /#{path} | {count:1,success:1,avg:1,max:1,min:1} |
## Monitor
```js
const monitor = require('koa-api-logger/monitor');
const appName = monitor({
host: '127.0.0.1',
port: 6379,
db: 0,
keyPrefix: 'kal:'
});
appName('20170808').then(data => console.log);
/* like:
[
{
key: 'total',
data: { count: 2, success: 2, avg: 0.5, max: 1, min: 0 }
},
{
key: 'GET::/user/:name',
data: { count: 3, success: 3, avg: 0.3333333333333333, max: 1, min: 0 }
}
]
*/
```
History:
```js
appName.history().then(data => console.log);
/* like:
[
'20170504',
'20170505'
]
*/
```
## License
MIT
Donate Via Alipay：
