Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CabinJS to Redaction Alternatives (closes #850) #851

Closed
wants to merge 3 commits into from
Closed

Add CabinJS to Redaction Alternatives (closes #850) #851

wants to merge 3 commits into from

Conversation

niftylettuce
Copy link

No description provided.


## Alternatives

Alternatively to Pino's native redaction, [CabinJS](https://cabinjs.com) may serve your needs out of the box. CabinJS is a JavaScript logging package and middleware which automatically strips 1600+ sensitive field names, credit card numbers, BasicAuth headers, Social Security Numbers, JSON Web Tokens, API Keys, CSRF Tokens, Stripe Tokens, Passwords, Salts, Hashes, Bank Account Numbers, Bank Routing Numbers, and more. It also reduces disk storage costs by converting Stream, Buffer, and ArrayBuffer log data into simplified descriptive objects. Cabin also populates an `app` property in your log metadata which contains your packages name, version, node version, git hash, git tag, environment, hostname, and pid. If you use the widely popular [Passport](https://github.com/jaredhanson/passport) package, then it will even auto-add a user object for you to your log metadata. Lastly, it is a drop-in replacement and alternative to many existing logging solutions, including bunyan, and works great with pino plugged in out of the box. Read more at <https://cabinjs.com>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Please line break at ~80 characters.
  2. This reads as nothing more than an advertisement. Notice that the rest of this document introduces the feature by showing how to enable it and the effects redaction will have. Reading this text, I still don't know how I would use Cabin with Pino.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok cool I will patch and ping you back with example integration / code snippets added here. Great points @jsumners - thank you very much.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the vast majority of the text and add an example. I think the first sentence is ok.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very cool - can we add a note about performance characteristics of this approach. I’m assuming native redaction (fast-redact) will be significantly higher performance

In future I’d love to see a way for cabin and fast redact to work together (or at least to implement the same concept on fast redact)

Copy link
Member

@davidmarkclements davidmarkclements left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As noted

@mcollina mcollina closed this May 18, 2021
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants