v2.MetricsServiceV2Client

class   static

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 options have the following properties:

Parameter

credentials

Optional

object

Credentials object.

credentials.client_email

Optional

string

credentials.private_key

Optional

string

email

Optional

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

Optional

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

Optional

number

The port on which to connect to the remote host.

projectId

Optional

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

promise

Optional

function()

Custom promise module to use instead of native Promises.

servicePath

Optional

string

The domain name of the API remote host.

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

createLogMetric

createLogMetric(request, options, callback) returns Promise

Creates a logs-based metric.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

The resource name of the project in which to create the metric:

  "projects/[PROJECT_ID]"

The new metric must be provided in the request.

metric

Object

The new logs-based metric, which must not have an identifier that already exists.

This object should have the same structure as LogMetric

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 request have the following properties:

Parameter

metricName

string

The resource name of the metric to delete:

  "projects/[PROJECT_ID]/metrics/[METRIC_ID]"

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 request have the following properties:

Parameter

metricName

string

The resource name of the desired metric:

  "projects/[PROJECT_ID]/metrics/[METRIC_ID]"

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 request have the following properties:

Parameter

parent

string

Required. The name of the project containing the metrics:

  "projects/[PROJECT_ID]"

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

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 request have the following properties:

Parameter

parent

string

Required. The name of the project containing the metrics:

  "projects/[PROJECT_ID]"

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

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 request have the following properties:

Parameter

metricName

string

The resource name of the metric to update:

  "projects/[PROJECT_ID]/metrics/[METRIC_ID]"

The updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.

metric

Object

The updated metric.

This object should have the same structure as LogMetric

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);
  });