@sealsystems/profiling

@sealsystems/profiling captures profiling data.

Installation

$ npm install @sealsystems/profiling

Quick Start

First you need to integrate @sealsystems/profiling into your application.

const profiling = require('@sealsystems/profiling');

It will capture the CPU usage and memory consumption once per minute.

To gather custom values, call noteValue with a key and value pair.

profiling.noteValue('foo', 23);

Activate profiling

By default, profiling is disabled. To enable it, provide the host and the port of a running StatsD server using the STATSD_URL environment variable.

export STATSD_URL=udp://localhost:8125

In order to distinguish between different apps, each running instance generates a random UUID and includes it in the path of the keys sent to the StatsD server. To provide a fix identifier, set the SERVICE_NAME environment variable.

export SERVICE_NAME=MyService

Collecting the data

To actually collect profiling data, you need to start a StatsD server. For development purposes, simply run:

docker run -d --name statsd -p 80:80 -p 2003:2003 -p 8125:8125/udp hopsoft/graphite-statsd

You can access the server's web ui via port 80 of your Docker host, e.g. http://localhost/.

To stop the StatsD container again, type:

docker stop statsd

Running the build

To build this module use roboter.

$ bot