Stackdriver Logging for Winston

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

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

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.

Go to the projects page
Enable billing for your project.

Enable billing
Enable the Stackdriver Logging API.

Enable the API
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-winston

Using the client library

`winston@3.x`

const winston = require('winston');
const {LoggingWinston} = require('@google-cloud/logging-winston')

const loggingWinston = new LoggingWinston();

const logger = winston.createLogger({
  level: 'info',
  transports: [
    new winston.transports.Console(),
    // Add Stackdriver Logging
    loggingWinston,
  ]
});

logger.error('warp nacelles offline');

Creates a Winston logger that streams to Stackdriver Logging

Logs will be written to: "projects/YOUR_PROJECT_ID/logs/winston_log"

`winston@2.x`

const winston = require('winston');
const {LoggingWinston} = require('@google-cloud/logging-winston');

const logger = new winston.Logger({
  transports:[
     new winston.transports.Console(),
     new LoggingWinston()
  ]
})

logger.info('hello winston')

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 instantiating a LoggingWinston instance:

const loggingWinston = new LoggingWinston({
  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.

Formatting Request Logs

To format your request logs you can provide a httpRequest property as part of the log metadata you provide to winston. We will treat this as the HttpRequest message and Stackdriver logging will show this as a request log. Example:

winston.info(`${req.url} endpoint hit`, {
  httpRequest: {
    status: res.statusCode,
    requestUrl: req.url,
    requestMethod: req.method,
    remoteIp: req.connection.remoteAddress,
    // etc.
  }
});

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 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 LogEntry trace property with a custom value, then set a winston metadata property for 'logging.googleapis.com/trace', which is exported by this module as LOGGING_TRACE_KEY. For example:

const winston = require('winston');
const {LoggingWinston} = require('@google-cloud/logging-winston');

// ...

winston.info('Log entry with custom trace value', {
  [LoggingWinston.LOGGING_TRACE_KEY]: 'custom-trace-value'
});

Specifying default labels in the constructor

You can specify labels when initiating the logger constructor.

// Creates a Winston Stackdriver Logging client
const loggingWinston = new LoggingWinston({
  labels: {
    name: 'some-name',
    version: '0.1.0'
  }
});

// Writes some log entries
logger.debug('test msg');

// you can also put some `labels` when calling the logger function
// the `labels` will be merge together
logger.debug('test msg', {
  labels: {
    module: 'some-module'
  }
});

The labels will be on the Log Viewer.

Add a prefix to easily identify logs

You can specify a prefix in the constructor, and that prefix will be prepended to all logging messages. This can be helpful, for example, to quickly identify logs from different modules in a project.

// Creates a Winston Stackdriver Logging client
const loggingWinston = new LoggingWinston({
  prefix: 'some-module'
});

logger.debug('test msg');

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

kjin/nodejs-logging-winston