@google-cloud/logging-bunyan

中文文档
6.3.0发布于 2026/10/13Apache-2.0TypeScriptCommonJS近 30 天下载 51.6万

Cloud Logging stream for Bunyan

原始使用文档
文档目录17 节
  1. Quickstart
  2. Before you begin
  3. Installing the client library
  4. Using the client library
  5. Using as an express middleware
  6. Error Reporting
  7. Special Payload Fields in LogEntry
  8. LogEntry Labels
  9. Formatting Request Logs
  10. Correlating Logs with Traces
  11. Error handling with a default callback
  12. Alternative way to ingest logs in Google Cloud managed envi…
  13. Samples
  14. Supported Node.js Versions
  15. Versioning
  16. Contributing
  17. License

Google Cloud Platform logo

Cloud Logging for Bunyan: Node.js Client

release level npm version

This module provides an easy to use, higher-level layer for working with Cloud Logging, compatible with Bunyan. Simply attach this as a transport to your existing Bunyan loggers.

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable the Cloud Logging for Bunyan API.
  3. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/logging-bunyan

Using the client library

const bunyan = require('bunyan');

// Imports the Google Cloud client library for Bunyan
const {LoggingBunyan} = require('@google-cloud/logging-bunyan');

// Creates a Bunyan Cloud Logging client
const loggingBunyan = new LoggingBunyan();

// Create a Bunyan logger that streams to Cloud Logging
// Logs will be written to: "projects/YOUR_PROJECT_ID/logs/bunyan_log"
const logger = bunyan.createLogger({
  // The JSON payload of the log as it appears in Cloud Logging
  // will contain "name": "my-service"
  name: 'my-service',
  streams: [
    // Log to the console at 'info' and above
    {stream: process.stdout, level: 'info'},
    // And log to Cloud Logging, logging at 'info' and above
    loggingBunyan.stream('info'),
  ],
});

// Writes some log entries
logger.error('warp nacelles offline');
logger.info('shields at 99%');

Using as an express middleware

NOTE: this feature is experimental. The API may change in a backwards incompatible way until this is deemed stable. Please provide us feedback so that we can better refine this express integration.

We provide a middleware that can be used in an express application. Apart from being easy to use, this enables some more powerful features of Cloud Logging: request bundling. Any application logs emitted on behalf of a specific request will be shown nested inside the request log as you see in this screenshot:

Request Bundling Example

The middleware adds a bunyan-style log function to the request object. You can use this wherever you have access to the request object (req in the sample below). All log entries that are made on behalf of a specific request are shown bundled together in the Cloud Logging UI.

const lb = require('@google-cloud/logging-bunyan');

// Import express module and create an http server.
const express = require('express');

async function startServer() {
  const {logger, mw} = await lb.express.middleware();
  const app = express();

  // Install the logging middleware. This ensures that a Bunyan-style `log`
  // function is available on the `request` object. Attach this as one of the
  // earliest middleware to make sure that log function is available in all the
  // subsequent middleware and routes.
  app.use(mw);

  // Setup an http route and a route handler.
  app.get('/', (req, res) => {
    // `req.log` can be used as a bunyan style log method. All logs generated
    // using `req.log` use the current request context. That is, all logs
    // corresponding to a specific request will be bundled in the Cloud UI.
    req.log.info('this is an info log message');
    res.send('hello world');
  });

  // `logger` can be used as a global logger, one not correlated to any specific
  // request.
  logger.info({port: 8080}, 'bonjour');

  // Start listening on the http server.
  app.listen(8080, () => {
    console.log('http server listening on port 8080');
  });
}

startServer();

Error Reporting

Any Error objects you log at severity error or higher can automatically be picked up by Cloud Error Reporting if you have specified a serviceContext.service when instantiating a LoggingBunyan instance:

const loggingBunyan = new LoggingBunyan({
  serviceContext: {
    service: 'my-service', // required to report logged errors
                           // to the Google Cloud Error Reporting
                           // console
    version: 'my-version'
  }
});

It is an error to specify a serviceContext but not specify serviceContext.service.

Make sure to add logs to your uncaught exception and unhandled rejection handlers if you want to see those errors too.

You may also want to see the [@google-cloud/error-reporting][@google-cloud/error-reporting] module which provides direct access to the Error Reporting API.

Special Payload Fields in LogEntry

There are some fields that are considered special by Google cloud logging and will be extracted into the LogEntry structure. For example, severity, message and labels can be extracted to LogEntry if included in the bunyan log payload. These special JSON fields will be used to set the corresponding fields in the LogEntry. Please be aware of these special fields to avoid unexpected logging behavior.

LogEntry Labels

If the bunyan log record contains a label property where all the values are strings, we automatically promote that property to be the LogEntry.labels value rather than being one of the properties in the payload fields. This makes it easier to filter the logs in the UI using the labels.

logger.info({labels: {someKey: 'some value'}}, 'test log message');

All the label values must be strings for this automatic promotion to work. Otherwise the labels are left in the payload.

Formatting Request Logs

To format your request logs you can provide a httpRequest property on the bunyan metadata you provide along with the log message. We will treat this as the HttpRequest message and Cloud logging will show this as a request log. Example:

Request Log Example

logger.info({
  httpRequest: {
    status: res.statusCode,
    requestUrl: req.url,
    requestMethod: req.method,
    remoteIp: req.connection.remoteAddress,
    // etc.
  }
}, req.path);

The httpRequest property must be a properly formatted HttpRequest message. (Note: the linked protobuf documentation shows snake_case property names, but in JavaScript one needs to provide property names in camelCase.)

Correlating Logs with Traces

If you use [@google-cloud/trace-agent][trace-agent] module, then this module will set the Cloud Logging [LogEntry][LogEntry] trace property based on the current trace context when available. That correlation allows you to [view log entries][trace-viewing-log-entries] inline with trace spans in the Cloud Trace Viewer. Example:

Logs in Trace Example

If you wish to set the Cloud LogEntry trace property with a custom value, then write a Bunyan log entry property for 'logging.googleapis.com/trace', which is exported by this module as LOGGING_TRACE_KEY. For example:

const bunyan = require('bunyan');
// Node 6+
const {LoggingBunyan, LOGGING_TRACE_KEY} = require('@google-cloud/logging-bunyan');
const loggingBunyan = LoggingBunyan();

...

logger.info({
  [LOGGING_TRACE_KEY]: 'custom-trace-value'
}, 'Bunyan log entry with custom trace field');

Error handling with a default callback

The LoggingBunyan class creates an instance of Logging which creates the Log class from @google-cloud/logging package to write log entries. The Log class writes logs asynchronously and there are cases when log entries cannot be written when it fails or an error is returned from Logging backend. If the error is not handled, it could crash the application. One possible way to handle the error is to provide a default callback to the LoggingBunyan constructor which will be used to initialize the Log object with that callback like in the example below:

// Imports the Google Cloud client library for Bunyan
const {LoggingBunyan} = require('@google-cloud/logging-bunyan');
// Creates a client
const loggingBunyan = new LoggingBunyan({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
  defaultCallback: err => {
      if (err) {
      console.log('Error occured: ' + err);
      }
  },
});

Alternative way to ingest logs in Google Cloud managed environments

If you use this library with the Cloud Logging Agent, you can configure the handler to output logs to process.stdout using the structured logging Json format. To do this, add redirectToStdout: true parameter to the LoggingBunyan constructor as in sample below. You can use this parameter when running applications in Google Cloud managed environments such as AppEngine, Cloud Run, Cloud Function or GKE. The logger agent installed on these environments can capture process.stdout and ingest it into Cloud Logging. The agent can parse structured logs printed to process.stdout and capture additional log metadata beside the log payload. It is recommended to set redirectToStdout: true in serverless environments like Cloud Functions since it could decrease logging record loss upon execution termination - since all logs are written to process.stdout those would be picked up by the Cloud Logging Agent running in Google Cloud managed environment. Note that there is also a useMessageField option which controls if "message" field is used to store structured, non-text data inside jsonPayload field when redirectToStdout is set. By default useMessageField is always true. Set the skipParentEntryForCloudRun option to skip creating an entry for the request itself as Cloud Run already automatically creates such log entries. This might become the default behaviour in a next major version.

// Imports the Google Cloud client library for Bunyan
const {LoggingBunyan} = require('@google-cloud/logging-bunyan');

// Creates a client
const loggingBunyan = new LoggingBunyan({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
  redirectToStdout: true,
});

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource CodeTry it
Expresssource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Explict Auth Setupsource codeOpen in Cloud Shell

The Cloud Logging for Bunyan Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/logging-bunyan@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE

版本与发布记录

@google-cloud/logging-bunyan 共发布 61 个版本,首次发布于 2017/02/15;过去 12 个月发布了 6 个版本。

版本发布日期距今
6.3.0latest2026/10/131 个月前
6.2.02026/10/081 个月前
6.1.02026/09/162 个月前
6.0.12026/08/133 个月前
6.0.02026/08/053 个月前
5.1.2legacy-182026/06/055 个月前

其他发布通道:legacy-8 → 2.0.3,legacy-10 → 3.3.1,legacy-18 → 5.1.2。

关于 @google-cloud/logging-bunyan 的常见问题

@google-cloud/logging-bunyan 是什么?

Cloud Logging stream for Bunyan

如何安装 @google-cloud/logging-bunyan?

在项目目录运行 npm install @google-cloud/logging-bunyan,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:bunyan(*)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@google-cloud/logging-bunyan 支持 TypeScript 吗?

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

@google-cloud/logging-bunyan 支持 ESM 还是 CommonJS?

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

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

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

@google-cloud/logging-bunyan 可以商用吗?

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

@google-cloud/logging-bunyan 的下载量有多少?

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

@google-cloud/logging-bunyan 还在维护吗?

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