@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

Cloud Logging: Node.js Client

Google Cloud Logging allows you to store, search, analyze, monitor, and alert on log data and events from Google Cloud Platform and Amazon Web Services.

If you require lightweight dependencies, an experimental, minified version of this library is available at @google-cloud/logging-min. Note: logging-min is experimental, and its feature surface is subject to change.

A comprehensive list of changes in each version may be found in the CHANGELOG.

• Cloud Logging Node.js Client API Reference
• Cloud Logging Documentation
• github.com/googleapis/nodejs-logging

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.
2. Enable the Cloud Logging API.
3. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/logging

Using the client library

// Imports the Google Cloud client library
const {Logging} = require('@google-cloud/logging');

async function quickstart(
  projectId = 'YOUR_PROJECT_ID', // Your Google Cloud Platform project ID
  logName = 'my-log' // The name of the log to write to
) {
  // Creates a client
  const logging = new Logging({projectId});

  // Selects the log to write to
  const log = logging.log(logName);

  // The data to write to the log
  const text = 'Hello, world!';

  // The metadata associated with the entry
  const metadata = {
    resource: {type: 'global'},
    // See: https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity
    severity: 'INFO',
  };

  // Prepares a log entry
  const entry = log.entry(metadata, text);

  async function writeLog() {
    // Writes the log entry
    await log.write(entry);
    console.log(`Logged: ${text}`);
  }
  writeLog();
}

Batching Writes

High throughput applications should avoid awaiting calls to the logger:

await log.write(logEntry1);
await log.write(logEntry2);

Rather, applications should use a fire and forget approach:

log.write(logEntry1);
log.write(logEntry2);

The @google-cloud/logging library will handle batching and dispatching these log lines to the API.

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Fluent	source code
Log HTTP Request	source code
Logs	source code
Quickstart	source code
Sinks	source code

The Cloud Logging Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

• Legacy versions will not be tested in continuous integration.
• Some security patches may not be able to be backported.
• Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

• legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be General Availability (GA). This means it is stable; the code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its template in this directory.

License

Apache Version 2.0

See LICENSE