npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-heap-gc-cloudwatch

v2.2.0

Published

Report v8 heap usage and gc activity to CloudWatch

Downloads

15

Readme

Build Status NPM version NPM dependencies NSP Status

node-heap-gc-cloudwatch

Send v8 heap statistics and garbage collection statistics to CloudWatch.

CloudWatch heap space used size graph

Getting started

Install the module:

npm install node-heap-gc-cloudwatch

In your app, create and start an agent:

var config = {};
require("node-heap-gc-cloudwatch")(config, function(err, agent) {
  if (err) {
    throw err;
  } else {
    agent.on("error", function(err) {
      console.log("error", err);
    });
    agent.start(function(err) {
      if (err) {
        throw err;
      } else {
        console.log("started");
      }
    });
  }
});

After ~1 minute you will see the first metrics in CloudWatch under the node name space.

Make sure to allow the cloudwatch:PutMetricData Action in your IAM policy.

Configuration

  • collectInterval: Number - Collect new heap statistics every collectInterval ms (default 1000)
  • writeInterval: Number - Send metric to CloudWatch every writeInterval ms (default 60000)
  • heapStatistics: Array[String] - Values to report to CloudWatch from v8.getHeapStatistics() (default ["total_heap_size", "total_heap_size_executable", "total_physical_size", "total_available_size", "used_heap_size", "heap_size_limit"])
  • heapSpaceStatistics: Array[String] - Values to report to CloudWatch from v8.getHeapSpaceStatistics() (default ["space_size", "space_used_size", "space_available_size", "physical_space_size"])
  • cloudwatch: AWS.CloudWatch - CloudWatch service object (default new AWS.CloudWatch())
  • namespace: String - The namespace for the metric data (default node)
  • dimensions: Object[String, String] - Add additional dimensions like {Application: "webshop", Environment: "production"}. (default {})
  • addProcessIdDimension: Boolean - If true, adds the ProcessId dimension with the value of process.pid (default false)
  • addInstanceIdDimension: Boolean - If true, adds the InstanceId dimension with the value of the EC2 instance id (default false)
  • omitGCPauseMetrics: Boolean - If true, omits the gc_pause metrics (default false)

Important

CloudWatch treats each unique combination of dimensions as a separate metric. For information on how this affects pricing, see the Amazon CloudWatch product information page.