Skip to content

Monitor your API server's latency to Instatus' API.

License

Notifications You must be signed in to change notification settings

KoalBot/API-Latency

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Latency

This is a very simple monitoring script that will monitor the latency of your API server. It simply makes a request to a HTTP or HTTPS path every 30 seconds and reports the latency to Instatus via their API. This is used in a metric graph.

Installation

There are a few prerequisites to run this project locally. You'll need:

  • Node.js - this was built using Node.js v16.11
  • All the dependencies in the package.json

Clone the repo to your system

To install the dependencies simply run npm install.

You'll then need to set up your environment variables.

Operation

Once you've installed the latency monitor, you'll need to run it. To run it, we'd recommend using a process manager like pm2.

Secrets

We store secrets in a .env file stored in the root directory of the project - you can't see this file because it's in our .gitignore.

Please see the format for this file below

API_KEY=

License

This project is licensed under MIT License

About

Monitor your API server's latency to Instatus' API.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published