grafana-chartwerk-panel/README.md

# Grafana Chartwerk Panel (beta)

![image](https://gitlab.com/chartwerk/grafana-chartwerk-panel/uploads/7a9a1150832c0d9184cbe44c8a70ce40/logo.png)

[![Build Status](https://travis-ci.org/chartwerk/grafana-chartwerk-app.svg?branch=master)](https://travis-ci.org/chartwerk/grafana-chartwerk-app)

**Grafana Chartwerk Panel** renders metrics using Chartwerk libraries. For now, it can render as Gauge. We are working on adding new visualizations.

![image](https://gitlab.com/chartwerk/grafana-chartwerk-panel/uploads/357c076a8f5d9e3a9d218e589d5b1b27/gauge.png)

## Features

- 3 types of visualizations:
  - gauge
  - line-chart (coming soon)
  - bar-chart (coming soon)
- Gauge: dynamic thresholds and min/max
- Gauge: display icons on conditions
- Gauge: ability to reverse direction 

## Installation

### Linux / Mac OS X

- Navigate to either:

  - `<GRAFANA_PATH>/data/plugins` (when installed from tarball or source)
  - or `/var/lib/grafana/plugins` (when installed from `.deb`/`.rpm` package)

- Download Chartwerk panel

```
wget https://github.com/chartwerk/grafana-chartwerk-app/archive/0.3.3.zip
```

- Unpack downloaded files

```
unzip 0.3.3.zip
```

- Restart grafana-server
  - For grafana installed via Standalone Linux Binaries:
    - Stop any running instances of grafana-server
    - Start grafana-server by:
      `$GRAFANA_PATH/bin/grafana-server`
  - For grafana installed via Package Manager:
    - type in `systemctl restart grafana-server`

### Grafana in Docker

You can install Chartwerk panel to Grafana in Docker passing it as environment variable (as described in [Grafana docs](http://docs.grafana.org/installation/docker/#installing-plugins-from-other-sources))

```bash
docker run \
  -p 3000:3000 \
  -e "GF_INSTALL_PLUGINS=https://github.com/chartwerk/grafana-chartwerk-app/archive/0.3.3.zip;corpglory-chartwerk-panel" \
  grafana/grafana
```