Skip to content

Latest commit

 

History

History
275 lines (229 loc) · 14.1 KB

README.md

File metadata and controls

275 lines (229 loc) · 14.1 KB
Raw

Grafana Plugin Flowcharting

Banner

Flowcharting is a plugin for grafana. It aims to display complexe diagram draws with draw.io like Visio. Few examples :

  • Technical architecture schema (Legacy, Cloud, Azure, AWS, GCP, Kubernetes, Terraform)
  • Diagrams (network, electric, flows ...)
  • Organic plans
  • Floorplans
  • UML plan
  • Workflows (Jenkins, Ansible Tower, OpenShift, ...)

Draw your artwork and monitor it.

Use case example

  • Technical schema example
    example 1

See more example at draw.io

Demo site

https://play.grafana.org/d/Unu5JcjWk/flowcharting-index?orgId=1

Getting started

https://algenty.github.io/flowcharting-repository/STARTED.html

Documentation

https://algenty.github.io/flowcharting-repository/

Project site

https://github.com/algenty/grafana-flowcharting

Sponsors and Funding

Since the version 0.7.0 and after one year of work, I activated the sponsor button.
Why ? Flowcharting stills free and open-source, but since the success of it,
I spent many personal times and money (computer, Azure account ...).
Also i donate money for project used by FlowCharting like chartist.
Then if you like Grafana-FlowCharting, you used it for your enterprise or other, you want to contribute,
click on Sponsor button or Financing the project with the link bellow.
https://paypal.me/grafanaflowcharting

Thanks a lot
Arnaud

Changelog

[0.8.1] - 2020-05-11

Added

Fixed

  • Fixed : Dashboard variables.
  • Optimize perf and size (7 Mo instead 15 Mo).

[0.8.0] - 2020-05-02

Added

  • Add Identification by Value/lable in field 'what' in rules (experimental)
  • Upgrade Draw.io libs (13.0.1)
  • Add option to disable regex/eval for more efficient.
  • Add 2 new color modes in Color mapping section :
    • "Label background"
    • "Label borber"
  • Add Execution times stats to optimize rules.
  • Foldable container without disable lock.
  • Add New custom variables for supported fields (Text Mapping 'with', Link Mapping 'Url' and Event Mapping 'Value'):
    • ${_value} : raw value
    • ${_formatted} : formatted value
    • ${_level} : current level
    • ${_rule} : name of current rule
  • Add New Feature : Events / Animations Mapping, according the level (See example)
    • Change shapes form
    • Change size, opacity, rotation, ...
    • Hide/Blink shapes
    • And more...

Fixed

  • Log scale, thanks Dennis (issue #68)
  • shape stills select when deleting map.
  • select list (typeahead) in fields 'whats' and map values for string type in rules
  • Level State with range or value mapping.
  • Lock always true in flowchart option (issue #138)
  • Fix Remove link
  • Fix range value Min and Max range when 'from' or 'to' is empty
  • Fix 'With' field in text mapping, empty after clone or save/reload

[0.7.0] - 2020-03-25

Added

  • new conditions and design in rule for each mapping instead one by rule (See example)
    • when : When condition applied
    • what : which shape
    • how : how to colorize shape
    • and more ...
  • Multi colors for thresholds with type number and string (See example)
  • Gradient color mode (See example)
  • Enable/disable animation like fade color for best performance or best render in 'Direct link rendered image'
  • Update libs :
    • draw.io : 12.8.6 (Kubernetes shapes and more)
    • mxgraph : 4.1.0

Fixed

[0.6.1] - 2020-01-15

Fixed

[0.6.0] - 2019-12-21

Added

  • Experimental implementation for table type data (Mysql, Postgres, Zabbix, Streaming, loki and other ...)
  • Some optimization on :
    • tooltips
    • States
  • Tooltip Graph :
  • Variables support in download input url (See example)
  • Add graduate effect when color changed (See example)
  • New rule design in editor (See example)
  • Typescript migration for best quality.
  • Build migration to grafana-toolkit (thanks Dominik and Ryan).
  • New engine graph for best compatibility with draw.io
  • Better Zoom for firefox and IE/edge.
  • Add controls on edit mode for XML and URL.
  • Regular expression for String type value implemented to define level state.

Fixed

  • Fix download url on first load.
  • Fix value null for string (issue #65)
  • Fix bug "subways" Editor (issue #73)
  • Fix date on 2 digit in tooltip (issue #77)
  • Fix minors bug.

[0.5.0] - 2019-10-17

Added

  • 2 new modes for "Update text value" (See example)
    • Append (Space) : Concat metrics with a space as a separator
    • Append (New line) : Concat metrics with a line break
  • Variabilization in "Url" for link mapping (See example)
  • New check box to allow download images from draw.io (See example)
  • New editor option :
    • Choose other editor draw.io like internal website
    • Choose the theme of editor
  • New identification mode for shapes when mouse cursor is over the rules or the mapping (See example)
  • Support Dynamic shapes like Floorplan, isometric plans and more (See example)
  • New color mode for no SVG object like pictures/cliparts/images (See example)
  • Graphs in tooltip (See example)
    • Color graph with defined colors in threshold
    • Size of graph (See example)
  • Define the orientation in tooltip for each metrics/graph in tooltips : horizontal or vertical (See example)
  • Some optimizations, Display is twice as fast on load.

Fixed

  • Fix color to reset when "Color on" is "Always/Critical" and metric is OK
  • Fix border to empty instead black when "color mode" is "Fill" (issue #24)
  • Fix error when "Value On" is not "When metric displayed"
  • Fix Link (issue #37)
  • Fix hyperlink text appears in white over flowchart (issue #45)
  • Fix "Multiple FlowCharts On a Dashboard", when edit, both are the same draw (issue #48)
  • Fix options after reload or variable changed (issue #44)
  • Fix auto reset zoom/unzoom when data refreshed, only ESC or change options on flowchart reset zoom now (issue #38)
  • Fix error for BPNM shapes (Issue #51)
  • Fix display when center and scale are checked on flowchart options.
  • Fix Zoom with mouse wheel for firefox and Edge.

Annex

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Cooming soon/Roadmap

1.0 Next/Requested enhancements

  • Custom libs.
  • Internat draw.io website (issue #43)
  • Display tooltip (0.4.0)
  • Export SVG, png, options
  • Add data in tooltip (0.4.0)
  • Use variables/templates in graph (0.4.0)
  • Add custom stencils/libs from draw.io (0.4.0)
  • Progressive change color like gauge
  • Support light theme
  • Annotation
  • Tooltips on text and arrow/line
  • Url source download (0.4.0)
  • Special rule according level (hide, show, change form, move, infront, in back, attributes, ...)
  • Custom variables like ${_label},${_value}, ${_alias}, ${_rule}, ${_level} ... (0.8.0)
  • Variable support in link (0.5.0)
  • Zoom/Unzoom (0.4.0)
  • Shared graph crosshair
  • CSV source
  • Map/search shape by value
  • Variables support for downloaded source and compressed source
  • Multi graph with auto link when errors
  • Gradien Mode for color (0.7.0)
  • More than 3 colors (0.7.0)
  • Graph in tooltip (0.6.0)
  • Histogram
  • Merge Graphs
  • carriage return after new rule in tooltips option
  • Filter for null values in graph
  • New style for image : imageBackground, imageBorder
  • Support cloud images from draw.io
  • Support images from draw.io (0.5.0)
  • Add append mode on text with CR or space (0.5.0)

Support or Contact

Dependencies

Grafane flowcharting plugin dependencies

  • [AngularJS] - HTML enhanced for web apps!
  • [lodash] - awesome web-based text editor
  • [jquery] - Markdown parser done right. Fast and easy to extend.
  • [mxGraph] - great UI boilerplate for modern web apps
  • [pako] - Zlib port to javascript
  • [vkbeautify] - Pretty prints and minifies XML/JSON/SQL/CSV
  • [sanitizer] - Caja's HTML Sanitizer
  • [chartist] - Graph for tooltip

Build dependencies

  • [jest] - Delightful JavaScript Testing
  • [express] - Fast, unopinionated, minimalist web framework
  • [babel] - Soft cushion between you all the cool new file formats being developed for node.js such as CoffeeScript, SASS, and Jade.
  • [grunt] - The JavaScript Task Runner
  • [webpack] - Packs CommonJs/AMD modules for the browser. Allows to split your codebase into multiple bundles, which can be loaded on demand. Support loaders to preprocess files, i.e. json, jsx, es7, css, less, ... and your custom stuff.

Installation

Flowcharting requires Grafana v5+ to run (not tested lower version) Download and install it

Manualy

$ cd $grafana_home/data/plugin
$ wget --no-check-certificate https://github.com/algenty/grafana-flowcharting/archive/master.zip
$ unzip master.zip

grafana-cli

grafana-cli plugins install agenty-flowcharting-panel

Build

$ git clone https://github.com/algenty/grafana-flowcharting
$ yarn build
$ # Make zip file plugin in archives dir
$ yarn build archive
$ # for dev watching
$ yarn dev

Class diagram

https://www.draw.io/?chrome=0&lightbox=1&url=https%3A%2F%2Fraw.githubusercontent.com%2Falgenty%2Fflowcharting-repository%2Fmaster%2Fgraphs%2FFlowcharting_carto.drawio

Event diagram (In progress)

https://www.draw.io/?chrome=0&lightbox=1&url=https%3A%2F%2Fraw.githubusercontent.com%2Falgenty%2Fflowcharting-repository%2Fmaster%2Fgraphs%2FFlowcharting_Events.drawio