Package Health Score

66 / 100

security
Security review needed
popularity
Small
maintenance
Healthy
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
3.2.1	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.1.1	\|	11/2018	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.5.1	\|	07/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.6.5	\|	08/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.7.1	\|	08/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (6,655)

GitHub Stars: 38
Forks: 6
Contributors: 5

Direct Usage Popularity

The npm package koa2-winston receives a total of 6,655 downloads a week. As such, we scored koa2-winston popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package koa2-winston, we found that it has been starred 38 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 5
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like koa2-winston is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 3
Open PR: 15
Last Release: 28 days ago
Last Commit: 28 days ago

Further analysis of the maintenance status of koa2-winston based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that koa2-winston demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=8

Age: 8 years
Dependencies: 7 Direct
Versions: 29
Install Size: 52.1 kB
Dist-tags: 1
# of Files: 9
Maintainers: 1
TS Typings: No

koa2-winston has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

koa2-winston

GitHub Action

koa2 version winston logger like express-winston

Add logger to your koa2 server in 3 lines

中文介绍

Usage

Installation

npm i --save koa2-winston

Quick Start

const { logger } = require('koa2-winston');
app.use(logger());

request log will look like

{
  "req": {
    "header": {
      "host": "localhost:3000",
      "connection": "keep-alive",
      "upgrade-insecure-requests": "1",
      "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36",
      "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
      "dnt": "1",
      "accept-encoding": "gzip, deflate, sdch, br",
      "accept-language": "zh-CN,zh;q=0.8,en;q=0.6,zh-TW;q=0.4,de;q=0.2,ja;q=0.2,it;q=0.2"
    },
    "url": "/hello",
    "method": "GET",
    "href": "https://localhost:3000/hello",
    "query": {}
  },
  "started_at": 1494554053492,
  "res": {
    "header": {
      "content-type": "application/json; charset=utf-8",
      "content-length": "16"
    },
    "status": 200
  },
  "duration": 8,
  "level": "info",
  "message": "HTTP GET /hello"
}

Configuration

Each parameter has a default value, and you can customize your logger by changing the configuration

app.use(
  logger({
    transports: new winston.transports.Console({ json: true, stringify: true }),
    level: 'info',
    reqKeys: [
      'header',
      'url',
      'method',
      'httpVersion',
      'href',
      'query',
      'length',
    ],
    reqSelect: [],
    reqUnselect: ['header.cookie'],
    resKeys: ['header', 'status'],
    resSelect: [],
    resUnselect: [],
  })
);

Many configuration explain can be found in logger

Examples

Do not record any request fields

app.use(
  logger({
    reqKeys: [],
  })
);

The req object will be empty

{
  "req": {},
  "started_at": 1494486039864,
  "res": {
    "header": {
      "content-type": "text/plain; charset=utf-8",
      "content-length": "8"
    },
    "status": 200
  },
  "duration": 26,
  "level": "info",
  "message": "HTTP GET /"
}

Do not record any response fields

app.use(
  logger({
    resKeys: [],
  })
);

The res object will be empty

{
  "req": {
    "header": {
      "host": "127.0.0.1:59534",
      "accept-encoding": "gzip, deflate",
      "user-agent": "node-superagent/3.5.2",
      "connection": "close"
    },
    "url": "/",
    "method": "GET",
    "href": "https://127.0.0.1:59534/",
    "query": {}
  },
  "started_at": 1494486039864,
  "res": {},
  "duration": 26,
  "level": "info",
  "message": "HTTP GET /"
}

Do not record UA

app.use(
  logger({
    reqUnselect: ['header.cookie', 'header.user-agent'],
  })
);

The UA of request will be ignored

{
  "req": {
    "header": {
      "host": "127.0.0.1:59534",
      "accept-encoding": "gzip, deflate",
      "connection": "close"
    },
    "url": "/",
    "method": "GET",
    "href": "https://127.0.0.1:59534/",
    "query": {}
  },
  "started_at": 1494486039864,
  "res": {
    "header": {
      "content-type": "text/plain; charset=utf-8",
      "content-length": "8"
    },
    "status": 200
  },
  "duration": 26,
  "level": "info",
  "message": "HTTP GET /"
}

Record a response body filed

app.use(
  logger({
    resSelect: ['body.success'],
  })
);

The success field on body will be recorded

{
  "req": {
    "header": {
      "host": "127.0.0.1:59534",
      "accept-encoding": "gzip, deflate",
      "connection": "close"
    },
    "url": "/",
    "method": "GET",
    "href": "https://127.0.0.1:59534/",
    "query": {}
  },
  "started_at": 1494486039864,
  "res": {
    "header": {
      "content-type": "text/plain; charset=utf-8",
      "content-length": "8"
    },
    "status": 200,
    "body": {
      // Any possible value given by the server
      "success": false
    }
  },
  "duration": 26,
  "level": "info",
  "message": "HTTP GET /"
}

Simple Benchmark

At node 8.2

middleware x 90,281 ops/sec ±7.89% (13 runs sampled)

At node 8.4

middleware x 112,011 ops/sec ±10.26% (18 runs sampled)

Schema Stringify

With fast-json-stringify support, default transport logger is much faster

total ops/sec { jsonstringify: 73544 }
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
total ops/sec { schemastringify: 90223 }
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓

schemastringify is 1.23x faster then jsonstringify in this case

v1.7.1 vs v2.4.0

total ops/sec { 'v1.7.1': 111416 }
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
total ops/sec { 'v2.4.0': 131234 }
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓

v2.4.0 is 1.18x faster then v1.7.1 in this case

Math.floor vs parseInt

Related commit in HERE

JSPerf link in HERE

Testing in Chrome 70.0.3505 / Mac OS X 10.13.5

parseInt(401 / 100, 10) { 160,092,130 Ops/sec }
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
Math.floor(401 / 100) { 810,032,369 Ops/sec }
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓

Math.floor is 5.06x faster then parseInt in this case

v3

Finally, winston v3 support. But winston will install as dependencies not peerDependencies.

With better backward compatibility, users don't have to worry about the new version of koa2-winston will conflict with other winston usage in the project.

v3.1

The fastest koa2-winston ever. Nearly 3x faster than previous versions.

total ops/sec { 'v3.0.2': 180020 }
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
total ops/sec { 'v3.1.0': 541854 }
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓

> The above statistics come from npm run bench.

Biggest change

Remove key recorder
Generate json-schema for fast-json-stringify, not only for object serialization (log message), but also as key selector.
Log info object key rename.
```
- {req,res}.headers
+ {req,res}.header
```

JSDoc

logger

logger middleware for koa2 use winston

Parameters

payload object input arguments (optional, default {})
- payload.transports Array<object> customize transports (optional, default [newwinston.transports.Stream({stream:process.stdout})])
- payload.level string default log level of logger (optional, default 'info')
- payload.reqKeys string default request fields to be logged (optional, default ['header','url','method','httpVersion','href','query','length'])
- payload.reqSelect string additional request fields to be logged (optional, default [])
- payload.reqUnselect string request field will be removed from the log (optional, default ['header.cookie'])
- payload.resKeys string default response fields to be logged (optional, default ['header','status'])
- payload.resSelect string additional response fields to be logged (optional, default [])
- payload.resUnselect string response field will be removed from the log (optional, default [])
- payload.logger winston.transports.StreamTransportInstance? customize winston logger
- payload.msg string customize log msg (optional, default HTTP%s%s)

Examples

const { logger } = require('koa2-winston');
app.use(logger());
// request logger look like down here
// {
//   "req": {
//     "header": {
//       "host": "127.0.0.1:59534",
//       "accept-encoding": "gzip, deflate",
//       "user-agent": "node-superagent/3.5.2",
//       "connection": "close"
//     },
//     "url": "/",
//     "method": "GET",
//     "href": "https://127.0.0.1:59534/",
//     "query": {}
//   },
//   "started_at": 1494486039864,
//   "res": {
//     "header": {
//       "content-type": "text/plain; charset=utf-8",
//       "content-length": "8"
//     },
//     "status": 200
//   },
//   "duration": 26,
//   "level": "info",
//   "message": "HTTP GET /"
// }

Returns function logger middleware

asJsonSchemaPath

Parameters

path string

ensureTypeObject

Parameters

schema object generated json schema

schemaKeysHandlerFn

Type: Function

Parameters

path string

schemaKeysHandler

Parameters

keys Array<string> schema keys
handler schemaKeysHandlerFn assign path

generateSchema

logger middleware for koa2 use winston

Parameters

payload object input arguments (optional, default {})
- payload.reqKeys Array<string> default request fields to be logged (optional, default ['header','url','method','httpVersion','href','query','length'])
- payload.reqSelect Array<string> additional request fields to be logged (optional, default [])
- payload.reqUnselect Array<string> request field will be removed from the log (optional, default ['header.cookie'])
- payload.resKeys Array<string> default response fields to be logged (optional, default ['header','status'])
- payload.resSelect Array<string> additional response fields to be logged (optional, default [])
- payload.resUnselect Array<string> response field will be removed from the log (optional, default [])

koa2-winston dependencies

fast-json-stringify lodash.clonedeep lodash.get lodash.mapvalues lodash.set on-finished winston

koa2-winston development dependencies

@types/node ava benchmark documentation eslint eslint-config-airbnb-base eslint-plugin-import koa koa-bodyparser lodash lodash.assign nyc supertest triple-beam winston-transport

FAQs

What is koa2-winston?

koa2 version winston logger like express-winston. Visit Snyk Advisor to see a full health score report for koa2-winston, including popularity, security, maintenance & community analysis.

Is koa2-winston popular?

The npm package koa2-winston receives a total of 6,655 weekly downloads. As such, koa2-winston popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is koa2-winston well maintained?

We found that koa2-winston demonstrated a healthy version release cadence and project activity. It has a community of 5 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is koa2-winston safe to use?

While scanning the latest version of koa2-winston, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 21 November-2024, at 15:54 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (6,655)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

koa2-winston

Usage

Installation

Quick Start

Configuration

Examples

Do not record any request fields

Do not record any response fields

Do not record UA

Record a response body filed

Simple Benchmark

Schema Stringify

v1.7.1 vs v2.4.0

Math.floor vs parseInt

v3

v3.1

JSDoc

Table of Contents

logger

Parameters

Examples

asJsonSchemaPath

Parameters

ensureTypeObject

Parameters

schemaKeysHandlerFn

Parameters

schemaKeysHandler

Parameters

generateSchema

Parameters

koa2-winston dependencies

koa2-winston development dependencies

FAQs

What is koa2-winston?

Is koa2-winston popular?

Is koa2-winston well maintained?

Is koa2-winston safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues