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

simple-puppeteer-uptime-checker

v1.1.1

Published

A simple uptime (site health) checker tool made with Puppeteer (headless Chrome).

Downloads

15

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

thedavidbartonthedavidbarton

Keywords

Readme

Dependency Status crocodile

simple-puppeteer-uptime-checker

A simple uptime (site health) checker tool made with Puppeteer (headless Chrome).

Usage

Install & setup

npm install simple-puppeteer-uptime-checker

Create a site-config.json at the root of your Node.js project with the (1) sites you want to monitor, and (2) add one key element's selector as well per url (be careful using simply "body", as even error pages has a valid <body> element).

In this example the first site will throw an error due to bad ssl certificate:

[
  { "site": "https://expired.badssl.com/", "selector": "#dashboard" },
  { "site": "https://badssl.com/", "selector": "#dashboard" },
  { "site": "https://google.com", "selector": "body" }
]

Notifications

You can create notifications via (A) a Gmail email address and/or (B) Slack's Incoming Webhooks.
You can set which one to use with notification type (see in 'Run').

Environment variables

(1) touch an puppeteer-uptime.env file (gitignored) in the root folder.

# gmail credentials
export GMAIL_ADDRESS="<your-email>@gmail.com"
export GMAIL_PASSWORD="**************"
export NOTIFICATION_EMAIL_ADDRESS="<notification-email>@<provider>"

# slack webhooks
export WEBHOOKS_URL="https://hooks.slack.com/services/*********/*********/************************"

(2) source the created file to local environment variables (depending on your platform you'll need to find a method which lasts more than the current session!):

$ source puppeteer-uptime.env

Run

Notification type is the sole (optional) parameter: '--none'(default), '--all', '--slack', '--email'.

CLI usage:

npx simple-puppeteer-uptime-checker
npx simple-puppeteer-uptime-checker --slack

OR via Yarn:

yarn simple-puppeteer-uptime-checker

In app usage:

const simpleUptimeCheck = require('simple-puppeteer-uptime-checker');
(async () => {
  await simpleUptimeCheck();
})();

Note: In app function parameters have higher priority than cli arguments.

const simpleUptimeCheck = require('simple-puppeteer-uptime-checker');
(async () => {
  await simpleUptimeCheck({ args: ['--slack'] });
})();

Output:

HEALTH CHECK FAILED on https://expired.badssl.com/ with HTTP unknown status (Error)
HEALTH CHECK PASSED on https://badssl.com/ with HTTP 200
HEALTH CHECK PASSED on https://google.com with HTTP 200

Schedule it

You can run the script from a scheduled (cron) pipeline.

E.g. (GitHub Actions):

name: monitoring
on:
  schedule:
    - cron: '20 23 * * *'
jobs:
  run-health-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - name: Use Node.js 12.x
        uses: actions/setup-node@v1
        with:
          node-version: 12.x
      - name: Install project
        run: yarn
      - name: Run health check
        run: yarn simple-puppeteer-uptime-checker

License

MIT License

Copyright (c) 2022 David Barton