Status-page

A command-line tool that will pull status information from different services, displays the results on the console and saves it into a data store.

Installation

Download the docker image

$ docker pull diogoviana/status-page

Gems used

You don't have to install any gem if you are using the Docker image.

$ gem install thor
$ gem install oga
$ gem install rspec
$ gem install time_difference
$ gem install command_line_reporter

Configuration

It is possible to configure the services that will be checked and the inverval(in seconds) of time during the live mode. You can find this file inside config/setup.yml

$ services:
    - name: Bitbucket
      address: https://bitbucket.status.atlassian.com/
    - name: Github
      address: https://www.githubstatus.com/
  interval: 5

Usage

Start your docker image

All following steps need the docker image to be running ir order to work correctly.

$ docker run -d -t --name status diogoviana/status-page

Pull --scope

Pull the status of all services configured in setup.yml. The resuls will both be saved in a CSV file and printed on the screen.

$ docker exec -it status status-page pull

You can additionally add a scope to pull data only from a specific service. This service should exist inside your setup.yml file.

$ docker exec -it status status-page pull github

Live --scope

Pull the status of all services configured in setup.yml continuously. The resuls will both be saved in a CSV file and printed on the screen. This service can be canceled by pressing CTRL + C.

$ docker exec -it status status-page live

You can additionally add a scope to pull data only from a specific service. This service should exist inside your setup.yml file.

$ docker exec -it status status-page live github

History

Display all the data which was gathered by LIVE and PULL modes.

$ docker exec -it status status-page history

Stats

Display all the data which was gathered by LIVE and PULL in a summarized way

$ docker exec -it status status-page stats

Backup --path

Create a backup file inside the path passed as an argument. You don't need to pass the file name in data argument, only the path. The file will be save as your/path/of/choice/store.csv.bkp

$ docker exec -it status status-page backup /usr/local/bkp

Restore --path

Restore and merge the backup file to the current store file. Again, the file name is not needed, only the path which the backup was saved. It is going to look up for a file named store.csv.bkp inside the page you gave as an argument.

$ docker exec -it status status-page restore /usr/local/bkp

Test

All class files are tested using rspec. You can confirm that all are green, by running:

$ rspec spec/