@google-cloud/logging

What is @google-cloud/logging?

The @google-cloud/logging package is a client library for Google Cloud Logging, part of Google Cloud's suite of services for storing, searching, analyzing, monitoring, and alerting on log data from Google Cloud and Amazon Web Services. It allows developers to integrate their applications with the Google Cloud Logging service easily, enabling them to send logs directly from their applications to the cloud.

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

Writing Log Entries

This feature allows users to write log entries to Google Cloud Logging. The code sample demonstrates how to create a log entry and write it to a specified log in Google Cloud.

const {Logging} = require('@google-cloud/logging');
const logging = new Logging();
const log = logging.log('my-log');
const metadata = {resource: {type: 'global'}};
const entry = log.entry(metadata, {message: 'Hello, world!'});
async function writeLog() {
  await log.write(entry);
  console.log('Logged: Hello, world!');
}
writeLog();

Listing Logs

This feature enables the listing of all logs in the Google Cloud Logging account. The code sample shows how to retrieve and print the names of all logs.

const {Logging} = require('@google-cloud/logging');
const logging = new Logging();
async function listLogs() {
  const [logs] = await logging.getLogs();
  console.log('Logs:');
  logs.forEach(log => {
    console.log(log.name);
  });
}
listLogs();

Deleting Logs

This feature allows users to delete logs from Google Cloud Logging. The code sample illustrates how to delete a specific log by its name.

const {Logging} = require('@google-cloud/logging');
const logging = new Logging();
const log = logging.log('my-log');
async function deleteLog() {
  await log.delete();
  console.log('Log deleted.');
}
deleteLog();

Other packages similar to @google-cloud/logging

winston

Winston is a versatile logging library for Node.js. Unlike @google-cloud/logging, which is specifically designed for integration with Google Cloud Logging, Winston supports multiple transports (a way to store logs) such as files, console, and more. It is more flexible for various logging needs and environments but doesn't provide direct integration with Google Cloud Logging without additional plugins.

bunyan

Bunyan is another Node.js logging library that focuses on JSON logging. Like Winston, it is highly configurable and supports various outputs but does not have built-in support for Google Cloud Logging. It is comparable to @google-cloud/logging in terms of providing structured logging but is more general-purpose.

README

@google-cloud/logging (GA)

Google Stackdriver Logging Client Library for Node.js

This module allows you to work with the Stackdriver Logging API. If you are already using winston or Bunyan for logging, you might want to check out @google-cloud/logging-winston and @google-cloud/logging-bunyan as higher level starting points.

Looking for more Google APIs than just Logging? You might want to check out google-cloud.

• API Documentation
• Official Documentation

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

var logging = require('@google-cloud/logging')({
  projectId: 'grape-spaceship-123',
  keyFilename: '/path/to/keyfile.json'
});

// Create a sink using a Bucket as a destination.
// $ npm install --save @google-cloud/storage
var gcs = require('@google-cloud/storage')({
  projectId: 'grape-spaceship-123',
  keyFilename: '/path/to/keyfile.json'
});

logging.createSink('my-new-sink', {
  destination: gcs.bucket('my-sink')
}, function(err, sink) {});

// Write a critical entry to a log.
var syslog = logging.log('syslog');

var metadata = {
  resource: {
    type: 'gce_instance',
    labels: {
      zone: 'global',
      instance_id: '3'
    }
  }
};

var entry = syslog.entry(metadata, {
  delegate: process.env.user
});

syslog.critical(entry, function(err) {});

// Get all entries in your project.
logging.getEntries(function(err, entries) {
  if (!err) {
    // `entries` contains all of the entries from the logs in your project.
  }
});

// Promises are also supported by omitting callbacks.
logging.getEntries().then(function(data) {
  var entries = data[0];
});

// It's also possible to integrate with third-party Promise libraries.
var logging = require('@google-cloud/logging')({
  promise: require('bluebird')
});

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 logging = require('@google-cloud/logging')();
// ...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 projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123'

var logging = require('@google-cloud/logging')({
  projectId: projectId,

  // 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!