@google-cloud/monitoring

Stackdriver Monitoring API client for Node.js

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@google-cloud/monitoring
6663.0.220 hours ago6 years agoMinified + gzip package size for @google-cloud/monitoring in KB

Readme

Google Cloud Platform logorelease level npm version
Stackdriver Monitoring collects metrics, events, and metadata from Google Cloud Platform, Amazon Web Services (AWS), hosted uptime probes, application instrumentation, and a variety of common application components including Cassandra, Nginx, Apache Web Server, Elasticsearch and many others.
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 Explainedexplained.
Table of contents:
Before you begin Installing the client library Using the client library

Quickstart

Before you begin

  1. Select or create a Cloud Platform projectprojects.
  2. Enable billing for your projectbilling.
  3. Enable the Stackdriver Monitoring APIenableapi.
  4. Set up authentication with a service accountauth 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 | | --------------------------- | --------------------------------- | ------ | | Alerts.backup Policies | source code | !Open in Cloud Shellshellimg | | Alerts.delete Channels | source code | !Open in Cloud Shellshellimg | | Alerts.enable Policies | source code | !Open in Cloud Shellshellimg | | Alerts.list Policies | source code | !Open in Cloud Shellshellimg | | Alerts.replace Channels | source code | !Open in Cloud Shellshellimg | | Alerts.restore Policies | source code | !Open in Cloud Shellshellimg | | Create Metric Descriptor | source code | !Open in Cloud Shellshellimg | | Delete Metric Descriptor | source code | !Open in Cloud Shellshellimg | | Get Metric Descriptor | source code | !Open in Cloud Shellshellimg | | Get Monitored Resource Descriptor | source code | !Open in Cloud Shellshellimg | | List Metric Descriptors | source code | !Open in Cloud Shellshellimg | | List Monitored Resource Descriptors | source code | !Open in Cloud Shellshellimg | | Read Time Series Aggregate | source code | !Open in Cloud Shellshellimg | | Read Time Series Data | source code | !Open in Cloud Shellshellimg | | Read Time Series Fields | source code | !Open in Cloud Shellshellimg | | Read Time Series Reduce | source code | !Open in Cloud Shellshellimg | | Write Time Series Data | source code | !Open in Cloud Shellshellimg | | Quickstart | source code | !Open in Cloud Shellshellimg | | Uptime | source code | !Open in Cloud Shellshellimg |
The Stackdriver Monitoring Node.js Client API Referenceclient-docs 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 stable libraries are addressed with the highest priority.
More Information: Google Cloud Platform Launch Stageslaunchstages

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