@google-cloud/logging-bunyan

Stackdriver Logging for Bunyan

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.

• Stackdriver Logging for Bunyan API Reference
• github.com/googleapis/nodejs-logging-bunyan
• Logging Documentation

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.

   Go to the projects page

2. Enable billing for your project.

   Enable billing

3. Enable the Stackdriver Logging API.

   Enable the API

4. Set up authentication with a service account so you can access the API from your local workstation.

For a more detailed Stackdriver Logging setup guide, see https://cloud.google.com/logging/docs/setup/nodejs.

Installing the client library

npm install --save @google-cloud/logging-bunyan

Using the client library

const bunyan = require('bunyan');

// Imports the Google Cloud client library for Bunyan (Node 6+)
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',
  // log at 'info' and above
  level: 'info',
  streams: [
    // Log to the console
    {stream: process.stdout},
    // And log to Stackdriver Logging
    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 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:

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 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 Stackdriver
    // 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 Stackdriver 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 and unhandled rejection handlers if you want to see those errors too.

You may also want to see the @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.

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 Stackdriver logging will show this as a request log. Example:

logger.info({
  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 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 module, then this module will set the Stackdriver Logging LogEntry trace property based on the current trace context when available. That correlation allows you to view log entries inline with trace spans in the Stackdriver Trace Viewer. Example:

If you wish to set the Stackdriver 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');

Samples

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

Sample	Source Code	Try it
Quickstart	source code
Explict Auth Setup	source code

Versioning

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

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE

Changelog

v0.10.1

03-14-2019 14:58 PDT

Bug Fixes

• fix: add missing dep on google-auth-library (#278)