v2.
Source: v2/
Service for ingesting and querying logs.
Properties
Methods
new LoggingServiceV2Client([options])
Construct an instance of LoggingServiceV2Client.
Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
options |
|
Yes |
The configuration object. See the subsequent parameters for more details. Values in
|
Properties
apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
deleteLog(request[, options][, callback]) → 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.
Example
const logging = require('@google-cloud/logging');
const client = new logging.v2.LoggingServiceV2Client({
// optional auth parameters.
});
const formattedLogName = client.logPath('[PROJECT]', '[LOG]');
client.deleteLog({logName: formattedLogName}).catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||
|
callback |
function(nullable Error) |
Yes |
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.
getProjectId(callback)
Return the project ID used by this class.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
callback |
function(Error, string) |
|
the callback to be called with the current project Id. |
listLogEntries(request[, options][, callback]) → Promise
Lists log entries. Use this method to retrieve log entries from Logging. For ways to export log entries, see Exporting Logs.
Example
const logging = require('@google-cloud/logging');
const client = new logging.v2.LoggingServiceV2Client({
// optional auth parameters.
});
// Iterate over all elements.
const formattedResourceNames = [];
client.listLogEntries({resourceNames: formattedResourceNames})
.then(responses => {
const resources = responses[0];
for (const resource of resources) {
// doThingsWith(resource)
}
})
.catch(err => {
console.error(err);
});
// Or obtain the paged response.
const formattedResourceNames = [];
const options = {autoPaginate: false};
const callback = responses => {
// The actual resources in a response.
const resources = responses[0];
// The next request if the response shows that there are more responses.
const nextRequest = responses[1];
// The actual response object, if necessary.
// const rawResponse = responses[2];
for (const resource of resources) {
// doThingsWith(resource);
}
if (nextRequest) {
// Fetch the next page.
return client.listLogEntries(nextRequest, options).then(callback);
}
}
client.listLogEntries({resourceNames: formattedResourceNames}, options)
.then(callback)
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Array, nullable Object, nullable Object) |
Yes |
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.
-
listLogEntriesStream(request[, options]) → 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.
Example
const logging = require('@google-cloud/logging');
const client = new logging.v2.LoggingServiceV2Client({
// optional auth parameters.
});
const formattedResourceNames = [];
client.listLogEntriesStream({resourceNames: formattedResourceNames})
.on('data', element => {
// doThingsWith(element)
}).on('error', err => {
console.log(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||
|
options |
Object |
Yes |
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
-
StreamAn object stream which emits an object representing LogEntry on 'data' event.
listLogs(request[, options][, callback]) → Promise
Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
Example
const logging = require('@google-cloud/logging');
const client = new logging.v2.LoggingServiceV2Client({
// optional auth parameters.
});
// Iterate over all elements.
const formattedParent = client.projectPath('[PROJECT]');
client.listLogs({parent: formattedParent})
.then(responses => {
const resources = responses[0];
for (const resource of resources) {
// doThingsWith(resource)
}
})
.catch(err => {
console.error(err);
});
// Or obtain the paged response.
const formattedParent = client.projectPath('[PROJECT]');
const options = {autoPaginate: false};
const callback = responses => {
// The actual resources in a response.
const resources = responses[0];
// The next request if the response shows that there are more responses.
const nextRequest = responses[1];
// The actual response object, if necessary.
// const rawResponse = responses[2];
for (const resource of resources) {
// doThingsWith(resource);
}
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);
});Parameters
| Name | Type | Optional | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||
|
callback |
function(nullable Error, nullable Array, nullable Object, nullable Object) |
Yes |
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.
-
listLogsStream(request[, options]) → 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.
Example
const logging = require('@google-cloud/logging');
const client = new logging.v2.LoggingServiceV2Client({
// optional auth parameters.
});
const formattedParent = client.projectPath('[PROJECT]');
client.listLogsStream({parent: formattedParent})
.on('data', element => {
// doThingsWith(element)
}).on('error', err => {
console.log(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||
|
options |
Object |
Yes |
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
-
StreamAn object stream which emits a string on 'data' event.
listMonitoredResourceDescriptors(request[, options][, callback]) → Promise
Lists the descriptors for monitored resource types used by Logging.
Example
const logging = require('@google-cloud/logging');
const client = new logging.v2.LoggingServiceV2Client({
// optional auth parameters.
});
// Iterate over all elements.
client.listMonitoredResourceDescriptors({})
.then(responses => {
const resources = responses[0];
for (const resource of resources) {
// doThingsWith(resource)
}
})
.catch(err => {
console.error(err);
});
// Or obtain the paged response.
const options = {autoPaginate: false};
const callback = responses => {
// The actual resources in a response.
const resources = responses[0];
// The next request if the response shows that there are more responses.
const nextRequest = responses[1];
// The actual response object, if necessary.
// const rawResponse = responses[2];
for (const resource of resources) {
// doThingsWith(resource);
}
if (nextRequest) {
// Fetch the next page.
return client.listMonitoredResourceDescriptors(nextRequest, options).then(callback);
}
}
client.listMonitoredResourceDescriptors({}, options)
.then(callback)
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||
|
callback |
function(nullable Error, nullable Array, nullable Object, nullable Object) |
Yes |
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.
-
listMonitoredResourceDescriptorsStream(request[, options]) → 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.
Example
const logging = require('@google-cloud/logging');
const client = new logging.v2.LoggingServiceV2Client({
// optional auth parameters.
});
client.listMonitoredResourceDescriptorsStream({})
.on('data', element => {
// doThingsWith(element)
}).on('error', err => {
console.log(err);
});Parameters
| Name | Type | Optional | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||
|
options |
Object |
Yes |
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
-
StreamAn object stream which emits an object representing MonitoredResourceDescriptor on 'data' event.
logPath(project, log) → String
Return a fully-qualified log resource name string.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
project |
String |
|
|
|
log |
String |
|
- Returns
-
String
matchLogFromLogName(logName) → String
Parse the logName from a log resource.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
logName |
String |
|
A fully-qualified path representing a log resources. |
- Returns
-
String- A string representing the log.
matchProjectFromLogName(logName) → String
Parse the logName from a log resource.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
logName |
String |
|
A fully-qualified path representing a log resources. |
- Returns
-
String- A string representing the project.
matchProjectFromProjectName(projectName) → String
Parse the projectName from a project resource.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
projectName |
String |
|
A fully-qualified path representing a project resources. |
- Returns
-
String- A string representing the project.
projectPath(project) → String
Return a fully-qualified project resource name string.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
project |
String |
|
- Returns
-
String
writeLogEntries(request[, options][, callback]) → Promise
Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)
Example
const logging = require('@google-cloud/logging');
const client = new logging.v2.LoggingServiceV2Client({
// optional auth parameters.
});
const entries = [];
client.writeLogEntries({entries: entries})
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||||||
|
options |
Object |
Yes |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
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.