Downtime Sunburst Chart

Libre Panel for Sunburst Chart Downtime Analysis

This chart visualizes the part-to-whole of downtime categories and reasons frequency. Mouseover gives users additional information as to the downtime duration. This panel plugin is part of Libre.

Installation

The easiest way to get started with this plugin is to download the latest release, unzip into grafana plugin directory and restart grafana.

Download the latest release

$ wget https://github.com/Spruik/Libre-Downtime-Sunburst-Chart-Panel/releases/latest/download/Libre-Downtime-Sunburst-Chart-Panel.zip
Resolving github.com (github.com)... 140.82.114.4
...
2020-06-24 20:47:59 (1.08 MB/s) - 'Libre-Downtime-Sunburst-Chart-Panel.zip' saved [90150]

Unzip into your Grafana plugin directory

$ unzip Libre-Downtime-Sunburst-Chart-Panel.zip -d /var/lib/grafana/plugins
Archive: Libre-Downtime-Sunburst-Chart-Panel.zip
...
inflating: /var/lib/grafana/Libre-Downtime-Sunburst-Chart-Panel/utils.js.map

Restart Grafana

$ service grafana-server restart
 * Stopping Grafana Server
 * Starting Grafana Server

Usage

In order to get the most out of this panel:

1. Add a Table metric to query Availability. For example SELECT time, category, reason, parentReason FROM "Availability". This panel expects an ordered timeseries of time, category, reason, parentReason. Empty category/reasons are not included.

Developing

Getting Started

A docker-compose and grunt script is provided in order to quickly evaluate source code changes. This requires

Prerequisites

• docker (>= 18 required)
• docker-compose (>= 1.25 required)
• node (>= 12 required)
• npm (>= 6 required)

Start by cloning this repository

~/
$ git clone https://github.com/Spruik/Libre-Downtime-Sunburst-Chart-Panel
Cloning into 'libre-downtime-sunburst-chart-panel'...
remote: Enumerating objects: 46, done.
remote: Counting objects: 100% (46/46), done.
remote: Compressing objects: 100% (31/31), done.
remote: Total 46 (delta 13), reused 46 (delta 13), pack-reused 0
Unpacking objects: 100% (46/46), done.

Enter project and install dependencies

$ cd ./libre-downtime-sunburst-chart-panel
~/libre-downtime-sunburst-chart-panel
$ npm install
...
added 624 packages in 12.766s

Install Grunt globally

$ npm install grunt -g
C:\Users\user\AppData\Roaming\npm\grunt -> C:\Users\user\AppData\Roaming\npm\node_modules\grunt\bin\grunt
+ grunt@1.1.0
updated 1 package in 1.364s

Run grunt to build the panel

$ grunt
Running "copy:src_to_dist" (copy) task
Created 2 directories, copied 2 files

Running "copy:echarts_libs" (copy) task
Copied 1 file

Running "copy:pluginDef" (copy) task
Copied 1 file

Running "copy:readme" (copy) task
Created 1 directory, copied 7 files

Running "string-replace:dist" (string-replace) task

1 files created

Running "babel:dist" (babel) task

Done.

Start docker-compose.dev.yml detached

~/libre-downtime-sunburst-chart-panel
$ docker-compose -f docker-compose.dev.yml up -d
Creating network "libre-downtime-sunburst-chart-panel_default" with the default driver
Creating libre-downtime-sunburst-chart-panel_influx_1 ... done
Creating libre-downtime-sunburst-chart-panel_grafana_1  ... done
Creating libre-downtime-sunburst-chart-panel_telegraf_1 ... done

Run grunt watch to recompile on change

~/libre-downtime-sunburst-chart-panel
$ grunt watch
Running "watch" task
Waiting...

Open your favourite editor and start editing ./src files. The grunt watch task will detect this and recompile the panel. Use your favourite web browser and point to http://localhost:3000 login a dashboard with data should already be available. Your browser will need to be refreshed to reflect your changes to this panel. Ensure your browser isn't caching files whilst developing.

Building

Prerequisites

• node (>= 12 required)
• npm (>= 6 required)

Build panel and zip into archive

~/libre-downtime-sunburst-chart-panel
$ grunt build
Running "clean:0" (clean) task
>> 1 path cleaned.

Running "clean:1" (clean) task
>> 1 path cleaned.

Running "copy:src_to_dist" (copy) task
Created 2 directories, copied 2 files

Running "copy:echarts_libs" (copy) task
Copied 1 file

Running "copy:pluginDef" (copy) task
Copied 1 file

Running "copy:readme" (copy) task
Created 1 directory, copied 7 files

Running "string-replace:dist" (string-replace) task

1 files created

Running "babel:dist" (babel) task

Running "compress:main" (compress) task
>> Compressed 25 files.

Running "compress:tar" (compress) task
>> Compressed 25 files.

Done.

Find a completed build of this panel in the root directory named libre-downtime-sunburst-chart-panel.zip.

Contributing

For any issue, there are fundamentally three ways an individual can contribute:

• By opening the issue for discussion: For instance, if you believe that you have uncovered a bug in, creating a new issue in the GitHub issue tracker is the way to report it.
• By helping to triage the issue: This can be done either by providing supporting details (a test case that demonstrates a bug), or providing suggestions on how to address the issue.
• By helping to resolve the issue: Typically, this is done either in the form of demonstrating that the issue reported is not a problem after all, or more often, by opening a Pull Request that changes some bit of something in the panel in a concrete and reviewable manner.

Change log

• 1.0.3 Security Update

  • Upgrade bl 1.2.2 to 1.2.3
  • Upgrade ini 1.3.5 to 1.3.8
  • Bump Revision

• 1.0.2 Rename sunburt to sunburst

  • Rename sunburt to sunburst
  • Bump Revision

• 1.0.1 Add tar build output

  • Remove unused libraries and npm audit check
  • Add grunt compress tar
  • Update README shell outputs
  • Bump Revision
  • Rename sunburt to sunburst

• 1.0.0 Initial Public Release