googleapis/nodejs-logging-winston

Name: nodejs-logging-winston

Owner: Google APIs

Description: Node.js client integration between Stackdriver Logging and Winston.

Created: 2017-07-26 20:47:48.0

Updated: 2018-05-23 09:35:35.0

Pushed: 2018-05-22 18:32:22.0

Homepage: https://cloud.google.com/logging/

Size: 1072

Language: TypeScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Stackdriver Logging 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.

• Stackdriver Logging for Winston API Reference
• github.com/googleapis/nodejs-logging-winston
• 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-winston

Using the client library

t winston = require('winston');
t Logger = winston.Logger;
t Console = winston.transports.Console;

mports the Google Cloud client library for Winston

ode 6+
t {LoggingWinston} = require('@google-cloud/logging-winston');

ode 4+
onst LoggingWinston = require('@google-cloud/logging-winston').LoggingWinston;

sing ES6 style imports via TypeScript or Babel
mport {LoggingWinston} from '@google-cloud/logging-winston';

reates a Winston Stackdriver Logging client
t loggingWinston = new LoggingWinston();

reate a Winston logger that streams to Stackdriver Logging
ogs will be written to: "projects/YOUR_PROJECT_ID/logs/winston_log"
t logger = new Logger({
vel: 'info', // log at 'info' and above
ansports: [
// Log to the console
new Console(),
// And log to Stackdriver Logging
loggingWinston,



rites some log entries
er.error('warp nacelles offline');
er.info('shields at 99%');

Error Reporting

Any Error objects you log at severity error or higher can automatically be picked up by Stackdriver Error Reporting if your application is running on Google Cloud Platform. 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:

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

The httpRequest proprety must be a properly formatted HttpRequest message.

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:

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

..

ton.info('Log entry with custom trace value', {

Specifying default labels in the constructor

You can specify labels when initiating the logger constructor.

reates a Winston Stackdriver Logging client
t loggingWinston = new LoggingWinston({
bels: {
name: 'some-name',
version: '0.1.0'



rites some log entries
er.debug('test msg');

ou can also put some `labels` when calling the logger function
he `labels` will be merge together
er.debug('test msg', {
bels: {
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.

reates a Winston Stackdriver Logging client
t loggingWinston = new LoggingWinston({
efix: 'some-module'


er.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