@google-cloud/logging

module

The default export of the @google-cloud/logging package is the Logging class.

See Logging and ClientConfig for client methods and configuration options.

Examples

Install the client library with npm:

npm install --save @google-cloud/logging

Import the client library

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

Create a client that uses Application Default Credentials (ADC):

const logging = new Logging();

Create a client with explicit credentials:

const logging = new Logging({
  projectId: 'your-project-id',
  keyFilename: '/path/to/keyfile.json'
});

Full quickstart example:

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

// Your Google Cloud Platform project ID
const projectId = 'YOUR_PROJECT_ID';

// Creates a client
const logging = new Logging({
  projectId: projectId,
});

// The name of the log to write to
const logName = 'my-log';
// 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'}};
// Prepares a log entry
const entry = log.entry(metadata, text);

// Writes the log entry
log
  .write(entry)
  .then(() => {
    console.log(`Logged: ${text}`);
  })
  .catch(err => {
    console.error('ERROR:', err);
  });

Properties

Entry

static

Reference to the Entry class.

See also
Entry

Log

static

Reference to the Log class.

See also
Log

Sink

static

Reference to the Sink class.

See also
Sink

v2

static

object

Reference to the low-level auto-generated clients for the V2 Logging service.

Properties

Parameter

LoggingServiceV2Client

constructor

Reference to v2.LoggingServiceV2Client

ConfigServiceV2Client

constructor

Reference to v2.ConfigServiceV2Client

MetricsServiceV2Client

constructor

Reference to v2.MetricsServiceV2Client