Skip to content

Commit

Permalink
Feature/initial public release (#2)
Browse files Browse the repository at this point in the history
* Remove dist from repository

* Fix panel icon

* Merge img and image folders

* Rename repository

* Remove unused library pg

* Change lint to use standard

* Remove unused code

* Add LICENSE

* Add MAINTAINERS

* Add grunt build

* Update project decription

* Add screenshots

* Add developement and test resources

* Fix panel link

* Fix subtitle markdown

* Change download filename to lowercase

* Add metrics png to README
  • Loading branch information
tomhollingworth authored Jul 7, 2020
1 parent ca94fb2 commit 530f69f
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
# Downtime Pie Chart Panel

| Libre Panel for Pie Chart Downtime Analysis
> Libre Panel for Pie Chart Downtime Analysis
This chart visualizes the part-to-whole of downtime categories and reasons. The outer donut is the part-to-whole of the selected inner category. Users can select an inner category to change the outer donut display. Users can toggle between downtime category/reason duration sum and frequency of occurances. A download button enables saving the graph as an image. Mouseover gives users additional information as to the downtime duration. This panel plugin is part of [Libre](https://github.com/Spruik/Libre).

![Panel](docs/libre-downtime-pie-chart-panel)
![Panel](docs/libre-downtime-pie-chart-panel.gif)

## Installation

The easiest way to get started with this plugin is to [download the latest release](https://github.com/Spruik/Libre-Downtime-Pie-Chart-Panel/releases/latest/download/Libre-Downtime-Pie-Chart-Panel.zip), unzip into grafana plugin directory and restart grafana.
The easiest way to get started with this plugin is to [download the latest release](https://github.com/Spruik/Libre-Downtime-Pie-Chart-Panel/releases/latest/download/libre-downtime-pie-chart-panel.zip), unzip into grafana plugin directory and restart grafana.

Download the latest release

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

Unzip into your Grafana plugin directory

```shell
$ unzip Libre-Downtime-Pie-Chart-Panel.zip -d /var/lib/grafana/plugins
Archive: Libre-Downtime-Pie-Chart-Panel.zip
$ unzip libre-downtime-pie-chart-panel.zip -d /var/lib/grafana/plugins
Archive: libre-downtime-pie-chart-panel.zip
...
inflating: /var/lib/grafana/Libre-Downtime-Pie-Chart-Panel/utils.js.map
inflating: /var/lib/grafana/libre-downtime-pie-chart-panel/utils.js.map
```

Restart Grafana
Expand All @@ -42,6 +42,8 @@ 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.

![Metric](docs/libre-downtime-pie-chart-panel-metrics.png)

## Developing

### Getting Started
Expand Down

0 comments on commit 530f69f

Please sign in to comment.