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

@metrics/daemon

v0.1.0

Published

Daemon for collecting metrics over misc network protocols. Provides a stream for further piping of metrics.

Downloads

15

Readme

@metrics/daemon

Daemon for collecting metrics over a network. Provides a stream for further piping of metrics.

Dependencies Build Status Greenkeeper badge Known Vulnerabilities

Installation

$ npm install @metrics/daemon

Example

Set up a daemon with UDP on port 6000 as transport and pipes the incomming metrics into the @metrics/client:

const Daemon = require('@metrics/daemon');
const Client = require('@metrics/client');

const daemon = new Daemon('udp', { port: 6000 });
const client = new Client();

daemon.pipe(client);

daemon.listen();

Description

This module makes it possible to create a socket one can recieve metrics over. The socket can be of different protocols (UDP, TCP etc) but the data trasmitted over it is expected to be of the @metrics/metric type. The recieved metrics can be piped to other metric modules for further handling.

For sending metrics over a socket one are expected to use the @metrics/emitter module.

The main purpose of this is to be able to collect metrics from multiple processes. Here is a simplified example of each worker in a cluster pushing metrics to the master and the master pushing the metric further:

const master = () => {
    const daemon = new Daemon('udp', { port: 6000 });
    const client = new Client();

    daemon.pipe(client);

    daemon.listen();
};

const worker = () => {
    const emitter = new Emitter('udp', { port: 6000 });
    const client = new Client();

    client.pipe(emitter);

    client.metric({
        name: `worker_${cluster.worker.id}`,
        description: `Worker number: ${cluster.worker.id}`,
        value: 1,
    });
};

const workers = [];

if (cluster.isMaster) {
    for (let i = 0; i < (os.cpus().length - 1); i++) {
        workers.push(cluster.fork());
    }
    master();
}

if (cluster.isWorker) {
    worker();
}

See the cluster example in examples for a full example.

Constructor

Create a new Daemon instance.

const Daemon = require('@metrics/daemon');
const daemon = new Daemon(transport, options);

transport (required)

What type of transport to use. Supported values are:

  • udp - For UDP transport.

options (optional)

An Object containing misc configuration for the selected transport. Please see each transport for which option which can be passed in.

returns

Returns a Readable stream in object mode.

API

The Daemon instance has the following API:

.listen()

Starts the daemon with the selected transport.

Transports

The following transports is supported:

UDP

UDP as a transport can be enabled by providing udp to the transport argument on the Daemon constructor. The UDP transport takes the following options (passed to the options argument on the Daemon constructor):

  • port - Number - The port to bind to. Default: 40400.
  • address - String - The address to bind to. Default: localhost.
  • logger - Function - Any logger that implements the methods trace, debug, info, warn, error and fatal. Under the hood abslog is used. See that module for further information. If no logger is passed in, nothing will be logged.