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

response-dashboard

v1.0.32

Published

Performance measurement dashboard with configurable metrics and end-point monitoring. Ideally suited to API microservices.

Downloads

144

Readme

dashboard

Performance measurement dashboard with configurable metrics and end-point monitoring. Ideally suited to API microservices.

JavaScript Style Guide Node.js Package

Getting Started

IMPORTANT This should only be used to monitor servers and services that you have responsibility for.

  1. Clone or download the project
  2. Modify the measurements.json as required (see below)
  3. Run npm install to get all the dependencies
  4. Run npm start to start the server
  5. Point the browser at the server (http://localhost:4000)

Prerequisites

  • node 12.x +
  • npm 7.x +

Configuring measurements.json

  • Edit the existing file
  • Any number of measurements can be added, but may impact performance and usability if you have too many
  • Existing measurements for local CPU and memory are included
  • You can measure the performance of any URL:
  • use /api/proxy/url?url=www.example.com as the url
  • use response as the value
  • If you want to record any other metric(s) from an API endpoint, create a new .js file in proxy as a copy of one of the existing files and include the metric(s) you want in the JSON response. The example random_number.js gets a random number from the remote CSRNG (https://csrng.net) site and parses the JSON response to display on the dashboard

Each measurement has the following keys:

"name": "designs94.com spark", // name of the chart

"location": "board4", // location on the page

"url": "/api/proxy/url?url=http://designs94.com", // url to call

"value": "response", // value to get from JSON response [optional] [default: response time, ms]

"chartType": "spark", // 'spark' line or 'gauge'

"max": 300, // upper limit of chart [optional] [default:100]

"threshold": 250, // alerting threshold [optional] [default:100]

"data": [] //required for chartType = spark

Using for your project

  • Follow the steps in getting started
  • Disconnect the git repo with git init
  • Add your own git repo using git remote add origin [url]
  • Push to your repo with git push --set-upstream origin master
  • Change the links in this readme.md file as required
  • Configure the measurements.json as needed

Running the tests

To run the tests, jest must be installed.

  • run npm test to execute the tests. Shipped tests include validation that routes are loaded and the application has been built correctly.

You are strongly encouraged to write your own tests for any functionality and routes you develop. Check __tests__/example.test.js for an example.

Dependencies

The application relies on got. There are no other dependencies.

Documentation

Documentation is available at './docs/response-dashboard/1.0.16/index.html'

Contributing and Code of Conduct contributions welcome

Please read CONTRIBUTING.md for details on the code of conduct, and the process for submitting pull requests.

Authors

  • Marc Timperley - Initial work

License

This project is licensed under the MIT License - see the LICENSE.md file for details

ToDo

  • [ ] Add css/scss
  • [ ] Build interval per measurement
  • [X] Build all test cases
  • [ ] Improve security to web server front end
  • [X] Improve automation
  • [X] Test coverage
  • [ ] Build admin UI
  • [X] Move measurement config to JSON file
  • [X] Display current alerts on dashboard
  • [X] Build UI for alerts
  • [ ] Write alerts to database
  • [X] Set up deployment pipeline
  • [X] Complete documentation

Acknowledgments

https://nodei.co/npm/response-dashboard.png?downloads=true&downloadRank=true&stars=true