Skip to content

Super simple server for monitoring your endpoints via a ping/visit

Notifications You must be signed in to change notification settings

kf4x/api-status

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Status Page and Monitor

Uses the super fast Falcon framework with Advanced python scheduler. NO javascript or external libs used to manipuate DOM in hopes to keep it safe and fast.

Why

Status pages are expensive! So I created this for my projects. You can see it running live

How

This is a small app that pings API endpoints and checks response. If the response is not 200 then it notifies subscribers using AWS SNS.

Currently you can subscribe to get alerts via email or SMS.

Meant to be small lightweight. Yes the css is not great, but I didnt want to add exernal libs.

Overview of Endpoints

Endpoint Description
/status Get the status of the API
/ Get the overview of all the endpoints

Setup

This is built against python 3.5 and Cython!

Create a new venv and install deps.

virtualenv <env_name> --python=python3
pip install -r requirements.txt

Open environment.py file and fill in

  • DEBUG turn on debug mode
  • endpoints list of endpoints to check

You will need environment variables.

REGION=region
KEY_ID=key_id
ACCESS_KEY=secret_access
ANY_STATUS=arn
LOGIN=username:password

Running

Spin up Gunicorn and run. Note that production is ran with uwsgi

gunicorn app

Author: Javier

Email: youracow@gmail.com

About

Super simple server for monitoring your endpoints via a ping/visit

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published