Home

pingflux

A lightweight, event-driven network diagnostics and observability SDK for Node.js.

Point it at a host, pick a protocol, set an interval. It runs probes in the background and emits events when a target is up, down, slow, or broken.

Platform support: the ping (ICMP) protocol is Linux only for now. Windows and macOS are planned. All other protocols work everywhere Node.js runs.

Quick start

npm install pingflux

import { Pingflux } from "pingflux";

const pf = new Pingflux({ threshold: 500, retry: 2 });

pf.watch({ protocol: "https", url: "example.com" });
pf.watch({ protocol: "ping", url: "1.1.1.1" });

pf.on("up",   (e) => console.log(`${e.target} is up (${e.latency}ms)`));
pf.on("down", (e) => console.log(`${e.target} is down`));

Pages

Page	What is inside
Getting-Started	Install, first monitor, requirements
Protocols	http, https, tcp, udp, dns, ping at a glance
Events	up, down, slow, probe_error and the event payload
ICMP-Ping	How the native ICMP addon works, permissions, errors
Native-Addon	Building, prebuilds, source layout
Troubleshooting	Common problems and fixes
Roadmap	What is planned

Links

• GitHub repository
• npm package
• Report an issue