Stackdriver Monitoring: Node.js Client

Stackdriver Monitoring API client for Node.js

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

• Stackdriver Monitoring Node.js Client API Reference
• Stackdriver Monitoring Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-monitoring

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

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

Installing the client library

npm install @google-cloud/monitoring

Using the client library

// Imports the Google Cloud client libraryconst 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 thesamples/ directory. Each sample'sREADME.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

TheStackdriver Monitoring Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/monitoring@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE