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

exp-leader-election

v0.5.0

Published

Simple leader election library

Downloads

235

Readme

Leader election for nodejs applications

Run tests

Elect a leader among several nodes using consul.

https://www.consul.io/docs/guides/leader-election.html

Usage

Basic example

Connect to consul and get notified about leadership status.

var leaderElection = require("exp-leader-election");
var service = require("my-little-service");

var config = {
  key: "locks/my-little-service",
  consul : {
    host: "my.consul.hostname"
  }
}

leaderElection(config)
.on("gainedLeadership", function () {
    // Whoo-hoo, we have been elected as leader! Do work.
    service.startDoingWork();
  })
.on("error", function () {
   // Error occured, stop work.
   log.error("Leader election error occured", error);
   service.stopDoingWork();
  });

The let-it-crash way

If you want your application to crash in case of leader election errors, just omit the "error" listener. This is the simplest and most robust way to deal with errors, but it requires that you have a process manager (such as forever or pm2) in place to ensure that the application is restarted again.

Configuration

Full Example

{
  key: "locks/my-little-service", // Only required option
  debug: console.log,
  consul: {
    host: "127.0.0.1",
    port: 8050,
    token: "asdpf2344d083udhd8723",
    ttl: 15,
    lockDelay: 10,
    readWait: 180
  }
}

Consul

  • consul.host: Consul hostname or ip (string)
  • consul.port: Consul port (number)
  • consul.ttl: Tuning, session ttl seconds (number, default 15)
  • consul.lockDelay: Tuning, session lock-delay seconds (number, default 10)
  • consul.readWait: Tuning, read wait seconds (number, default 180)

To read more about the tuning parameters, see https://www.consul.io/docs/internals/sessions.html

Debugging

  • debug: function accepting a variable number of args. Supply if you want to print debugging info.