v3.MetricServiceClient

Parameters

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.

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

Creates a new metric descriptor. User-created metric descriptors define custom metrics.

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

const client = new monitoring.v3.MetricServiceClient({
  // optional auth parameters.
});

const formattedName = client.projectPath('[PROJECT]');
const metricDescriptor = {};
const request = {
  name: formattedName,
  metricDescriptor: metricDescriptor,
};
client.createMetricDescriptor(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing MetricDescriptor. The promise has a method named "cancel" which cancels the ongoing API call.

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

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

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

const client = new monitoring.v3.MetricServiceClient({
  // optional auth parameters.
});

const formattedName = client.projectPath('[PROJECT]');
const timeSeries = [];
const request = {
  name: formattedName,
  timeSeries: timeSeries,
};
client.createTimeSeries(request).catch(err => {
  console.error(err);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

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

Deletes a metric descriptor. Only user-created custom metrics can be deleted.

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

const client = new monitoring.v3.MetricServiceClient({
  // optional auth parameters.
});

const formattedName = client.metricDescriptorPath('[PROJECT]', '[METRIC_DESCRIPTOR]');
client.deleteMetricDescriptor({name: formattedName}).catch(err => {
  console.error(err);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

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

Gets a single metric descriptor. This method does not require a Stackdriver account.

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

const client = new monitoring.v3.MetricServiceClient({
  // optional auth parameters.
});

const formattedName = client.metricDescriptorPath('[PROJECT]', '[METRIC_DESCRIPTOR]');
client.getMetricDescriptor({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing MetricDescriptor. The promise has a method named "cancel" which cancels the ongoing API call.

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

Gets a single monitored resource descriptor. This method does not require a Stackdriver account.

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

const client = new monitoring.v3.MetricServiceClient({
  // optional auth parameters.
});

const formattedName = client.monitoredResourceDescriptorPath('[PROJECT]', '[MONITORED_RESOURCE_DESCRIPTOR]');
client.getMonitoredResourceDescriptor({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing MonitoredResourceDescriptor. The promise has a method named "cancel" which cancels the ongoing API call.

getProjectId(callback)

Return the project ID used by this class.

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

Lists metric descriptors that match a filter. This method does not require a Stackdriver account.

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

const client = new monitoring.v3.MetricServiceClient({
  // optional auth parameters.
});

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

client.listMetricDescriptors({name: formattedName})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedName = 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.listMetricDescriptors(nextRequest, options).then(callback);
  }
}
client.listMetricDescriptors({name: formattedName}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

  metric.type = starts_with("custom.googleapis.com/")

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of MetricDescriptor.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of MetricDescriptor 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 ListMetricDescriptorsResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

listMetricDescriptorsStream(request[, options]) → Stream

Equivalent to listMetricDescriptors, but returns a NodeJS Stream object.

This fetches the paged responses for listMetricDescriptors 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.

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

const client = new monitoring.v3.MetricServiceClient({
  // optional auth parameters.
});

const formattedName = client.projectPath('[PROJECT]');
client.listMetricDescriptorsStream({name: formattedName})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

  metric.type = starts_with("custom.googleapis.com/")

See also

https://nodejs.org/api/stream.html

Returns

Stream 

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

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

Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.

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

const client = new monitoring.v3.MetricServiceClient({
  // optional auth parameters.
});

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

client.listMonitoredResourceDescriptors({name: formattedName})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedName = 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.listMonitoredResourceDescriptors(nextRequest, options).then(callback);
  }
}
client.listMonitoredResourceDescriptors({name: formattedName}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

  resource.type = starts_with("gce_") AND resource.label:id

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.

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

const client = new monitoring.v3.MetricServiceClient({
  // optional auth parameters.
});

const formattedName = client.projectPath('[PROJECT]');
client.listMonitoredResourceDescriptorsStream({name: formattedName})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

  resource.type = starts_with("gce_") AND resource.label:id

See also

https://nodejs.org/api/stream.html

Returns

Stream 

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

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

Lists time series that match a filter. This method does not require a Stackdriver account.

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

const client = new monitoring.v3.MetricServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedName = client.projectPath('[PROJECT]');
const filter = '';
const interval = {};
const view = 'FULL';
const request = {
  name: formattedName,
  filter: filter,
  interval: interval,
  view: view,
};

client.listTimeSeries(request)
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedName = client.projectPath('[PROJECT]');
const filter = '';
const interval = {};
const view = 'FULL';
const request = {
  name: formattedName,
  filter: filter,
  interval: interval,
  view: view,
};


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.listTimeSeries(nextRequest, options).then(callback);
  }
}
client.listTimeSeries(request, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

  metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
      metric.label.instance_name = "my-instance-name"

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of TimeSeries.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of TimeSeries 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 ListTimeSeriesResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

listTimeSeriesStream(request[, options]) → Stream

Equivalent to listTimeSeries, but returns a NodeJS Stream object.

This fetches the paged responses for listTimeSeries 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.

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

const client = new monitoring.v3.MetricServiceClient({
  // optional auth parameters.
});

const formattedName = client.projectPath('[PROJECT]');
const filter = '';
const interval = {};
const view = 'FULL';
const request = {
  name: formattedName,
  filter: filter,
  interval: interval,
  view: view,
};
client.listTimeSeriesStream(request)
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

  metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
      metric.label.instance_name = "my-instance-name"

See also

https://nodejs.org/api/stream.html

Returns

Stream 

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

matchMetricDescriptorFromMetricDescriptorName(metricDescriptorName) → String

Parse the metricDescriptorName from a metric_descriptor resource.

Returns

String 

• A string representing the metric_descriptor.

matchMonitoredResourceDescriptorFromMonitoredResourceDescriptorName(monitoredResourceDescriptorName) → String

Parse the monitoredResourceDescriptorName from a monitored_resource_descriptor resource.

Returns

String 

• A string representing the monitored_resource_descriptor.

matchProjectFromMetricDescriptorName(metricDescriptorName) → String

Parse the metricDescriptorName from a metric_descriptor resource.

Returns

String 

• A string representing the project.

matchProjectFromMonitoredResourceDescriptorName(monitoredResourceDescriptorName) → String

Parse the monitoredResourceDescriptorName from a monitored_resource_descriptor resource.

Returns

String 

• A string representing the project.

matchProjectFromProjectName(projectName) → String

Parse the projectName from a project resource.

Returns

String 

• A string representing the project.

metricDescriptorPath(project, metricDescriptor) → String

Return a fully-qualified metric_descriptor resource name string.

Returns

String 

monitoredResourceDescriptorPath(project, monitoredResourceDescriptor) → String

Return a fully-qualified monitored_resource_descriptor resource name string.

Returns

String 

projectPath(project) → String

Return a fully-qualified project resource name string.

Returns

String