Pino Google 节点云日志配置
此库包含生成 Pino 配置的代码, 用于输出 JSON 用于谷歌云日志的结构日志。 。 。 .
用于获取日志的 Google Cloud 服务 stdout( 如 Cloud Run, Cloud Run 函数和 Google Kubernetes 引擎) ,以便记录格式正确 谷歌云记录。然后允许 按日志级别过滤,将结构化数据纳入日志的能力,以及 报告有堆栈痕迹的错误 谷歌云出错报告
特征
- 将 Pino 日志级别转换为 Google 云日志级别 .
- 用途
message改为msg为消息密钥. - 在 a 中添加毫秒角时间戳
由 Google 云日志识别的格式, (中文(简体) ),
例如:
"timestamp":{"seconds":1445470140,"nanos":123000000}。 。 。 . - 添加顺序 插入图像 以确保有相同时间戳的日志信息被正确命令.
- 包含错误对象的日志有: 堆栈属性( t) 设置,使错误被传送到 Google Cloud 错误报告.
- 包括a 服务内容 google Cloud 错误报告日志中的对象.
- 映射 OpenTelection 属性
span_id, (中文(简体) ),trace_id, (中文(简体) ),trace_flags页:1 等值单位 谷歌云日志字段。 。 。 . - 用户定义
formatters.log总是在GCP格式化之前按原样执行.
示例用途
1: 安装所需依赖关系
npm install --save pino @google-cloud/pino-logging-gcp-config
2: 导入模块
使用 Typescription / ES 模块 :
import as pino from 'pino';
import {createGcpLoggingPinoConfig} from '@google-cloud/pino-logging-gcp-config';
使用 Javascript / commonJS :
const pino = require('pino');
const {createGcpLoggingPinoConfig} = require('@google-cloud/pino-logging-gcp-config');
3: 初始化 Pino Logger 与 GCP 日志配置
这个 服务内容 (使用时间: 云出错报告(中文(简体) ) 可以手动指定, 以及任何 Pino 日志选项, 如 默认日志级别 :
const logger = pino.pino(
createGcpLoggingPinoConfig(
{
serviceContext: {
service: 'my-service',
version: '1.2.3',
},
},
{
// set Pino log level to 'debug'
level: 'debug',
}
)
);
或使用默认值,服务名称由GCP自动检测 环境:
const logger = pino.pino(createGcpLoggingPinoConfig());
4: 正常使用 Pino 记录信件并堆放痕迹
// Simple log message:
logger.info('hello world');
// Logging an exception:
const err = new Error('some exception');
logger.error(err, 'Caught an exception: %s', err);
// Logging with some additional properties, which can be used as searchable
// values in Cloud Logging:
logger.debug(
{
someProperties: 'some value',
},
'logging with extra properties'
);
示例输出
每个日志消息将作为JSON文本的一行输出. 以下产出 已重新调整为多行,以明确.
{
"severity": "INFO",
"level": 30,
"timestamp": {
"seconds": 1730802506,
"nanos": 375000000
},
"pid": 601658,
"hostname": "myHostName",
"logging.googleapis.com/insertId": "..........40FL7.zwt0uNYGdcmFiUn_",
"serviceContext": {
"service": "my-service",
"version": "1.2.3"
},
"message": "hello world"
}
{
"severity": "ERROR",
"level": 50,
"timestamp": {
"seconds": 1730802506,
"nanos": 377000000
},
"pid": 601658,
"hostname": "myHostName",
"err": {
"type": "Error",
"message": "some exception",
"stack": "Error: some exception\n at Object.<anonymous> (/some/dir/pino-logging-gcp-config/build/src/example.js:14:13)\n at Module._compile (node:internal/modules/cjs/loader:1434:14)\n at Module._extensions..js (node:internal/modules/cjs/loader:1518:10)\n at Module.load (node:internal/modules/cjs/loader:1249:32)\n at Module._load (node:internal/modules/cjs/loader:1065:12)\n at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:158:12)\n at node:internal/main/run_main_module:30:49"
},
"logging.googleapis.com/insertId": "..........80FL7.zwt0uNYGdcmFiUn_",
"serviceContext": {
"service": "my-service",
"version": "1.2.3"
},
"stack_trace": "Error: some exception\n at Object.<anonymous> (/some/dir/pino-logging-gcp-config/build/src/example.js:14:13)\n at Module._compile (node:internal/modules/cjs/loader:1434:14)\n at Module._extensions..js (node:internal/modules/cjs/loader:1518:10)\n at Module.load (node:internal/modules/cjs/loader:1249:32)\n at Module._load (node:internal/modules/cjs/loader:1065:12)\n at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:158:12)\n at node:internal/main/run_main_module:30:49",
"message": "Caught an exception: Error: some exception"
}
{
"severity": "DEBUG",
"level": 20,
"timestamp": {
"seconds": 1730802506,
"nanos": 378000000
},
"pid": 601658,
"hostname": "myHostName",
"someProperties": "some value",
"logging.googleapis.com/insertId": "..........C0FL7.zwt0uNYGdcmFiUn_",
"serviceContext": {
"service": "my-service",
"version": "1.2.3"
},
"message": "logging with extra properties"
}
这个输出将像这个截图一样出现在 Cloud Looking (第二个和 第三个日志信件已经扩展, 以显示堆栈跟踪和附加 日志属性)

带有堆栈追踪的错误也会在 Cloud Error Reporting 中出现, 与 在服务Context中指定的服务名称和版本.
