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

phi-accrual-detector

v0.0.4

Published

Port of Akka's AcrrualFailureDetector

Downloads

11

Readme

phi-accrual-detector

What Is It?

This is a port of Akka's Accrual Failure Detector to Node.js. It is an implementation of "The Phi Accrual Failure Detector" by Hayashibara et al. as defined in their paper.

Why Use It?

The phi accrual detector provides a configurable, continuous "suspicion of failure" value for remote systems whose availability is indicated by periodic sampling. The Phi value can help answer questions like:

  • Is some HTTP server up?
  • Did that out-of-process job handler crash?

The standard example is an event source that suddenly stops sending events.

The suspicion level adjusts to the recorded event intervals, which makes it more resilient to event sources that sawtooth into stability.

More examples:

How to Use It

  1. Install: npm install phi-accrual-detector

  2. Determine the configuration settings. The documentation below is largely copied from the Akka source. The specific settings depend on your application.

    1. threshold : The suspicion level above which the event source is considered to have failed.
    2. max_sample_size : The maximum number of samples to store for mean and standard deviation calculations of event reports.
    3. min_std_deviation : Minimum standard deviation for the normal distribution used when calculating phi. Too low a standard deviation might result in too much sensitivity for sudden, but normal, deviations in event intervals.
    4. acceptable_heartbeat_pause : Duration (ms) corresponding to the number of potentially lost/delayed events that will be accepted before it is considered anomalous. This margin is important for surviving sudden, occasional, gaps between event reports.
    5. first_heartbeat_estimate : Duration (ms) values with which to bootstrap the event history. They are recorded with rather high standard deviation since the environment is unknown at initialization.
  3. Reference it:

    var phi_detector = require('phi-accrual-detector');
    var mock_service_detector = phi_detector.new_detector(threshold,
                                                        max_sample_size,
                                                        min_std_deviation,
                                                        acceptable_heartbeat_pause,
                                                        first_heartbeat_estimate,
                                                        optional_name);
    /**
     * The 'available' event is broadcast when the phi value
     * cross from above to below the threshold value
     */
    mock_service_detector.on('available', function (phi) {
      console.log("Sweet - the service is available!");
    })
    /**
     * The 'unavailable' event is broadcast when the phi value
     * crosses from below to above the threshold value
     */
    mock_service_detector.on('unavailable', function (phi) {
      console.log("Rats - the service has forsaken me");
    })
  4. Record events:

var mock_service = setInterval(function() {
  mock_service_detector.signal();
}, 100);

See the ./test directory for more samples and associated graphs to get an idea of phi behavior.

To Do

  1. Create HTTP/S service detectors