Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
@google-cloud/monitoring
Advanced tools
@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.
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();
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 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 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.
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 Explained.
Table of contents:
npm install @google-cloud/monitoring
// Imports the Google Cloud client library
const monitoring = require('@google-cloud/monitoring');
async function quickstart() {
// Your Google Cloud Platform project ID
const projectId =
process.env.GCLOUD_PROJECT ||
process.env.GOOGLE_CLOUD_PROJECT ||
'YOUR_PROJECT_ID';
// Creates a client
const client = new monitoring.MetricServiceClient();
// 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);
}
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
Sample | Source Code | Try it |
---|---|---|
Alerts | source code | |
Metrics | source code | |
Quickstart | source code | |
Uptime | source code |
The Stackdriver Monitoring Node.js Client API Reference documentation also contains samples.
Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.
Client libraries targeting some end-of-life versions of Node.js are available, and
can be installed via npm dist-tags.
The dist-tags follow the naming convention legacy-(version)
.
Legacy Node.js versions are supported as a best effort:
legacy-8
: install client libraries from this dist-tag for versions
compatible with Node.js 8.This library follows Semantic Versioning.
This library is considered to be General Availability (GA). This means it is 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 GA libraries are addressed with the highest priority.
More Information: Google Cloud Platform Launch Stages
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 template in this
directory.
Apache Version 2.0
See LICENSE
FAQs
Stackdriver Monitoring API client for Node.js
The npm package @google-cloud/monitoring receives a total of 128,976 weekly downloads. As such, @google-cloud/monitoring popularity was classified as popular.
We found that @google-cloud/monitoring demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.