plugin:rrdgraph
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
plugin:rrdgraph [2015-10-10 12:22] – 93.104.60.145 | plugin:rrdgraph [2021-01-23 14:24] – Flash-Systems | ||
---|---|---|---|
Line 5: | Line 5: | ||
author | author | ||
email : developer@flashsystems.de | email : developer@flashsystems.de | ||
- | type : syntax, action, admin, helper, render | + | type : syntax, action, helper, render |
- | lastupdate : 2015-10-10 | + | lastupdate : 2019-01-12 |
- | compatible : Ponder Stibbons, Hrun, Detritus+ | + | compatible : Detritus, Elenor Of Tsort, Frusterick Manners, Greebo+ |
screenshot_img : http:// | screenshot_img : http:// | ||
tags : rrd, rrdtool, images, graphs | tags : rrd, rrdtool, images, graphs | ||
- | downloadurl: | + | downloadurl: |
- | bugtracker : http:// | + | bugtracker : https:// |
- | sourcerepo : http:// | + | sourcerepo : https:// |
---- | ---- | ||
+ | |||
+ | |||
+ | :!: **This Plugin is no longer maintained. If you want to take over maintaining it go ahead and contact me. ** :!: | ||
===== Installation ===== | ===== Installation ===== | ||
:!: **Important Warning:** The RRDgraph plugin uses the cache to store the generated images and the recipes. Please make sure you have a [[https:// | :!: **Important Warning:** The RRDgraph plugin uses the cache to store the generated images and the recipes. Please make sure you have a [[https:// | ||
- | Install | + | Search and install |
+ | |||
+ | ==== Prerequisites ==== | ||
+ | To use this plugin your PHP installation must have been compiled with __GD support__ and the __rrd extension__ must be installed and activated. Regarding GD support also see [[tips: | ||
+ | |||
+ | If one of these prerequisites is not met the RRDgraph plugin will display an error message at the top of each wiki page. | ||
===== Introduction ===== | ===== Introduction ===== | ||
Line 74: | Line 82: | ||
OPT:h=100 | OPT:h=100 | ||
LINE: | LINE: | ||
- | </ttd> | + | </rrd> |
</ | </ | ||
Line 185: | Line 193: | ||
| '' | | '' | ||
| '' | | '' | ||
- | | '' | + | | '' |
| '' | | '' | ||
Line 200: | Line 208: | ||
OPT: | OPT: | ||
</ | </ | ||
+ | |||
+ | ==== SVG binding mode ==== | ||
+ | Sometimes you want a more prominent appearance of your RRD data than just lines on a graph. Maybe the current network utilization should be shown on a real network map or the current temperature outside the building should be displayed in big letters. This can be achieved via the SVG binding mode. It takes a SVG image from the media library and processes it to insert values from the RRD. | ||
+ | |||
+ | === Preparing the SVG file === | ||
+ | SVG files are XML documents. They contain XML tags specifying what the web-browser should draw on the screen. One tool to easily create SVG files is [[https:// | ||
+ | |||
+ | To allow SVG binding the XML syntax of an SVG file is extended with the non standard '' | ||
+ | |||
+ | < | ||
+ | <?xml version=" | ||
+ | <svg xmlns: | ||
+ | <g id=" | ||
+ | <circle r=" | ||
+ | | ||
+ | < | ||
+ | | ||
+ | < | ||
+ | | ||
+ | </g> | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | This SVG file shows the white Text '' | ||
+ | |||
+ | The '' | ||
+ | |||
+ | The next section shows how these variables are defined. | ||
+ | |||
+ | === Binding the data === | ||
+ | Recipes for binding RRD data look almost the same as normal recipes for RRD graphs. The SVG binding mode is enabled by specifying the '' | ||
+ | |||
+ | * They can only have __one__ range. This is the default range and it is used to select the data that should be processed. | ||
+ | * The created command line (see chapter OPT) is not passed to RRDgraph but to [[http:// | ||
+ | * There is the new '' | ||
+ | |||
+ | :!: **Important: | ||
+ | |||
+ | As the '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | < | ||
+ | <rrd bind=" | ||
+ | RANGE:1 Tag:now - 1day:now | ||
+ | DEF: | ||
+ | BDEF: | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | This example will read the last 24 hours of data for the RRA called '' | ||
+ | |||
+ | === Binding attributes === | ||
+ | Sometimes it's necessary to not just replace the bind tag with the formatted value but to set an attribute to a specific value based on the binding value. This can be achieved by using the '' | ||
+ | |||
+ | < | ||
+ | <bind var=" | ||
+ | <circle r=" | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | This example will set the '' | ||
==== Configuration options ==== | ==== Configuration options ==== | ||
Line 213: | Line 288: | ||
The graphs do ACL checking by themselves. If the user can not access the DokuWiki page the graph is on it will not display. | The graphs do ACL checking by themselves. If the user can not access the DokuWiki page the graph is on it will not display. | ||
+ | |||
+ | === Virtual namespace for RRD graphs === | ||
+ | This sets up the virtual namespace that is used for the generated graphs. This media namespace is not visible within the media manager. | ||
+ | |||
+ | :!: **Important Warning:** Please make sure this namespace does not collide with an already existing namespace within the media manager. If a collision occurs the existing namespace will be inaccessible until you change this setting. | ||
+ | |||
+ | The default setting is '' | ||
===== Change Log ===== | ===== Change Log ===== | ||
Line 220: | Line 302: | ||
* Better locking (readers-writer-lock) while updating the rrd images within the cache. This should prevent incomplete images on well frequented graphs. | * Better locking (readers-writer-lock) while updating the rrd images within the cache. This should prevent incomplete images on well frequented graphs. | ||
* **2015-10-10** Release 3 | * **2015-10-10** Release 3 | ||
- | * Minor update for compatibility DokuWiki release " | + | * Minor update for compatibility |
+ | * **2016-01-23** Release 4 | ||
+ | * Compatibility with PHP7 (thanks to splitbrain). | ||
+ | * Implemented RRD binding mode to create SVG files showing values from the RRD database. | ||
+ | * **2016-08-28** Release 5 | ||
+ | * Update for DokuWiki release " | ||
+ | * Using a configurable media namespace for image rendering. This solves problems with initializing DokuWiki from within graph.php on some installations. | ||
+ | * Show a nice error message if GD or rrdgraph are missing. | ||
+ | * **2017-06-21** Release 6 | ||
+ | * Litte bug-fix to make rrdgraph compatible with PHP 7 (again). | ||
+ | * **2017-06-21** Release 7 | ||
+ | * Minor bug-fix: If the drop down menu is used for range switching instead of the tabs (on small screens) this only works one time and then goes completely haywire. | ||
+ | * **2019-01-12** Release 8 | ||
+ | * Minor bug-fix: Missing quotes on string constant. | ||
+ | * Converted all line endings to LF. | ||
===== FAQ ===== | ===== FAQ ===== | ||
No FAQ yet. | No FAQ yet. |
plugin/rrdgraph.txt · Last modified: 2023-04-26 20:07 by Aleksandr