Skip to content

cooncesean/bg-indexer-health-front-end

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Overview

A dead-simple web app that provides visibility into BitGo's indexer infrastructure. This repo represents the front-end portion of the project. This single, static page app simply fetches JSON from s3 (representing the most recent indexer statuses) and presents them in table for the requestor.

How It Works

  1. The back-end app polls BitGo's indexers (prod + test) to find the latest block processed for each coin.
  2. It compares those values to public block explorers to determine whether or not we are behind chain head.
  3. It stores the status of each of our indexers in a JSON file on s3.
  4. The front-end app (this repo) fetches the most recent status file from s3 and uses it to construct a dashboard for the user.

Motivation

Indexers (and full nodes) can be flaky. If we want to provide world class support to our customers, we need better visibility into the health of our core infrastructure -- this is a step in that direction.

References

The paired, back-end project (the project that populates the JSON data that this project consumes) is available here: https://github.com/cooncesean/bg-indexer-health-lambda. They were distinct enough that it didn't make a whole lot of sense to smush them together.

Local Development

In order for the CORS loading of the s3 JSON file (which represents the current state of our indexer infrastructure), you will need to load app.html via http (as opposed to loading it via file:///).

On Mac, this is fairly straightforward; navigate to the project directory and run:

python -m SimpleHTTPServer 8000

This starts a local python server at that directory, which allows you to access app.html via http://. You can view the file at: http://localhost:8000/app.html, make local edits and reload the page.

Public URL

This project is currently up and running at: http://bitgo-indexer-health-front-end.s3-website-us-west-2.amazonaws.com/

About

A dead-simple web app that provides visibility into BitGo's indexer infrastructure.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published