class inner

v2.MetricsServiceV2Client

Source: v2/metrics_service_v2_client.js:57

Service for configuring logs-based metrics.

Properties

apiEndpoint
port
scopes
servicePath

Methods

createLogMetric(request[, options][, callback])
deleteLogMetric(request[, options][, callback])
getLogMetric(request[, options][, callback])
getProjectId(callback)
listLogMetrics(request[, options][, callback])
listLogMetricsStream(request[, options])
matchMetricFromMetricName(metricName)
matchProjectFromMetricName(metricName)
matchProjectFromProjectName(projectName)
metricPath(project, metric)
projectPath(project)
updateLogMetric(request[, options][, callback])

new MetricsServiceV2Client([options])

Construct an instance of MetricsServiceV2Client.

Parameters

Name Type Optional Description

options

 

Yes

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

Values in options have the following properties:

Name Type Optional Description

credentials

 

Yes

Credentials object.

credentials.client_email

 

Yes

credentials.private_key

 

Yes

email

 

Yes

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

keyFilename

 

Yes

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

 

Yes

The port on which to connect to the remote host.

projectId

 

Yes

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

 

Yes

Custom promise module to use instead of native Promises.

servicePath

 

Yes

The domain name of the API remote host.

Properties

static

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

static

port

The port for this API service.

static

scopes

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

static

servicePath

The DNS address for this API service.

Methods

createLogMetric(request[, options][, callback]) → Promise

Creates a logs-based metric.

Example 

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

const client = new logging.v2.MetricsServiceV2Client({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
const metric = {};
const request = {
  parent: formattedParent,
  metric: metric,
};
client.createLogMetric(request)
  .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 request have the following properties:

Name Type Optional Description

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

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 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.

deleteLogMetric(request[, options][, callback]) → Promise

Deletes a logs-based metric.

Example 

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

const client = new logging.v2.MetricsServiceV2Client({
  // optional auth parameters.
});

const formattedMetricName = client.metricPath('[PROJECT]', '[METRIC]');
client.deleteLogMetric({metricName: formattedMetricName}).catch(err => {
  console.error(err);
});

Parameters

Name Type Optional Description

request

Object

 

The request object that will be sent.

Values in request have the following properties:

Name Type Optional Description

metricName

string

 

The resource name of the metric to delete:

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

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.

getLogMetric(request[, options][, callback]) → Promise

Gets a logs-based metric.

Example 

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

const client = new logging.v2.MetricsServiceV2Client({
  // optional auth parameters.
});

const formattedMetricName = client.metricPath('[PROJECT]', '[METRIC]');
client.getLogMetric({metricName: formattedMetricName})
  .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 request have the following properties:

Name Type Optional Description

metricName

string

 

The resource name of the desired metric:

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

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 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.

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.

listLogMetrics(request[, options][, callback]) → Promise

Lists logs-based metrics.

Example 

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

const client = new logging.v2.MetricsServiceV2Client({
  // optional auth parameters.
});

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

client.listLogMetrics({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.listLogMetrics(nextRequest, options).then(callback);
  }
}
client.listLogMetrics({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 request have the following properties:

Name Type Optional Description

parent

string

 

Required. The name of the project containing the metrics:

  "projects/[PROJECT_ID]"

pageSize

number

Yes

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

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 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.

listLogMetricsStream(request[, options]) → 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.

Example 

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

const client = new logging.v2.MetricsServiceV2Client({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.listLogMetricsStream({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 request have the following properties:

Name Type Optional Description

parent

string

 

Required. The name of the project containing the metrics:

  "projects/[PROJECT_ID]"

pageSize

number

Yes

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

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

Stream 

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

matchMetricFromMetricName(metricName) → String

Parse the metricName from a metric resource.

Parameter

Name Type Optional Description

metricName

String

 

A fully-qualified path representing a metric resources.
Returns

String 

  • A string representing the metric.

matchProjectFromMetricName(metricName) → String

Parse the metricName from a metric resource.

Parameter

Name Type Optional Description

metricName

String

 

A fully-qualified path representing a metric 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.

metricPath(project, metric) → String

Return a fully-qualified metric resource name string.

Parameters

Name Type Optional Description

project

String

 

metric

String

 
Returns

String 

projectPath(project) → String

Return a fully-qualified project resource name string.

Parameter

Name Type Optional Description

project

String

 
Returns

String 

updateLogMetric(request[, options][, callback]) → Promise

Creates or updates a logs-based metric.

Example 

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

const client = new logging.v2.MetricsServiceV2Client({
  // optional auth parameters.
});

const formattedMetricName = client.metricPath('[PROJECT]', '[METRIC]');
const metric = {};
const request = {
  metricName: formattedMetricName,
  metric: metric,
};
client.updateLogMetric(request)
  .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 request have the following properties:

Name Type Optional Description

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

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 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.