Skip to content

Commit

Permalink
Update README, description
Browse files Browse the repository at this point in the history
  • Loading branch information
keenondrums committed Feb 28, 2019
1 parent ce53f08 commit 801a259
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# cls-proxify [![Build Status](https://travis-ci.org/keenondrums/cls-proxify.svg?branch=master)](https://travis-ci.org/keenondrums/cls-proxify) [![Coverage Status](https://coveralls.io/repos/github/keenondrums/cls-proxify/badge.svg?branch=master)](https://coveralls.io/github/keenondrums/cls-proxify?branch=master) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=A%20small%20library%20that%20proxies%20any%20arbitrary%20object%20with%20a%20proxy%20from%20CLS.%20Super-useful%20for%20logging.&url=https://github.com/keenondrums/cls-proxify&hashtags=javascript,library,nodejs,cls,proxy,logging)

A small library that proxies any arbitrary object with a proxy from [CLS](https://github.com/jeff-lewis/cls-hooked) if found one. Super-useful for creating child loggers per each request with dynamic context from the request itself (e.g. adding request trace ID, adding request payload). Integrated with [express](https://github.com/expressjs/express), [koa](https://github.com/koajs/koa), [fastify](https://github.com/fastify/fastify) out-of-the-box.
Logging on steroids with CLS and Proxy. A small library that proxies any arbitrary object with a proxy from [CLS](https://github.com/jeff-lewis/cls-hooked) if found one. Super-useful for creating child loggers per each request with dynamic context from the request itself (e.g. adding request trace ID, adding request payload). Integrated with [express](https://github.com/expressjs/express), [koa](https://github.com/koajs/koa), [fastify](https://github.com/fastify/fastify) out-of-the-box.

Many thanks to [@mcollina](https://github.com/mcollina) for the idea of combining [Proxy](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) and [CLS](https://github.com/jeff-lewis/cls-hooked).

Expand Down Expand Up @@ -215,7 +215,7 @@ Take a look at [the tests](https://github.com/keenondrums/cls-proxify/blob/maste

### My context got lost

Note that some middlewares may cause CLS context to get lost. To avoid such issues, you should use any third party middleware that does not need access to request ids before you use this middleware.
Note that some middlewares may cause CLS context to get lost. To avoid it use any third party middleware that does not need access to request ids before you use this middleware.

### I'm experiencing a memory leak

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "cls-proxify",
"version": "1.0.1",
"description": "Proxy any arbitrary object with a proxy from CLS. Integrated with express, koa, fastify. Super-useful for logging.",
"description": "Logging on steroids with CLS and Proxy. Integrated with express, koa, fastify.",
"main": "core.js",
"dependencies": {},
"devDependencies": {
Expand Down

0 comments on commit 801a259

Please sign in to comment.