v2. MetricsServiceV2Client
Service for configuring logs-based metrics.
Constructor
MetricsServiceV2Client
new MetricsServiceV2Client(options)
Construct an instance of MetricsServiceV2Client.
Parameter |
|||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Optional object The configuration object. See the subsequent parameters for more details. Values in
|
Properties
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
createLogMetric
createLogMetric(request, options, callback) returns Promise
Creates a logs-based metric.
Parameter |
|||||||
---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||
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 LogMetric. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing LogMetric. 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.MetricsServiceV2Client({
// optional auth parameters.
});
var formattedParent = client.projectPath('[PROJECT]');
var metric = {};
var request = {
parent: formattedParent,
metric: metric,
};
client.createLogMetric(request)
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});
deleteLogMetric
deleteLogMetric(request, options, callback) returns Promise
Deletes a logs-based metric.
Parameter |
|||||
---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||
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.MetricsServiceV2Client({
// optional auth parameters.
});
var formattedMetricName = client.metricPath('[PROJECT]', '[METRIC]');
client.deleteLogMetric({metricName: formattedMetricName}).catch(err => {
console.error(err);
});
getLogMetric
getLogMetric(request, options, callback) returns Promise
Gets a logs-based metric.
Parameter |
|||||
---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||
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 LogMetric. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing LogMetric. 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.MetricsServiceV2Client({
// optional auth parameters.
});
var formattedMetricName = client.metricPath('[PROJECT]', '[METRIC]');
client.getLogMetric({metricName: formattedMetricName})
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.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. |
listLogMetrics
listLogMetrics(request, options, callback) returns Promise
Lists logs-based metrics.
Parameter |
|||||||
---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||
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 LogMetric. 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 ListLogMetricsResponse. |
- Returns
-
Promise
-
The promise which resolves to an array. The first element of the array is Array of LogMetric.
When autoPaginate: false is specified through options, the array has three elements. The first element is Array of LogMetric 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 ListLogMetricsResponse.
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.MetricsServiceV2Client({
// optional auth parameters.
});
// Iterate over all elements.
var formattedParent = client.projectPath('[PROJECT]');
client.listLogMetrics({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.listLogMetrics(nextRequest, options).then(callback);
}
}
client.listLogMetrics({parent: formattedParent}, options)
.then(callback)
.catch(err => {
console.error(err);
});
listLogMetricsStream
listLogMetricsStream(request, options) returns Stream
Equivalent to listLogMetrics, but returns a NodeJS Stream object.
This fetches the paged responses for listLogMetrics 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. Values in
|
||||||
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 LogMetric on 'data' event.
Example
const logging = require('@google-cloud/logging');
var client = new logging.v2.MetricsServiceV2Client({
// optional auth parameters.
});
var formattedParent = client.projectPath('[PROJECT]');
client.listLogMetricsStream({parent: formattedParent})
.on('data', element => {
// doThingsWith(element)
}).on('error', err => {
console.log(err);
});
matchMetricFromMetricName
matchMetricFromMetricName(metricName) returns String
Parse the metricName from a metric resource.
Parameter |
|
---|---|
metricName |
String A fully-qualified path representing a metric resources. |
- Returns
-
String
- A string representing the metric.
matchProjectFromMetricName
matchProjectFromMetricName(metricName) returns String
Parse the metricName from a metric resource.
Parameter |
|
---|---|
metricName |
String A fully-qualified path representing a metric 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.
metricPath
metricPath(project, metric) returns String
Return a fully-qualified metric resource name string.
Parameter |
|
---|---|
project |
String |
metric |
String |
- Returns
-
String
projectPath
projectPath(project) returns String
Return a fully-qualified project resource name string.
Parameter |
|
---|---|
project |
String |
- Returns
-
String
updateLogMetric
updateLogMetric(request, options, callback) returns Promise
Creates or updates a logs-based metric.
Parameter |
|||||||
---|---|---|---|---|---|---|---|
request |
Object The request object that will be sent. Values in
|
||||||
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 LogMetric. |
- Returns
-
Promise
- The promise which resolves to an array. The first element of the array is an object representing LogMetric. 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.MetricsServiceV2Client({
// optional auth parameters.
});
var formattedMetricName = client.metricPath('[PROJECT]', '[METRIC]');
var metric = {};
var request = {
metricName: formattedMetricName,
metric: metric,
};
client.updateLogMetric(request)
.then(responses => {
var response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});