Logging - Documentation

Constructor

new Logging(optionsopt)

Parameters:

Name	Type	Attributes	Description
`options`	ClientConfig	<optional>	Configuration options.

Source:

index.js, line 117

See:

Examples

Import the client library

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

<caption>Create a client that uses <a
href="https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application">Application
Default Credentials (ADC)</a>:</caption> const logging = new Logging();

<caption>Create a client with <a
href="https://cloud.google.com/docs/authentication/production#obtaining_and_providing_service_account_credentials_manually">explicit
credentials</a>:</caption> const logging = new Logging({ projectId:
'your-project-id', keyFilename: '/path/to/keyfile.json'
});

include:samples/quickstart.js

region_tag:logging_quickstart
Full quickstart example:

Methods

entry(resourceopt, data) → {Entry}

Create an entry object.

Note that using this method will not itself make any API requests. You will use the object returned in other API calls, such as Log#write.

Parameters:

Name	Type	Attributes	Description
`resource`	object \| string	<optional>	See a Monitored Resource.
`data`	object \| string		The data to use as the value for this log entry.

Source:

index.js, line 218

See:

LogEntry JSON representation

Example

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

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

const entry = logging.entry(resource, {
  delegate: 'my_username'
});

entry.toJSON();
// {
//   resource: {
//     type: 'gce_instance',
//     labels: {
//       zone: 'global',
//       instance_id: '3'
//     }
//   },
//   jsonPayload: {
//     delegate: 'my_username'
//   }
// }

getEntriesStream(queryopt) → {ReadableStream}

List the Entry objects in your logs as a readable object stream.

Parameters:

Name	Type	Attributes	Description
`query`	GetEntriesRequest	<optional>	Query object for listing entries.

Source:

index.js, line 244

Example

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

logging.getEntriesStream()
  .on('error', console.error)
  .on('data', entry => {
    // `entry` is a Stackdriver Logging entry object.
    // See the `data` property to read the data from the entry.
  })
  .on('end', function() {
    // All entries retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
logging.getEntriesStream()
  .on('data', function(entry) {
    this.end();
  });

getSinksStream(queryopt) → {ReadableStream}

Get the Sink objects associated with this project as a readable object stream.

Parameters:

Name	Type	Attributes	Description
`query`	GetSinksRequest	<optional>	Query object for listing sinks.

Source:

index.js, line 362

Example

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

logging.getSinksStream()
  .on('error', console.error)
  .on('data', sink => {
    // `sink` is a Sink object.
  })
  .on('end', function() {
    // All sinks retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
logging.getSinksStream()
  .on('data', function(sink) {
    this.end();
  });

log(name, optionsopt) → {Log}

Get a reference to a Stackdriver Logging log.

Parameters:

Name Type Attributes Description

name

string

Name of the existing log.

options

object

Configuration object.

Properties

Name	Type	Attributes	Description
`removeCircular`	boolean	<optional>	Replace circular references in logged objects with a string value, `[Circular]`. (Default: false)

Source:

index.js, line 465

See:

Log Overview

Example

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

request(config, callbackopt)

Funnel all API requests through this method, to be sure we have a project ID.

Parameters:

Name Type Attributes Description

config

object

Configuration object.

Properties

Name	Type	Description
`gaxOpts`	object	GAX options.
`method`	function	The gax method to call.
`reqOpts`	object	Request options.

callback

function

Callback function.

Source:

index.js, line 495

sink(name) → {Sink}

Get a reference to a Stackdriver Logging sink.

Parameters:

Name	Type	Description
`name`	string	Name of the existing sink.

Source:

index.js, line 481

See:

Sink Overview

Example

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