Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a public status page #346

Closed
benefacto opened this issue Apr 22, 2021 · 6 comments
Closed

Add a public status page #346

benefacto opened this issue Apr 22, 2021 · 6 comments
Assignees
Labels
enhancement New feature or request

Comments

@benefacto
Copy link
Contributor

It would be good to have a “status” page, where we could have our subgraphs, smart contracts, etc. and if they’re responding with incorrect data have a warning.

@benefacto benefacto added the enhancement New feature or request label Apr 22, 2021
@benefacto benefacto self-assigned this Apr 22, 2021
@mitche50
Copy link
Contributor

The general idea here is to have a status.badger.finance website (which could have a corresponding API) that checks our critical data paths and reports if they’re online or not.

Incomplete list:

  • badger API endpoints returning 200s
  • subgraph endpoints returning 200s
  • Smart contract reads returning normal responses
  • Etc.

this would be best visualized as a list with information on what is down (https://status.thegraph.com/ does a great job)

@benefacto
Copy link
Contributor Author

benefacto commented Apr 22, 2021

FYI, I pulled in a designer, @cedricwaxwing , on the dOrg side to spin up a quick mockup for this.

@cedricwaxwing
Copy link
Contributor

cedricwaxwing commented Apr 23, 2021

👋 hey @benefacto @mitche50. I’ve got a first draft ready for your eyes here: https://www.figma.com/file/jJGL8RbtR7X7gw82KDk3X9/status.badger.finance

Are we interested in adding any historic uptime / system metrics (similarly to the graph)?

Click on the “play” button in the top right to open up the scrollable, governable prototype. Feel free to leave specific feedback in the figma and general comments here.

@benefacto
Copy link
Contributor Author

Thanks for this, @cedricwaxwing ! This will be really great to work off of. I think it's simple and elegant, in line with TheGraph's example.

@mitche50 , I took a closer look at this and I believe TheGraph isn't actually rolling their own but using a combination of DevOps tools to do this including Statuspage that is likely integrating with their monitoring software.
That said, we certainly do not have to go their route. There are a number of alternatives, including open source ones, but they'd still have to be hosted on a centralized server. If we wanted to keep things decentralized, we could roll our own by hosting the front end of the site on IPFS via Fleek (the 'status' CNAME would point to Fleek's IPFS gateway) and we could also store the data on IPFS via something like OrbitDB. The only thing that would be required would be for us to have at least one IPFS node to persist it and we may still need a credit card for Fleek (or an existing team/account).
I'd be curious to know your thoughts on this if you have any.

@benefacto
Copy link
Contributor Author

FYI, @carlosfebres and @MatthiasBakken will be handling the front end implementation of this while I finish up the back end.

@okjintao
Copy link
Contributor

https://github.com/Badger-Finance/badger-status-page
Badger-Finance/badger-api#132

all the pieces are done for this and ready just awaiting integration / deployment. closing this ticket as done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

6 participants