@google-cloud/logging-winston

What is @google-cloud/logging-winston?

@google-cloud/logging-winston is a logging transport for the Winston logging library that allows you to easily send logs to Google Cloud Logging. It integrates seamlessly with Winston, enabling you to leverage Google Cloud's powerful logging infrastructure for your Node.js applications.

What are @google-cloud/logging-winston's main functionalities?

Basic Logging

This feature allows you to set up basic logging with Winston and send logs to Google Cloud Logging. The code sample demonstrates how to create a logger with both console and Google Cloud Logging transports.

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

const logger = winston.createLogger({
  level: 'info',
  transports: [
    new winston.transports.Console(),
    new LoggingWinston()
  ]
});

logger.info('Hello, world!');

Structured Logging

This feature allows you to send structured logs to Google Cloud Logging. The code sample shows how to log a message with additional metadata, which can be useful for more detailed log analysis.

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

const logger = winston.createLogger({
  level: 'info',
  transports: [
    new winston.transports.Console(),
    new LoggingWinston()
  ]
});

logger.info('User logged in', { userId: '1234', method: 'OAuth' });

Error Logging

This feature allows you to log errors to Google Cloud Logging. The code sample demonstrates how to catch an error and log it using the logger.

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

const logger = winston.createLogger({
  level: 'error',
  transports: [
    new winston.transports.Console(),
    new LoggingWinston()
  ]
});

try {
  throw new Error('Something went wrong!');
} catch (err) {
  logger.error('Error occurred', err);
}

Other packages similar to @google-cloud/logging-winston

winston

Winston is a versatile logging library for Node.js that supports multiple transports. While it does not natively support Google Cloud Logging, it can be extended with transports like @google-cloud/logging-winston to achieve similar functionality.

bunyan

Bunyan is another popular logging library for Node.js that focuses on JSON logging. It provides a different API and feature set compared to Winston but can also be extended to support Google Cloud Logging through custom streams.

pino

Pino is a fast and low-overhead logging library for Node.js. It is designed for high-performance logging and can be integrated with Google Cloud Logging using community-supported plugins or custom transports.

README

@google-cloud/logging-winston

Stackdriver Logging transport for Winston

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

For lower-level access to the Stackdriver Logging API, see @google-cloud/logging.

This module is experimental and should be used by early adopters. This module uses APIs that may be undocumented and subject to change without notice.

$ npm install --save @google-cloud/logging-winston

var winston = require('winston');
var transport = require('@google-cloud/logging-winston');

winston.add(transport, {
  projectId: 'grape-spaceship-123',
  keyFilename: '/path/to/keyfile.json',
  level: 'warn' // log at 'warn' and above
});

winston.error('warp nacelles offline');
winston.verbose('sheilds at 99%');

Authentication

It's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Cloud services.

On Google Cloud Platform

If you are running this client on Google Cloud Platform, we handle authentication for you with no configuration. You just need to make sure that when you set up the GCE instance, you add the correct scopes for the APIs you want to access.

var winston = require('winston');
var transport = require('@google-cloud/logging-winston');

winston.add(transport);

// ...you're good to go!

Elsewhere

If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account:

1. Visit the Google Developers Console.
2. Create a new project or click on an existing project.
3. Navigate to APIs & auth > APIs section and turn on the following APIs (you may need to enable billing in order to use these services):

• Stackdriver Logging API

1. Navigate to APIs & auth > Credentials and then:

• If you want to use a new service account key, click on Create credentials and select Service account key. After the account key is created, you will be prompted to download the JSON key file that the library uses to authenticate your requests.
• If you want to generate a new service account key for an existing service account, click on Generate new JSON key and download the JSON key file.

var winston = require('winston');
var transport = require('@google-cloud/logging-winston');

winston.add(transport, {
  projectId: 'grape-spaceship-123',

  // The path to your key file:
  keyFilename: '/path/to/keyfile.json'

  // Or the contents of the key file:
  credentials: require('./path/to/keyfile.json')
});

// ...you're good to go!