simple-dashboard

A straightforward dashboard for showing an overview of the status of servers and infrastructure. Runs entirely in the browser as static Javascript so it can be hosted easily without needing to set up and maintain yet another server.

Configuration

The dashboard is configured via a JSON config file that defines where to get status information from.

{
    "title": "Infrastructure status",
    "sources": [{
        "type": "statusio",
        "title": "Docker",
        "link": "http://status.docker.com",
        "id": "533c6539221ae15e3f000031"
    }, {
        "type": "rss-aws",
        "title": "CloudFront",
        "id": "cloudfront"
    }, {
        "type": "rss-aws",
        "title": "EC2 US East",
        "id": "ec2-us-east-1"
    }, {
        "type": "dropwizard",
        "title": "Production - Healthcheck",
        "adminPath": "http://localhost:9090/admin"
    }]
}

Status sources

General options

Options for all the status sources.

Docker Cloud service

Status of a Docker Cloud (formerly Tutum) service.

Dropwizard healthcheck

The status of a Dropwizard service's health checks.

By default Dropwizard is not set up to allow cross-origin requests, so you will have to add a servlet filter to the admin port that does this. TODO example.

GitHub branches

All the branches of a GitHub repository. Also shows any open pull requests from those branches to master.

Can also show the status of the latest commit in each branch. This is set by many build system that integrate with GitHub such as CircleCI.

Loggly

Number of WARN and ERROR log messages in Loggly.

Static message

A static message.

Amazon Web Services status

One of the statuses from Amazon Web Services' Service Health Dashboard.

Response status code

Whether an arbitrary URL returned a successful status code. Any status code below 400 counts as successful.

Make sure that the server is set up to allow cross-origin requests.

Status.io

Status from a service dashboard hosted by Status.io. Many web services use this for their status pages.

Visual Studio Team Services branches

Build status of the latest commit for all the branches in a Visual Studio Team Services Git repository. Also shows highlights branches with an open pull request to master.

Visual Studio Team Services build

Build status of the latest commit for a single branch in a Visual Studio Team Services Git repository.

Complications

Credentials

If you put secrets such as Github tokens in the configuration file, then you should either encrupt the secret or only upload the dashboard to a non-public site.

Values can be encrypted with window.encrypt("password", "value") which should then be placed in config.json as e.g. {"token": {"encrypted": "..."}}

Cross-origin requests

TODO

Setup

• Install NodeJS
• npm install -g grunt-cli
• npm install

Development

• grunt dev
• Open localhost:8080
• The development configuration file will be loaded directly from src/config.json

Adding new source types

1. Create a new subclass of Source that overrides getStatus().
2. Define its type in the configuration file by adding it as a static property on your subclass named type.
3. Add it to the list in SourceTypes.

Building

• grunt build
• The files in target/dist can then be placed on a server. The real config.json configuration file you want to use should be placed next to index.html.