MetricsServiceV2Client

v2~ MetricsServiceV2Client

Service for configuring logs-based metrics.

Constructor

new MetricsServiceV2Client(optionsopt)

Construct an instance of MetricsServiceV2Client.

Parameters:
Name Type Attributes Description
options object <optional>

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

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

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 number <optional>

The port on which to connect to the remote host.
projectId string <optional>

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 function <optional>

Custom promise module to use instead of native Promises.
apiEndpoint string <optional>

The domain name of the API remote host.
Source:

Members

(static) apiEndpoint

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

Source:

(static) port

The port for this API service.

Source:

(static) scopes

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

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

billingPath(billingAccount) → {String}

Return a fully-qualified billing resource name string.

Parameters:
Name Type Description
billingAccount String
Source:

createLogMetric(request, optionsopt, callbackopt) → {Promise}

Creates a logs-based metric.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type 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 <optional>

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

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

The second parameter to the callback is an object representing LogMetric.
Source:
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);
  });

deleteLogMetric(request, optionsopt, callbackopt) → {Promise}

Deletes a logs-based metric.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
metricName string

The resource name of the metric to delete:

  "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
options Object <optional>

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

The function which will be called with the result of the API call.
Source:
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);
});

folderPath(folder) → {String}

Return a fully-qualified folder resource name string.

Parameters:
Name Type Description
folder String
Source:

getLogMetric(request, optionsopt, callbackopt) → {Promise}

Gets a logs-based metric.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
metricName string

The resource name of the desired metric:

  "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
options Object <optional>

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

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

The second parameter to the callback is an object representing LogMetric.
Source:
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);
  });

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.
Source:

listLogMetrics(request, optionsopt, callbackopt) → {Promise}

Lists logs-based metrics.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The name of the project containing the metrics:

  "projects/[PROJECT_ID]"
pageSize number <optional>

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

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

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.
Source:
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);
  });

listLogMetricsStream(request, optionsopt) → {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.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The name of the project containing the metrics:

  "projects/[PROJECT_ID]"
pageSize number <optional>

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

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Source:
See:
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);
  });

matchBillingAccountFromBillingName(billingName) → {String}

Parse the billingName from a billing resource.

Parameters:
Name Type Description
billingName String

A fully-qualified path representing a billing resources.
Source:

matchFolderFromFolderName(folderName) → {String}

Parse the folderName from a folder resource.

Parameters:
Name Type Description
folderName String

A fully-qualified path representing a folder resources.
Source:

matchMetricFromMetricName(metricName) → {String}

Parse the metricName from a metric resource.

Parameters:
Name Type Description
metricName String

A fully-qualified path representing a metric resources.
Source:

matchOrganizationFromOrganizationName(organizationName) → {String}

Parse the organizationName from a organization resource.

Parameters:
Name Type Description
organizationName String

A fully-qualified path representing a organization resources.
Source:

matchProjectFromMetricName(metricName) → {String}

Parse the metricName from a metric resource.

Parameters:
Name Type Description
metricName String

A fully-qualified path representing a metric resources.
Source:

matchProjectFromProjectName(projectName) → {String}

Parse the projectName from a project resource.

Parameters:
Name Type Description
projectName String

A fully-qualified path representing a project resources.
Source:

metricPath(project, metric) → {String}

Return a fully-qualified metric resource name string.

Parameters:
Name Type Description
project String
metric String
Source:

organizationPath(organization) → {String}

Return a fully-qualified organization resource name string.

Parameters:
Name Type Description
organization String
Source:

projectPath(project) → {String}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project String
Source:

updateLogMetric(request, optionsopt, callbackopt) → {Promise}

Creates or updates a logs-based metric.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type 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 <optional>

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

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

The second parameter to the callback is an object representing LogMetric.
Source:
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);
  });