knocean / knode

Knowledge Development Environment
BSD 3-Clause "New" or "Revised" License
1 stars 1 forks source link

Add status page #13

Closed jamesaoverton closed 7 years ago

jamesaoverton commented 7 years ago

We should add a status page that reports on system health. If something is broken, it should be loud and obvious. The first version should:

We should be able to use this page with an external monitoring system. The monitorign system should check for an "All system green" title (or something), otherwise notify the person in charge that there's a problem.

inaimathi commented 7 years ago

Preliminary thing up at https://github.com/knocean/knode/tree/basic-status-page

Although, something tells me

  1. We might want to make this a JSON API endpoint if the goal is for monitoring software to ping it periodically
  2. If the goal is health checks, then we should probably do something a bit more elaborate (periodically hit various GET endpoints and check for response consistency, possibly set up a heartbeat send from the server etc). My gut says that requesting only one page is a decent head-check, but will give lots of false positives on general server health.
jamesaoverton commented 7 years ago

Yeah, but let's start with the simplest thing.

Now the @state incudes an API key, so we can't just show all the data. Please just show the term count for now, and merge the code into master.