Skip to content
Node.js client integration between Stackdriver Logging and Bunyan.
TypeScript Shell Batchfile JavaScript Python
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github build: switch to GitHub app for releases (#355) Sep 18, 2019
.kokoro build: switch to GitHub app for releases (#355) Sep 18, 2019
doc/images doc(middleware): add screenshot for bundling (#160) Sep 25, 2018
samples chore: release 1.2.3 (#349) Sep 3, 2019
src feat: add support for apiEndpoint override (#336) Jun 24, 2019
system-test chore(deps): update dependency @google-cloud/common to v2 (#324) May 28, 2019
test feat: add support for apiEndpoint override (#336) Jun 24, 2019
.cloud-repo-tools.json Repository Migration (#9) Nov 2, 2017
.eslintignore chore: update nyc and eslint configs (#230) Dec 11, 2018
.eslintrc.yml Enable prefer-const in the eslint config (#151) Sep 20, 2018
.gitignore feat: add .repo-metadata.json, generate docs (#328) Jun 2, 2019
.jsdoc.js docs: use the jsdoc-fresh theme (#343) Jul 31, 2019
.nycrc update .nycrc ignore rules (#352) Sep 6, 2019
.prettierignore Repository Migration (#9) Nov 2, 2017
.prettierrc Repository Migration (#9) Nov 2, 2017
.readme-partials.yml feat: add .repo-metadata.json, generate docs (#328) Jun 2, 2019
.repo-metadata.json fix: should read logging Bunyan not Winston (#330) Jun 13, 2019 chore: release 1.2.3 (#349) Sep 3, 2019 Repository Migration (#9) Nov 2, 2017 docs: update links in contrib guide (#263) Feb 14, 2019
LICENSE chore: update license file (#215) Dec 4, 2018 fix(docs): remove anchor from reference doc link (#348) Sep 3, 2019
codecov.yaml Update kokoro config (#171) Oct 2, 2018
linkinator.config.json build: use config file for linkinator (#340) Jun 28, 2019
package.json chore(deps): update dependency eslint-plugin-node to v10 (#351) Sep 5, 2019
renovate.json chore: ignore package-lock.json (#118) Aug 7, 2018
synth.metadata fix(docs): remove anchor from reference doc link (#348) Sep 3, 2019 build: check broken links in generated docs (#239) Jan 15, 2019
tsconfig.json chore: migrate the code to typescript (#18) Jan 10, 2018

Google Cloud Platform logo

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

release level npm version codecov

Stackdriver Logging stream for Bunyan

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

Table of contents:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable the Stackdriver Logging for Bunyan API.
  3. Set up authentication with a service account 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 Stackdriver Logging client
const loggingBunyan = new LoggingBunyan();

// Create a Bunyan logger that streams to Stackdriver 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 Stackdriver 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 Stackdriver Logging, logging at 'info' and above'info'),

// Writes some log entries
logger.error('warp nacelles offline');'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 Stackdriver 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 Stackdriver 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;
  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.

  // 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 Stackdriver
    // UI.'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.{port: 8080}, 'bonjour');

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


Error Reporting

Any Error objects you log at severity error or higher can automatically be picked up by [Stackdriver Error Reporting][error-reporting] if you have specified a serviceContext.service when instatiating 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][uncaught] and [unhandled rejection][unhandled] 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.

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.{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][http-request-message] message and Stackdriver logging will show this as a request log. Example:

Request Log Example{
  httpRequest: {
    status: res.statusCode,
    requestUrl: req.url,
    requestMethod: req.method,
    remoteIp: req.connection.remoteAddress,
    // etc.
}, req.path);

The httpRequest proprety must be a properly formatted [HttpRequest][http-request-message] 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 Stackdriver 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 Stackdriver Trace Viewer. Example:

Logs in Trace Example

If you wish to set the Stackdriver LogEntry trace property with a custom value, then write a Bunyan log entry property for '', 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();

  [LOGGING_TRACE_KEY]: 'custom-trace-value'
}, 'Bunyan log entry with custom trace field');


Samples are in the samples/ directory. The samples' has instructions for running the samples.

Sample Source Code Try it
Express source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell
Explict Auth Setup source code Open in Cloud Shell

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


This library follows Semantic Versioning.

This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.


Apache Version 2.0


You can’t perform that action at this time.