Stackdriver Monitoring: Node.js Client

Stackdriver Monitoring API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG .

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained .

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project .
Enable billing for your project .
Enable the Stackdriver Monitoring API .
Set up authentication so you can access the API from your local workstation.

Installing the client library

 npm install @google-cloud/monitoring

Using the client library

 // Imports the Google Cloud client library
const monitoring = require(' @google-cloud/monitoring 
');

async function quickstart() {
  // Creates a client
  const client = new monitoring. MetricServiceClient 
();

  // TODO(developer): Uncomment and set the following variables
  // const projectId = "PROJECT_ID"

  // Prepares an individual data point
  const dataPoint = {
    interval: {
      endTime: {
        seconds: Date.now() / 1000,
      },
    },
    value: {
      // The amount of sales
      doubleValue: 123.45,
    },
  };

  // Prepares the time series request
  const request = {
    name: client.projectPath(projectId),
    timeSeries: [
      {
        // Ties the data point to a custom metric
        metric: {
          type: 'custom.googleapis.com/stores/daily_sales',
          labels: {
            store_id: 'Pittsburgh',
          },
        },
        resource: {
          type: 'global',
          labels: {
            project_id: projectId,
          },
        },
        points: [dataPoint],
      },
    ],
  };

  // Writes time series data
  const [result] = await client.createTimeSeries(request);
  console.log('Done writing time series data.', result);
}
quickstart();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Alert_policy_service.create_alert_policy	source code
Alert_policy_service.delete_alert_policy	source code
Alert_policy_service.get_alert_policy	source code
Alert_policy_service.list_alert_policies	source code
Alert_policy_service.update_alert_policy	source code
Group_service.create_group	source code
Group_service.delete_group	source code
Group_service.get_group	source code
Group_service.list_group_members	source code
Group_service.list_groups	source code
Group_service.update_group	source code
Metric_service.create_metric_descriptor	source code
Metric_service.create_service_time_series	source code
Metric_service.create_time_series	source code
Metric_service.delete_metric_descriptor	source code
Metric_service.get_metric_descriptor	source code
Metric_service.get_monitored_resource_descriptor	source code
Metric_service.list_metric_descriptors	source code
Metric_service.list_monitored_resource_descriptors	source code
Metric_service.list_time_series	source code
Notification_channel_service.create_notification_channel	source code
Notification_channel_service.delete_notification_channel	source code
Notification_channel_service.get_notification_channel	source code
Notification_channel_service.get_notification_channel_descriptor	source code
Notification_channel_service.get_notification_channel_verification_code	source code
Notification_channel_service.list_notification_channel_descriptors	source code
Notification_channel_service.list_notification_channels	source code
Notification_channel_service.send_notification_channel_verification_code	source code
Notification_channel_service.update_notification_channel	source code
Notification_channel_service.verify_notification_channel	source code
Query_service.query_time_series	source code
Service_monitoring_service.create_service	source code
Service_monitoring_service.create_service_level_objective	source code
Service_monitoring_service.delete_service	source code
Service_monitoring_service.delete_service_level_objective	source code
Service_monitoring_service.get_service	source code
Service_monitoring_service.get_service_level_objective	source code
Service_monitoring_service.list_service_level_objectives	source code
Service_monitoring_service.list_services	source code
Service_monitoring_service.update_service	source code
Service_monitoring_service.update_service_level_objective	source code
Snooze_service.create_snooze	source code
Snooze_service.get_snooze	source code
Snooze_service.list_snoozes	source code
Snooze_service.update_snooze	source code
Uptime_check_service.create_uptime_check_config	source code
Uptime_check_service.delete_uptime_check_config	source code
Uptime_check_service.get_uptime_check_config	source code
Uptime_check_service.list_uptime_check_configs	source code
Uptime_check_service.list_uptime_check_ips	source code
Uptime_check_service.update_uptime_check_config	source code
Quickstart	source code

The Stackdriver Monitoring Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule . Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

Legacy versions are not tested in continuous integration.
Some security patches and features cannot be backported.
Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags . The dist-tags follow the naming convention legacy-(version) . For example, npm install @google-cloud/monitoring@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning .

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stablelibraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide .

Please note that this README.md , the samples/README.md , and a variety of configuration files in this repository (including .nycrc and tsconfig.json ) are generated from a central template. To edit one of these files, make an edit to its templates in directory .

License

Apache Version 2.0

See LICENSE