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

active-surveillance

v1.1.2

Published

Configurable website monitoring.

Downloads

7

Readme

Active Surveillance: Schedule based website monitoring.

Build Status

Continously monitor a set of URLs to ensure a website or API is functioning properly by repeatably getting the content and validating that it is correct.

Configs

The configuration for the surveillance is simple:

  • toWatch: The only required configuration, this is the an array of objects that represent URL configurations that should be watched.
  • onFailure: An optional configuration, this is a function that will be run every time a URL under surveillance fails to return a 200 or fails a user defined validation check. By default this will print to console.
  • onSuccess: An optional configuration, this is a function that will be run every time a URL under surveillance successfully returns a 200 and passes any provided validation check. By default this will print to console.

URL Configs

Each URL configuration provided in toWatch can pass the following properties:

  • url: A required property that is a fully qualified URL (e.g. https://www.mulletify.com).
  • rateInSeconds: How often the url should be put under surveillance.
  • name: An optional property that describes the URL. This is used to report statistics, so any configurations with duplicate names will coalesce their results. By default this is the url.
  • fetchParameters: An optional property that can be set to an object containing any additional parameters that should be provided to fetch
  • validatePage: An optional property that can be set to a function that accepts the page source and performs any validation of that page.
  • validateJson: An optional property that can be set to a function that accepts the json returned and performs any validation on that result. If both validatePage and validateJson are provided than only validatePage will be run.

Example Usage

import createActiveSurveillance from 'active-surveillance';

const surveillance = createActiveSurveillance({
    toWatch: [{
        name: 'Webpage',
        url: 'https://www.mulletify.com',
        validatePage: pageSource => {
            //validate the page text with your favorite assertion library
        },
        rateInSeconds: 1,
    }, {
        name: 'API endpoint',
        url: 'https://www.mulletify.com/v1/mullets/123',
        validateJson: json => {
            // validate a pre-parsed json blob with your favorite assertion library
        },
        rateInSeconds: 1000,
    }, {
        name: 'POST endpoint',
        url: 'https://www.mulletify.com/v1/mullets/',
        fetchParameters: {
            method: 'POST',
            body: { /* your post */ }
        }
        validateJson: json => {
            // validate a pre-parsed json blob with your favorite assertion library
        },
        rateInSeconds: 1000,
    }],
    onFailure: f => { console.log(f); },
    onSuccess: s => { console.log(s); },
});

// begin monitoring watched urls
surveillance.start();

// get metrics about each url under test
console.log(surveillance.status());

// stop watching urls
surveillance.stop();