logging
所属分类：云计算
开发工具：TypeScript
文件大小：639KB
下载次数：0
上传日期：2023-06-05 11:34:01
上 传 者：
sh-1993
说明： 谷歌云和本地开发上的bunyan结构化日志的瘦包装器，具有敏感的数据编校。
(Thin wrapper for bunyan structured logs on Google Cloud and local development, with sensitive data redaction.)
文件列表:
.eslintrc.js (313, 2023-09-07)
.prettierignore (106, 2023-09-07)
.vscode (0, 2023-09-07)
.vscode\settings.json (137, 2023-09-07)
LICENSE (11357, 2023-09-07)
docs (0, 2023-09-07)
docs\images (0, 2023-09-07)
docs\images\logs-gcf-expanded.png (140722, 2023-09-07)
docs\images\logs-gcf-warn-expanded.png (212606, 2023-09-07)
docs\images\logs-gcf.png (44599, 2023-09-07)
docs\images\logs-local.png (115264, 2023-09-07)
jest.config.js (568, 2023-09-07)
jest.setup.js (25, 2023-09-07)
package.json (2567, 2023-09-07)
renovate.json5 (68, 2023-09-07)
scripts (0, 2023-09-07)
scripts\example.ts (173, 2023-09-07)
scripts\tsconfig.json (231, 2023-09-07)
src (0, 2023-09-07)
src\logging.test.ts (23429, 2023-09-07)
src\logging.ts (8767, 2023-09-07)
src\tsconfig.json (281, 2023-09-07)
tsconfig.json (557, 2023-09-07)
tsconfig.test.json (99, 2023-09-07)
yarn.lock (357023, 2023-09-07)
# @valora/logging
[](https://github.com/valora-inc/logging/blob/main/LICENSE)
[](https://www.npmjs.com/package/@valora/logging)
[](https://github.com/valora-inc/logging/actions/workflows/workflow.yaml?query=branch%3Amain)
[](https://codecov.io/gh/valora-inc/logging)
[](https://github.com/valora-inc/logging#contributing)
Thin wrapper for bunyan structured logs on Google Cloud and local development, with sensitive data redaction.
## Installing the library
```
yarn add @valora/logging
```
## Using the library
### Simple usage
```typescript
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')
```
### Redacting sensitive data
#### Redacting specific fields
```typescript
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](https://github.com/davidmarkclements/fast-redact).
There's also some good documentation from [pino](https://github.com/pinojs/pino/blob/master/docs/redaction.md) which uses the same library.
#### Redacting patterns
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.
```typescript
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"
```
### Logging middleware
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:
```typescript
import express from 'express'
const app = express()
app.use(createLoggingMiddleware({ projectId: 'test-project', logger }))
```
With Google Cloud Functions:
```typescript
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!')
}),
)
```
## Resources
- [bunyan](https://github.com/trentm/node-bunyan)
- [@google-cloud/logging-bunyan](https://github.com/googleapis/nodejs-logging-bunyan)
- [@google-cloud/logging](https://github.com/googleapis/nodejs-logging)
## Contributing
- [Reporting issues](https://github.com/valora-inc/logging/issues)
- [Submitting a pull request](https://github.com/valora-inc/logging/pulls)
- Publishing updates is done automatically via [semantic-release](https://github.com/semantic-release/semantic-release).
Remember to use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) or your PR will be rejected (since
merging it would mess up the changelog and version numbers).
近期下载者：
相关文件：
收藏者：