Constructor

LoggingServiceV2Client

new LoggingServiceV2Client(options)

Construct an instance of LoggingServiceV2Client.

Parameter

options

Optional

object

The configuration object. See the subsequent parameters for more details.

Properties

port

static

The port for this API service.

scopes

static

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static

The DNS address for this API service.

Methods

deleteLog

deleteLog(request, options, callback) returns Promise

Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error)

The function which will be called with the result of the API call.

Returns

Promise 

  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

var client = new logging.v2.LoggingServiceV2Client({
  // optional auth parameters.
});

var formattedLogName = client.logPath('[PROJECT]', '[LOG]');
client.deleteLog({logName: formattedLogName}).catch(err => {
  console.error(err);
});

getProjectId

getProjectId(callback)

Return the project ID used by this class.

Parameter

callback

function(Error, string)

the callback to be called with the current project Id.

listLogEntries

listLogEntries(request, options, callback) returns Promise

Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is Array of LogEntry.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListLogEntriesResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of LogEntry.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of LogEntry in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListLogEntriesResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

var client = new logging.v2.LoggingServiceV2Client({
  // optional auth parameters.
});

// Iterate over all elements.
var resourceNames = [];

client.listLogEntries({resourceNames: resourceNames})
  .then(responses => {
    var resources = responses[0];
    for (let i = 0; i < resources.length; i += 1) {
      // doThingsWith(resources[i])
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
var resourceNames = [];


var options = {autoPaginate: false};
var callback = responses => {
  // The actual resources in a response.
  var resources = responses[0];
  // The next request if the response shows that there are more responses.
  var nextRequest = responses[1];
  // The actual response object, if necessary.
  // var rawResponse = responses[2];
  for (let i = 0; i < resources.length; i += 1) {
    // doThingsWith(resources[i]);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listLogEntries(nextRequest, options).then(callback);
  }
}
client.listLogEntries({resourceNames: resourceNames}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listLogEntriesStream

listLogEntriesStream(request, options) returns Stream

Equivalent to listLogEntries, but returns a NodeJS Stream object.

This fetches the paged responses for listLogEntries continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

An object stream which emits an object representing LogEntry on 'data' event.

Example

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

var client = new logging.v2.LoggingServiceV2Client({
  // optional auth parameters.
});

var resourceNames = [];
client.listLogEntriesStream({resourceNames: resourceNames})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

listLogs

listLogs(request, options, callback) returns Promise

Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is Array of string.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListLogsResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of string.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of string in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListLogsResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

var client = new logging.v2.LoggingServiceV2Client({
  // optional auth parameters.
});

// Iterate over all elements.
var formattedParent = client.projectPath('[PROJECT]');

client.listLogs({parent: formattedParent})
  .then(responses => {
    var resources = responses[0];
    for (let i = 0; i < resources.length; i += 1) {
      // doThingsWith(resources[i])
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
var formattedParent = client.projectPath('[PROJECT]');


var options = {autoPaginate: false};
var callback = responses => {
  // The actual resources in a response.
  var resources = responses[0];
  // The next request if the response shows that there are more responses.
  var nextRequest = responses[1];
  // The actual response object, if necessary.
  // var rawResponse = responses[2];
  for (let i = 0; i < resources.length; i += 1) {
    // doThingsWith(resources[i]);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listLogs(nextRequest, options).then(callback);
  }
}
client.listLogs({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listLogsStream

listLogsStream(request, options) returns Stream

Equivalent to listLogs, but returns a NodeJS Stream object.

This fetches the paged responses for listLogs continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

An object stream which emits a string on 'data' event.

Example

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

var client = new logging.v2.LoggingServiceV2Client({
  // optional auth parameters.
});

var formattedParent = client.projectPath('[PROJECT]');
client.listLogsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

listMonitoredResourceDescriptors

listMonitoredResourceDescriptors(request, options, callback) returns Promise

Lists the descriptors for monitored resource types used by Stackdriver Logging.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is Array of MonitoredResourceDescriptor.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListMonitoredResourceDescriptorsResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of MonitoredResourceDescriptor.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of MonitoredResourceDescriptor in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListMonitoredResourceDescriptorsResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

var client = new logging.v2.LoggingServiceV2Client({
  // optional auth parameters.
});

// Iterate over all elements.
client.listMonitoredResourceDescriptors({})
  .then(responses => {
    var resources = responses[0];
    for (let i = 0; i < resources.length; i += 1) {
      // doThingsWith(resources[i])
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.

var options = {autoPaginate: false};
var callback = responses => {
  // The actual resources in a response.
  var resources = responses[0];
  // The next request if the response shows that there are more responses.
  var nextRequest = responses[1];
  // The actual response object, if necessary.
  // var rawResponse = responses[2];
  for (let i = 0; i < resources.length; i += 1) {
    // doThingsWith(resources[i]);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listMonitoredResourceDescriptors(nextRequest, options).then(callback);
  }
}
client.listMonitoredResourceDescriptors({}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listMonitoredResourceDescriptorsStream

listMonitoredResourceDescriptorsStream(request, options) returns Stream

Equivalent to listMonitoredResourceDescriptors, but returns a NodeJS Stream object.

This fetches the paged responses for listMonitoredResourceDescriptors continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

An object stream which emits an object representing MonitoredResourceDescriptor on 'data' event.

Example

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

var client = new logging.v2.LoggingServiceV2Client({
  // optional auth parameters.
});


client.listMonitoredResourceDescriptorsStream({})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

logPath

logPath(project, log) returns String

Return a fully-qualified log resource name string.

Parameter

project

String

log

String

Returns

String 

matchLogFromLogName

matchLogFromLogName(logName) returns String

Parse the logName from a log resource.

Parameter

logName

String

A fully-qualified path representing a log resources.

Returns

String 

  • A string representing the log.

matchProjectFromLogName

matchProjectFromLogName(logName) returns String

Parse the logName from a log resource.

Parameter

logName

String

A fully-qualified path representing a log resources.

Returns

String 

  • A string representing the project.

matchProjectFromProjectName

matchProjectFromProjectName(projectName) returns String

Parse the projectName from a project resource.

Parameter

projectName

String

A fully-qualified path representing a project resources.

Returns

String 

  • A string representing the project.

projectPath

projectPath(project) returns String

Return a fully-qualified project resource name string.

Parameter

project

String

Returns

String 

writeLogEntries

writeLogEntries(request, options, callback) returns Promise

Log entry resources

Writes log entries to Stackdriver Logging. This API method is the only way to send log entries to Stackdriver Logging. This method is used, directly or indirectly, by the Stackdriver Logging agent (fluentd) and all logging libraries configured to use Stackdriver Logging.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing WriteLogEntriesResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing WriteLogEntriesResponse. The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

var client = new logging.v2.LoggingServiceV2Client({
  // optional auth parameters.
});

var entries = [];
client.writeLogEntries({entries: entries})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });