@google-cloud/pino-logging-gcp-config

中文文档
1.3.6发布于 2026/09/02Apache-2.0TypeScriptCommonJS近 30 天下载 182.3万

Module to create a basic Pino LoggerConfig to support Google Cloud structured logging

原始使用文档
文档目录7 节
  1. Features
  2. Example usage
  3. 1: Install required dependencies
  4. 2: Import the modules
  5. 3: Initialise Pino Logger with the GCP logging configuration
  6. 4: Use Pino normally to log messages and stack traces
  7. Example output

Pino Google Cloud Logging configuration for Node.JS

This library contains the code to generate a Pino configuration which outputs JSON structured logs for Google Cloud Logging.

This can be used with any Google Cloud service that captures logs written to stdout (such as Cloud Run, Cloud Run Functions and Google Kubernetes Engine workloads), so that the logging is formatted correctly in Google Cloud Logging. This then allows filtering by log level, the ability to include structured data in the logs, and reporting of errors with stack traces to Google Cloud Error Reporting

Features

  • Converts Pino log levels to Google Cloud Logging log levels.
  • Uses message instead of msg for the message key.
  • Adds a millisecond-granularity timestamp in a format recognised by Google Cloud Logging, eg: "timestamp":{"seconds":1445470140,"nanos":123000000}.
  • Adds a sequential insertId to ensure log messages with identical timestamps are ordered correctly.
  • Logs including an Error object have the stack_trace property set so that the error is forwarded to Google Cloud Error Reporting.
  • Includes a ServiceContext object in the logs for Google Cloud Error Reporting.
  • Maps the OpenTelemetry properties span_id, trace_id, trace_flags to the equivalent Google Cloud Logging fields.
  • User-defined formatters.log is always executed as-is, before GCP formatting.

Example usage

1: Install required dependencies

npm install --save pino @google-cloud/pino-logging-gcp-config

2: Import the modules

Using Typescript / ES Modules:

import as pino from 'pino';
import {createGcpLoggingPinoConfig} from '@google-cloud/pino-logging-gcp-config';

Using Javascript / CommonJS:

const pino = require('pino');
const {createGcpLoggingPinoConfig} = require('@google-cloud/pino-logging-gcp-config');

3: Initialise Pino Logger with the GCP logging configuration

The ServiceContext (used by Cloud Error Reporting) can either be specified manually, along with any Pino logging options such as the default log level:

const logger = pino.pino(
  createGcpLoggingPinoConfig(
    {
      serviceContext: {
        service: 'my-service',
        version: '1.2.3',
      },
    },
    {
      // set Pino log level to 'debug'
      level: 'debug',
    }
  )
);

Or using the defaults, the service name is auto-detected from the GCP environment:

const logger = pino.pino(createGcpLoggingPinoConfig());

4: Use Pino normally to log messages and stack traces

// 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'
);

Example output

Each log message will be output as a single line of JSON text. The output below has been reformatted to multiple lines for clarity.

  {
    "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"
  }

This output will show up in Cloud Logging as in this screenshot (the second and third log messages have been expanded to show the stack trace and the additional log properties)

Screenshot from Cloud Logging

The Error with the stack trace will also show up in Cloud Error Reporting, with the Service name and version specified in the ServiceContext.

Screenshot from Cloud Error Reporting

版本与发布记录

@google-cloud/pino-logging-gcp-config 共发布 14 个版本,首次发布于 2024/08/06;过去 12 个月发布了 4 个版本。

版本发布日期距今
1.3.6latest2026/09/022 个月前
1.3.52026/05/076 个月前
1.3.32026/02/208 个月前
1.3.12025/12/1211 个月前
1.3.02025/11/131 年前
1.2.02025/09/151.2 年前

关于 @google-cloud/pino-logging-gcp-config 的常见问题

@google-cloud/pino-logging-gcp-config 是什么?

Module to create a basic Pino LoggerConfig to support Google Cloud structured logging

如何安装 @google-cloud/pino-logging-gcp-config?

在项目目录运行 npm install @google-cloud/pino-logging-gcp-config,或使用 pnpm add / yarn add / bun add。

@google-cloud/pino-logging-gcp-config 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@google-cloud/pino-logging-gcp-config 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@google-cloud/pino-logging-gcp-config 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20.20.2。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@google-cloud/pino-logging-gcp-config 可以商用吗?

@google-cloud/pino-logging-gcp-config 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@google-cloud/pino-logging-gcp-config 的下载量有多少?

根据 npm 官方下载统计,@google-cloud/pino-logging-gcp-config 在 2026/10/17 – 2026/11/15 这 30 天内被下载 1,823,332 次,日均约 60,778 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@google-cloud/pino-logging-gcp-config 还在维护吗?

最新版本 1.3.6 发布于 2026/09/02(2 个月前);至今共发布 14 个版本,其中过去 12 个月发布了 4 个;首次发布于 2024/08/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。