Skip to content
This repository has been archived by the owner on Mar 4, 2018. It is now read-only.

jsmecham/gauges-status-board-panel

Repository files navigation

Gauges Status Board Panel

Screenshot

This web application can be used to pull in analytics from the Gauges service and display them on your Status Board.

Configuration

To configure your own instance of this panel, you should be familiar with running Sinatra or Ruby on Rails instances. Of course, if you are not familiar with setting up and running a Sinatra web application, the easiest route is to use Heroku.

Please reference this tutorial for more information about deploying to Heroku.

Defining Your API Key

You will need to get an API key for your Gauges account by following the instructions at http://get.gaug.es/documentation/api/authentication/.

Once you have your API key, you should update the app.rb file to include it, like so:

set :api_key, "<your api key>"

This step is optional, however, as you can always pass in your API key to the app with the api_key request parameter. For example:

https://<your-deployment-location>/traffic/<your-gauge-id>?api_key=<your-api-key>

Usage

The only supported endpoint is the Traffic endpoint. To use, simply add a Graph panel to your Status Board with a URL similar to the following:

https://<your-deployment-location>/traffic/<your-gauge-id>

If you have not specified your API key in app.rb, your URL should look like:

https://<your-deployment-location>/traffic/<your-gauge-id>?api_key=<your-api-key>

Author

Developed by Justin Mecham (email, twitter).

License

This project is licensed under the terms of the MIT License.

About

Display your website traffic statistics on Panic's Status Board.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published