![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@valora/logging
Advanced tools
Readme
Thin wrapper for bunyan structured logs on Google Cloud and local development, with sensitive data redaction.
yarn add @valora/logging
import { createLogger } from '@valora/logging'
const logger = createLogger({
level: 'info', // Optional, defaults to `LOG_LEVEL` env var or 'info'
})
logger.info({ foo: bar }, 'Hello world!')
logger.warn(err, 'A non fatal error')
logger.warn({ err, foo: bar }, 'A non fatal error')
logger.error(err, 'Something went wrong')
logger.error({ err, foo: bar }, 'Something went wrong')
import { createLogger } from '@valora/logging'
const logger = createLogger({
redact: {
paths: [
'req.headers.authorization',
'req.headers.cookie',
'req.body.token',
'*.password',
],
},
})
// The authorization header and the other fields will be redacted
logger.info({ req }, 'Request')
// Password will be redacted
logger.info({ foo: { password: 'secret' } }, 'Password redacted')
This functionality is built on top of fast-redact.
There's also some good documentation from pino which uses the same library.
The global replace feature, allows replacing patterns anywhere in the log record. This is useful for redacting sensitive data that isn't tied to a specific known field. e.g. phone numbers, emails, etc.
import { createLogger } from '@valora/logging'
const logger = createLogger({
redact: {
globalReplace: (value: string) => {
// replaces values that look like phone numbers
// `%2B` is the URL encoded version of `+`
return value.replace(
/(?:\+|%2B)[1-9]\d{1,14}/gi,
(phoneNumber) => phoneNumber.slice(0, -4) + 'XXXX',
)
},
},
})
// will redact the phone number both in the message and in the logged object.
logger.info({ a: { b: { c: 'Call me at +1234567890' } } }, "A message with a phone number: +123456789"
The middleware will automatically log the request and response.
It also shows nicely formatted request logs for Cloud Functions in Logs Explorer (App Engine does this automatically).
Examples in Logs Explorer with a Cloud Function:
And locally:
Warning Be mindful of the sensitive data you may log. The middleware will log the request body, so make sure you also setup the appropriate
redact
config in the logger.
With Express:
import express from 'express'
const app = express()
app.use(createLoggingMiddleware({ projectId: 'test-project', logger }))
With Google Cloud Functions:
import { http } from '@google-cloud/functions-framework'
const loggingMiddleware = createLoggingMiddleware({
projectId: 'test-project',
logger,
})
http('myFunction', (req, res) =>
loggingMiddleware(req, res, () => {
res.send('Hello World!')
}),
)
FAQs
[![GitHub License](https://img.shields.io/github/license/valora-inc/logging?color=blue)](https://github.com/valora-inc/logging/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/@valora/logging.svg)](https://www.npmjs.com/package/@valora/logg
The npm package @valora/logging receives a total of 1,989 weekly downloads. As such, @valora/logging popularity was classified as popular.
We found that @valora/logging demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.