chartwerk
/
grafana-chartwerk-panel
4
0
Fork 0
Code Issues 2 Pull Requests Projects Releases 1 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
86 Commits
1 Branch
1 Tag
2.5 MiB
 
 
 
 
Tree: cb9fb97360
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'cb9fb97360'
${ noResults }
rozetko cb9fb97360
Merge branch 'docs-update' into 'main' 		2 years ago
src fix 2 years ago
.gitignore init grafana panel 3 years ago
.gitlab-ci.yml ci 3 years ago
.prettierrc.js enable options catagories && add prettierr dep 3 years ago
CHANGELOG.md init grafana panel 3 years ago
LICENSE license 3 years ago
README.md fix 2 years ago
jest.config.js try build 3 years ago
package.json update version 0.4.1 -> 0.5.0 3 years ago
tsconfig.json init grafana panel 3 years ago
yarn.lock ux improve: the first metric is selected by default 3 years ago

README.md

Grafana Chartwerk Panel (beta)

image

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

image

Features

  • 3 types of visualizations:
    • Gauge
    • Line Chart (coming soon)
    • Bar Chart (coming soon)
  • Gauge: dynamic thresholds and min / max
  • Gauge: conditional icons displaying
  • Gauge: reversed direction

How to use

  1. Create a new panel and select Chartwerk as the visualization
  2. Add queries with unique aliases
  3. Go to the Options Tab and setup panel:
  • Choose visualization type
  • Select metric in the Value -> Metric dropdown (by default, the first metric is used)

Demo

see demo

Options [Gauge]

  • Visualization:
    • Pod: option to select chart type
  • Value:
    • Metric: select metric query from dropdown
  • Extemum:
    • Min:
      • type number for static minimum value OR
      • enable "Use metric" toggle switch to select metric as minimun
      • default value: 0
    • Max:
      • type number for static maximum OR
      • enable "Use metric" toggle switch to select metric as maximum
      • default value: maximum of metric query

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://gitlab.com/chartwerk/grafana-chartwerk-panel/uploads/e8782155489bec4c216048e4d4e1f618/corpglory-chartwerk-panel-0.4.1.zip
  • Unpack downloaded files
unzip -u corpglory-chartwerk-panel-0.4.1.zip -d corpglory-chartwerk-panel
  • 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)

docker run \
  -p 3000:3000 \
  -e "GF_INSTALL_PLUGINS=https://gitlab.com/chartwerk/grafana-chartwerk-panel/uploads/e8782155489bec4c216048e4d4e1f618/corpglory-chartwerk-panel-0.4.1.zip;corpglory-chartwerk-panel" \
  grafana/grafana