Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ysocorp/koa-logger-middleware
https://github.com/ysocorp/koa-logger-middleware
koa-log koa-logger koa-logger-winston koa-winston logger-middleware winstonjs
Last synced: 27 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ysocorp/koa-logger-middleware
- Owner: ysocorp
- License: mit
- Created: 2018-03-10T13:49:11.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-10T19:22:22.000Z (almost 7 years ago)
- Last Synced: 2024-11-16T16:26:46.321Z (about 2 months ago)
- Topics: koa-log, koa-logger, koa-logger-winston, koa-winston, logger-middleware, winstonjs
- Language: JavaScript
- Size: 112 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# koa-logger-middleware, a logger middleware for koa2 with **color** and customizable logger as **winstonjs**
[](https://npmjs.org/package/koa-logger-middleware "View this project on NPM")
## **Install**
```js
npm install --save koa-logger-middleware
// or
yarn add koa-logger-middleware
```
## **Use**
```js
import logger form 'koa-logger-middleware'
app.use(logger({
// your options
}));
```
## **Options**: to see all option refer to index.js file
* **correlactionId**: [Boolean] - add an correlactionId and set header X-Correlation-Id to it.
* **logger**: [Object] - eg: winstonjs, by default is console with coloration.
```js
const winstonLogger = winston.createLogger({
level: 'info',
format: winston.format.json(),
transports: [
new winston.transports.Console({
format: winston.format.simple(),
colorize: true,
})
]
});
logger({ logger: winstonLogger });
```
* **onStartFormat**: [Function] - format the string to log on request start:
```js
logger({
onStartFormat(ctx) {
const { start } = ctx.__logger;
return `START: ${this.dateFormat(start)} - ${ctx.method} ${ctx.url}`;
},
});
```
* **onErrorFormat**: [Function] - same as onStartFormat but when error occurred
* **onEndFormat**: [Function] - same as onStartFormat but on response end
* **fillInfo**: [Function] - information that will be pass to the logger as 2 parameter.
It can be usefull for example when you want to parse log to analize them or use it as big data
```js
logger({
fillInfo(ctx) {
ctx.__logInfo = ctx.state.__logInfo = {
query: ctx.request.query,
method: ctx.request.method,
url: ctx.request.url,
DeviceId: ctx.request.get('DeviceId'),
path: ctx.request.path,
ip: ctx.request.ip,
host: ctx.request.host,
protocol: ctx.request.protocol,
...
};
},
});
```
* **onError**: [Function] - call when an error occurred. Here you can handle error are whatever
## License
MIT © [YSO Corp](http://ysocorp.com/)