General

Dashing is a Sinatra based framework that lets you build beautiful dashboards.

This dashing implementation uses the Icinga 2 API to show basic alerts on your dashboard.

Demo

A demo is available inside the Icinga Vagrant Boxes.

Support

This is intended for demo purposes. You may use the provided examples in your own implementation.

Please open issues at dev.icinga.org. In case you've created a PR/patch, open a new issue linking to it as well please :)

If you have any questions, please hop onto the Icinga community channels.

License

• Dashing is licensed under the MIT license.
• Icinga specific jobs and dashboards are licensed under the GPLv2+ license.

Requirements

• Ruby, Gems and Bundler
• Dashing Gem
• Icinga 2 API (v2.5+)

Gems:

gem install bundler
gem install dashing

In case the installation takes quite long and you do not need any documentation, add the --no-document flags.

Icinga 2

Icinga 2 provides either basic auth or client certificates for authentication.

Therefore add a new ApiUser object to your Icinga 2 configuration:

vim /etc/icinga2/conf.d/api-users.conf

object ApiUser "dashing" {
  password = "icinga2ondashingr0xx"
  permissions = [ "status/query", "objects/query/*" ]
}

Set the ApiUser permissions according to your needs. By default we will only fetch data from the /v1/status and /v1/objects endpoints, but do not require write permissions.

In case you want to use client certificates, set the client_cn from your connecting host and put the client certificate files (private and public key, ca.crt) in the pki directory. The icinga2 job script will attempt to use client certificates once found in the pki/ directory instead of basic auth.

Dashing Configuration

Edit jobs/icinga2.erb and adjust the settings for the Icinga 2 API credentials.

Run

Linux

Install all required ruby gems into the system path.

bundle install --system

Now start dashing:

./restart-dashing

Additional options are available through ./restart-dashing -h.

Navigate to http://localhost:8005

Unix and OSX

On OSX El Capitan OpenSSL was deprecated, therefore you'll need to fix the eventmachine gem:

brew install openssl
bundle config build.eventmachine --with-cppflags=-I/usr/local/opt/openssl/include
bundle install --path binpaths

Note: Dashing is running as thin server which by default uses epoll from within the eventmachine library. This is not available on unix-based systems, you can safely ignore this warning:

warning: epoll is not supported on this platform

Now start dashing:

./restart-dashing

Additional options are available through ./restart-dashing -h.

Navigate to http://localhost:8005

Thanks

roidelapliue for the Icinga 1.x dashing script.

TODO

• Add ticket system demo (e.g. dev.icinga.org)
• Add Grafana dashboard
• Fix config.ru settings - #227
• Hints for Docker integration (docker-icinga2)

Developer Hints

Dashing Installation

sudo gem install dashing
sudo gem install bundler

dashing new icinga2
cd icinga2
bundle

dashing start

Widgets

dashing generate widget table
dashing generate widget showmon

Jobs

dashing generate job icinga2