Skip to content
Collecting metrics from a box provider and exporting data
Go Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
addons
src/github.com/nlamirault/skybox
vendor
.gitignore
CONTRIBUTING.md
ChangeLog.md
LICENSE
Makefile
README.md
circle.yml
docker-compose.yml

README.md

Skybox

License Apache 2

Master :

  • Circle CI

Develop :

  • Circle CI

Skybox is an agent collecting metrics from a box provider, and writing them into outputs. You could use Grafana to display nice dashboards.

Supported box providers :

Supported outputs :

Installation

You can download the binaries :

Configuration

Skybox configuration use toml format. File is located into $HOME/.config/skybox/skybox.toml.

Usage

Freebox

Setup configuration :

[freebox]
url= "http://mafreebox.freebox.fr/"
token = ""
$ skybox check box

skybox will ask for an app_token using the API. A message will be displayed on the Freebox LCD asking the user to grant/deny access to the requesting app.

Once the app has obtained a valid app_token, edit your configuration file, and setup this token into the specific entry: token.

InfluxDB

Setup configuration :

[influxdb]
url = "http://localhost:8086/"
username = "root"
password = "root"
database = "skybox"
retentionPolicy = "default"

And check connection :

$ skybox check output

Development

  • Initialize environment

      $ make init
    
  • Build tool :

      $ make build
    
  • Start InfluxDB output (port 8083) and Grafana (port `3000) using [Docker Compose][] :

      $ docker-compose up
    
  • Launch unit tests :

      $ make test
    

Contributing

See CONTRIBUTING.

License

See LICENSE for the complete license.

Changelog

A changelog is available

Contact

Nicolas Lamirault nicolas.lamirault@gmail.com

You can’t perform that action at this time.