@google-cloud/monitoring

What is @google-cloud/monitoring?

@google-cloud/monitoring is a Node.js client library for interacting with Google Cloud Monitoring, which allows you to collect and manage metrics, create and manage alerting policies, and visualize your data in dashboards.

What are @google-cloud/monitoring's main functionalities?

Collecting Metrics

This feature allows you to list all the metric descriptors available in your Google Cloud project. Metric descriptors define the schema of the time series data.

const {MetricServiceClient} = require('@google-cloud/monitoring');
const client = new MetricServiceClient();

async function listMetrics() {
  const [descriptors] = await client.listMetricDescriptors({
    name: client.projectPath('your-project-id'),
  });
  descriptors.forEach(descriptor => console.log(descriptor.name));
}
listMetrics();

Creating Alert Policies

This feature allows you to create an alert policy that monitors a specific metric and triggers an alert when the metric exceeds a defined threshold.

const {AlertPolicyServiceClient} = require('@google-cloud/monitoring');
const client = new AlertPolicyServiceClient();

async function createAlertPolicy() {
  const projectId = 'your-project-id';
  const alertPolicy = {
    displayName: 'Test Alert Policy',
    conditions: [{
      displayName: 'Test Condition',
      conditionThreshold: {
        filter: 'metric.type="compute.googleapis.com/instance/cpu/utilization"',
        comparison: 'COMPARISON_GT',
        thresholdValue: 0.8,
        duration: {seconds: 60},
      },
    }],
    notificationChannels: [],
  };
  const [policy] = await client.createAlertPolicy({
    name: client.projectPath(projectId),
    alertPolicy,
  });
  console.log(`Created alert policy ${policy.name}`);
}
createAlertPolicy();

Creating Dashboards

This feature allows you to create a custom dashboard to visualize your metrics. The dashboard can include various widgets such as charts and tables.

const {DashboardsServiceClient} = require('@google-cloud/monitoring-dashboards');
const client = new DashboardsServiceClient();

async function createDashboard() {
  const projectId = 'your-project-id';
  const dashboard = {
    displayName: 'Test Dashboard',
    gridLayout: {
      widgets: [{
        title: 'CPU Utilization',
        xyChart: {
          dataSets: [{
            timeSeriesQuery: {
              timeSeriesFilter: {
                filter: 'metric.type="compute.googleapis.com/instance/cpu/utilization"',
              },
            },
          }],
        },
      }],
    },
  };
  const [response] = await client.createDashboard({
    parent: client.projectPath(projectId),
    dashboard,
  });
  console.log(`Created dashboard ${response.name}`);
}
createDashboard();

Other packages similar to @google-cloud/monitoring

prom-client

prom-client is a Prometheus client for Node.js that allows you to instrument your application with custom metrics and expose them via an HTTP endpoint. Unlike @google-cloud/monitoring, which integrates with Google Cloud Monitoring, prom-client is designed to work with Prometheus, an open-source monitoring and alerting toolkit.

newrelic

newrelic is a Node.js agent for New Relic, a cloud-based observability platform. It provides similar functionalities to @google-cloud/monitoring, such as collecting metrics, creating alerts, and visualizing data, but it is specifically designed to integrate with the New Relic platform.

datadog-metrics

datadog-metrics is a client library for sending custom metrics to Datadog, a monitoring and analytics platform. Like @google-cloud/monitoring, it allows you to collect and manage metrics, but it is tailored for use with the Datadog service.

README

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.

• 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 older Google APIs Client Libraries, in Client 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 with a service account 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
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 stable libraries 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