contrib/php-collection/functions.php

   1 <?php // vim:fenc=utf-8:filetype=php:ts=4
   2 /*
   3  * Copyright (C) 2009  Bruno Prémont <bonbons AT linux-vserver.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under
   6  * the terms of the GNU General Public License as published by the Free Software
   7  * Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  11  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  12  * details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17  */
  18
  19 define('REGEXP_HOST', '/^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/');
  20 define('REGEXP_PLUGIN', '/^[a-zA-Z0-9_.-]+$/');
  21
  22 /**
  23  * Read input variable from GET, POST or COOKIE taking
  24  * care of magic quotes
  25  * @name Name of value to return
  26  * @array User-input array ($_GET, $_POST or $_COOKIE)
  27  * @default Default value
  28  * @return $default if name in unknown in $array, otherwise
  29  *         input value with magic quotes stripped off
  30  */
  31 function read_var($name, &$array, $default = null) {
  32         if (isset($array[$name])) {
  33                 if (is_array($array[$name])) {
  34                         if (get_magic_quotes_gpc()) {
  35                                 $ret = array();
  36                                 while (list($k, $v) = each($array[$name]))
  37                                         $ret[stripslashes($k)] = stripslashes($v);
  38                                 return $ret;
  39                         } else
  40                                 return $array[$name];
  41                 } else if (is_string($array[$name]) && get_magic_quotes_gpc()) {
  42                         return stripslashes($array[$name]);
  43                 } else
  44                         return $array[$name];
  45         } else
  46                 return $default;
  47 }
  48
  49 /**
  50  * Alphabetically compare host names, comparing label
  51  * from tld to node name
  52  */
  53 function collectd_compare_host($a, $b) {
  54         $ea = explode('.', $a);
  55         $eb = explode('.', $b);
  56         $i = count($ea) - 1;
  57         $j = count($eb) - 1;
  58         while ($i >= 0 && $j >= 0)
  59                 if (($r = strcmp($ea[$i--], $eb[$j--])) != 0)
  60                         return $r;
  61         return 0;
  62 }
  63
  64 /**
  65  * Fetch list of hosts found in collectd's datadirs.
  66  * @return Sorted list of hosts (sorted by label from rigth to left)
  67  */
  68 function collectd_list_hosts() {
  69         global $config;
  70
  71         $hosts = array();
  72         foreach($config['datadirs'] as $datadir)
  73                 if ($d = @opendir($datadir)) {
  74                         while (($dent = readdir($d)) !== false)
  75                                 if ($dent != '.' && $dent != '..' && is_dir($datadir.'/'.$dent) && preg_match(REGEXP_HOST, $dent))
  76                                         $hosts[] = $dent;
  77                         closedir($d);
  78                 } else
  79                         error_log('Failed to open datadir: '.$datadir);
  80         $hosts = array_unique($hosts);
  81         usort($hosts, 'collectd_compare_host');
  82         return $hosts;
  83 }
  84
  85 /**
  86  * Fetch list of plugins found in collectd's datadirs for given host.
  87  * @arg_host Name of host for which to return plugins
  88  * @return Sorted list of plugins (sorted alphabetically)
  89  */
  90 function collectd_list_plugins($arg_host) {
  91         global $config;
  92
  93         $plugins = array();
  94         foreach ($config['datadirs'] as $datadir)
  95                 if (preg_match(REGEXP_HOST, $arg_host) && ($d = @opendir($datadir.'/'.$arg_host))) {
  96                         while (($dent = readdir($d)) !== false)
  97                                 if ($dent != '.' && $dent != '..' && is_dir($datadir.'/'.$arg_host.'/'.$dent)) {
  98                                         if ($i = strpos($dent, '-'))
  99                                                 $plugins[] = substr($dent, 0, $i);
 100                                         else
 101                                                 $plugins[] = $dent;
 102                                 }
 103                         closedir($d);
 104                 }
 105         $plugins = array_unique($plugins);
 106         sort($plugins);
 107         return $plugins;
 108 }
 109
 110 /**
 111  * Fetch list of plugin instances found in collectd's datadirs for given host+plugin
 112  * @arg_host Name of host
 113  * @arg_plugin Name of plugin
 114  * @return Sorted list of plugin instances (sorted alphabetically)
 115  */
 116 function collectd_list_pinsts($arg_host, $arg_plugin) {
 117         global $config;
 118
 119         $pinsts = array();
 120         foreach ($config['datadirs'] as $datadir)
 121                 if (preg_match(REGEXP_HOST, $arg_host) && ($d = opendir($datadir.'/'.$arg_host))) {
 122                         while (($dent = readdir($d)) !== false)
 123                                 if ($dent != '.' && $dent != '..' && is_dir($datadir.'/'.$arg_host.'/'.$dent)) {
 124                                         if ($i = strpos($dent, '-')) {
 125                                                 $plugin = substr($dent, 0, $i);
 126                                                 $pinst  = substr($dent, $i+1);
 127                                         } else {
 128                                                 $plugin = $dent;
 129                                                 $pinst  = '';
 130                                         }
 131                                         if ($plugin == $arg_plugin)
 132                                                 $pinsts[] = $pinst;
 133                                 }
 134                         closedir($d);
 135                 }
 136         $pinsts = array_unique($pinsts);
 137         sort($pinsts);
 138         return $pinsts;
 139 }
 140
 141 /**
 142  * Fetch list of types found in collectd's datadirs for given host+plugin+instance
 143  * @arg_host Name of host
 144  * @arg_plugin Name of plugin
 145  * @arg_pinst Plugin instance
 146  * @return Sorted list of types (sorted alphabetically)
 147  */
 148 function collectd_list_types($arg_host, $arg_plugin, $arg_pinst) {
 149         global $config;
 150
 151         $types = array();
 152         $my_plugin = $arg_plugin . (strlen($arg_pinst) ? '-'.$arg_pinst : '');
 153         if (!preg_match(REGEXP_PLUGIN, $my_plugin))
 154                 return $types;
 155         foreach ($config['datadirs'] as $datadir)
 156                 if (preg_match(REGEXP_HOST, $arg_host) && ($d = @opendir($datadir.'/'.$arg_host.'/'.$my_plugin))) {
 157                         while (($dent = readdir($d)) !== false)
 158                                 if ($dent != '.' && $dent != '..' && is_file($datadir.'/'.$arg_host.'/'.$my_plugin.'/'.$dent) && substr($dent, strlen($dent)-4) == '.rrd') {
 159                                         $dent = substr($dent, 0, strlen($dent)-4);
 160                                         if ($i = strpos($dent, '-'))
 161                                                 $types[] = substr($dent, 0, $i);
 162                                         else
 163                                                 $types[] = $dent;
 164                                 }
 165                         closedir($d);
 166                 }
 167         $types = array_unique($types);
 168         sort($types);
 169         return $types;
 170 }
 171
 172 /**
 173  * Fetch list of type instances found in collectd's datadirs for given host+plugin+instance+type
 174  * @arg_host Name of host
 175  * @arg_plugin Name of plugin
 176  * @arg_pinst Plugin instance
 177  * @arg_type Type
 178  * @return Sorted list of type instances (sorted alphabetically)
 179  */
 180 function collectd_list_tinsts($arg_host, $arg_plugin, $arg_pinst, $arg_type) {
 181         global $config;
 182
 183         $tinsts = array();
 184         $my_plugin = $arg_plugin . (strlen($arg_pinst) ? '-'.$arg_pinst : '');
 185         if (!preg_match(REGEXP_PLUGIN, $my_plugin))
 186                 return $types;
 187         foreach ($config['datadirs'] as $datadir)
 188                 if (preg_match(REGEXP_HOST, $arg_host) && ($d = @opendir($datadir.'/'.$arg_host.'/'.$my_plugin))) {
 189                         while (($dent = readdir($d)) !== false)
 190                                 if ($dent != '.' && $dent != '..' && is_file($datadir.'/'.$arg_host.'/'.$my_plugin.'/'.$dent) && substr($dent, strlen($dent)-4) == '.rrd') {
 191                                         $dent = substr($dent, 0, strlen($dent)-4);
 192                                         if ($i = strpos($dent, '-')) {
 193                                                 $type  = substr($dent, 0, $i);
 194                                                 $tinst = substr($dent, $i+1);
 195                                         } else {
 196                                                 $type  = $dent;
 197                                                 $tinst = '';
 198                                         }
 199                                         if ($type == $arg_type)
 200                                                 $tinsts[] = $tinst;
 201                                 }
 202                         closedir($d);
 203                 }
 204         $tinsts = array_unique($tinsts);
 205         sort($tinsts);
 206         return $tinsts;
 207 }
 208
 209 /**
 210  * Parse symlinks in order to get an identifier that collectd understands
 211  * (e.g. virtualisation is collected on host for individual VMs and can be
 212  *  symlinked to the VM's hostname, support FLUSH for these by flushing
 213  *  on the host-identifier instead of VM-identifier)
 214  * @host Host name
 215  * @plugin Plugin name
 216  * @pinst Plugin instance
 217  * @type Type name
 218  * @tinst Type instance
 219  * @return Identifier that collectd's FLUSH command understands
 220  */
 221 function collectd_identifier($host, $plugin, $pinst, $type, $tinst) {
 222         global $config;
 223         $rrd_realpath    = null;
 224         $orig_identifier = sprintf('%s/%s%s%s/%s%s%s', $host, $plugin, strlen($pinst) ? '-' : '', $pinst, $type, strlen($tinst) ? '-' : '', $tinst);
 225         $identifier      = null;
 226         foreach ($config['datadirs'] as $datadir)
 227                 if (is_file($datadir.'/'.$orig_identifier.'.rrd')) {
 228                         $rrd_realpath = realpath($datadir.'/'.$orig_identifier.'.rrd');
 229                         break;
 230                 }
 231         if ($rrd_realpath) {
 232                 $identifier   = basename($rrd_realpath);
 233                 $identifier   = substr($identifier, 0, strlen($identifier)-4);
 234                 $rrd_realpath = dirname($rrd_realpath);
 235                 $identifier   = basename($rrd_realpath).'/'.$identifier;
 236                 $rrd_realpath = dirname($rrd_realpath);
 237                 $identifier   = basename($rrd_realpath).'/'.$identifier;
 238         }
 239
 240         if (is_null($identifier))
 241                 return $orig_identifier;
 242         else
 243                 return $identifier;
 244 }
 245
 246 /**
 247  * Tell collectd that it should FLUSH all data it has regarding the
 248  * graph we are about to generate.
 249  * @host Host name
 250  * @plugin Plugin name
 251  * @pinst Plugin instance
 252  * @type Type name
 253  * @tinst Type instance
 254  */
 255 function collectd_flush($identifier) {
 256         global $config;
 257
 258         if (!$config['collectd_sock'])
 259                 return false;
 260         if (is_null($identifier) || (is_array($identifier) && count($identifier) == 0) || !(is_string($identifier) || is_array($identifier)))
 261                 return false;
 262
 263         $u_errno  = 0;
 264         $u_errmsg = '';
 265         if ($socket = @fsockopen($config['collectd_sock'], 0, $u_errno, $u_errmsg)) {
 266                 $cmd = 'FLUSH plugin=rrdtool';
 267                 if (is_array($identifier)) {
 268                         foreach ($identifier as $val)
 269                                 $cmd .= sprintf(' identifier="%s"', $val);
 270                 } else
 271                         $cmd .= sprintf(' identifier="%s"', $identifier);
 272                 $cmd .= "\n";
 273
 274                 $r = fwrite($socket, $cmd, strlen($cmd));
 275                 if ($r === false || $r != strlen($cmd))
 276                         error_log(sprintf("graph.php: Failed to write whole command to unix-socket: %d out of %d written", $r === false ? -1 : $r, strlen($cmd)));
 277
 278                 $resp = fgets($socket);
 279                 if ($resp === false)
 280                         error_log(sprintf("graph.php: Failed to read response from collectd for command: %s", trim($cmd)));
 281
 282                 $n = (int)$resp;
 283                 while ($n-- > 0)
 284                         fgets($socket);
 285
 286                 fclose($socket);
 287         } else
 288                 error_log(sprintf("graph.php: Failed to open unix-socket to collectd: %d: %s", $u_errno, $u_errmsg));
 289 }
 290
 291 class CollectdColor {
 292         private $r = 0;
 293         private $g = 0;
 294         private $b = 0;
 295
 296         function __construct($value = null) {
 297                 if (is_null($value)) {
 298                 } else if (is_array($value)) {
 299                         if (isset($value['r']))
 300                                 $this->r = $value['r'] > 0 ? ($value['r'] > 1 ? 1 : $value['r']) : 0;
 301                         if (isset($value['g']))
 302                                 $this->g = $value['g'] > 0 ? ($value['g'] > 1 ? 1 : $value['g']) : 0;
 303                         if (isset($value['b']))
 304                                 $this->b = $value['b'] > 0 ? ($value['b'] > 1 ? 1 : $value['b']) : 0;
 305                 } else if (is_string($value)) {
 306                         $matches = array();
 307                         if ($value == 'random') {
 308                                 $this->randomize();
 309                         } else if (preg_match('/([0-9A-Fa-f][0-9A-Fa-f])([0-9A-Fa-f][0-9A-Fa-f])([0-9A-Fa-f][0-9A-Fa-f])/', $value, $matches)) {
 310                                 $this->r = ('0x'.$matches[1]) / 255.0;
 311                                 $this->g = ('0x'.$matches[2]) / 255.0;
 312                                 $this->b = ('0x'.$matches[3]) / 255.0;
 313                         }
 314                 } else if (is_a($value, 'CollectdColor')) {
 315                         $this->r = $value->r;
 316                         $this->g = $value->g;
 317                         $this->b = $value->b;
 318                 }
 319         }
 320
 321         function randomize() {
 322                 $this->r = rand(0, 255) / 255.0;
 323                 $this->g = rand(0, 255) / 255.0;
 324                 $this->b = 0.0;
 325                 $min = 0.0;
 326                 $max = 1.0;
 327
 328                 if (($this->r + $this->g) < 1.0) {
 329                         $min = 1.0 - ($this->r + $this->g);
 330                 } else {
 331                         $max = 2.0 - ($this->r + $this->g);
 332                 }
 333                 $this->b = $min + ((rand(0, 255)/255.0) * ($max - $min));
 334         }
 335
 336         function fade($bkgnd = null, $alpha = 0.25) {
 337                 if (is_null($bkgnd) || !is_a($bkgnd, 'CollectdColor')) {
 338                         $bg_r = 1.0;
 339                         $bg_g = 1.0;
 340                         $bg_b = 1.0;
 341                 } else {
 342                         $bg_r = $bkgnd->r;
 343                         $bg_g = $bkgnd->g;
 344                         $bg_b = $bkgnd->b;
 345                 }
 346
 347                 $this->r = $alpha * $this->r + ((1.0 - $alpha) * $bg_r);
 348                 $this->g = $alpha * $this->g + ((1.0 - $alpha) * $bg_g);
 349                 $this->b = $alpha * $this->b + ((1.0 - $alpha) * $bg_b);
 350         }
 351
 352         function as_array() {
 353                 return array('r'=>$this->r, 'g'=>$this->g, 'b'=>$this->b);
 354         }
 355
 356         function as_string() {
 357                 $r = (int)($this->r*255);
 358                 $g = (int)($this->g*255);
 359                 $b = (int)($this->b*255);
 360                 return sprintf('%02x%02x%02x', $r > 255 ? 255 : $r, $g > 255 ? 255 : $g, $b > 255 ? 255 : $b);
 361         }
 362 }
 363
 364
 365 /**
 366  * Helper function to strip quotes from RRD output
 367  * @str RRD-Info generated string
 368  * @return String with one surrounding pair of quotes stripped
 369  */
 370 function rrd_strip_quotes($str) {
 371         if ($str[0] == '"' && $str[strlen($str)-1] == '"')
 372                 return substr($str, 1, strlen($str)-2);
 373         else
 374                 return $str;
 375 }
 376
 377 /**
 378  * Determine useful information about RRD file
 379  * @file Name of RRD file to analyse
 380  * @return Array describing the RRD file
 381  */
 382 function rrd_info($file) {
 383         $info = array('filename'=>$file);
 384
 385         $rrd = popen(RRDTOOL.' info '.escapeshellarg($file), 'r');
 386         if ($rrd) {
 387                 while (($s = fgets($rrd)) !== false) {
 388                         $p = strpos($s, '=');
 389                         if ($p === false)
 390                                 continue;
 391                         $key = trim(substr($s, 0, $p));
 392                         $value = trim(substr($s, $p+1));
 393                         if (strncmp($key,'ds[', 3) == 0) {
 394                                 /* DS definition */
 395                                 $p = strpos($key, ']');
 396                                 $ds = substr($key, 3, $p-3);
 397                                 if (!isset($info['DS']))
 398                                         $info['DS'] = array();
 399                                 $ds_key = substr($key, $p+2);
 400
 401                                 if (strpos($ds_key, '[') === false) {
 402                                         if (!isset($info['DS']["$ds"]))
 403                                                 $info['DS']["$ds"] = array();
 404                                         $info['DS']["$ds"]["$ds_key"] = rrd_strip_quotes($value);
 405                                 }
 406                         } else if (strncmp($key, 'rra[', 4) == 0) {
 407                                 /* RRD definition */
 408                                 $p = strpos($key, ']');
 409                                 $rra = substr($key, 4, $p-4);
 410                                 if (!isset($info['RRA']))
 411                                         $info['RRA'] = array();
 412                                 $rra_key = substr($key, $p+2);
 413
 414                                 if (strpos($rra_key, '[') === false) {
 415                                         if (!isset($info['RRA']["$rra"]))
 416                                                 $info['RRA']["$rra"] = array();
 417                                         $info['RRA']["$rra"]["$rra_key"] = rrd_strip_quotes($value);
 418                                 }
 419                         } else if (strpos($key, '[') === false) {
 420                                 $info[$key] = rrd_strip_quotes($value);
 421                         }
 422                 }
 423                 pclose($rrd);
 424         }
 425         return $info;
 426 }
 427
 428 function rrd_get_color($code, $line = true) {
 429         global $config;
 430         $name = ($line ? 'f_' : 'h_').$code;
 431         if (!isset($config['rrd_colors'][$name])) {
 432                 $c_f = new CollectdColor('random');
 433                 $c_h = new CollectdColor($c_f);
 434                 $c_h->fade();
 435                 $config['rrd_colors']['f_'.$code] = $c_f->as_string();
 436                 $config['rrd_colors']['h_'.$code] = $c_h->as_string();
 437         }
 438         return $config['rrd_colors'][$name];
 439 }
 440
 441 /**
 442  * Draw RRD file based on it's structure
 443  * @host
 444  * @plugin
 445  * @pinst
 446  * @type
 447  * @tinst
 448  * @opts
 449  * @return Commandline to call RRDGraph in order to generate the final graph
 450  */
 451 function collectd_draw_rrd($host, $plugin, $pinst = null, $type, $tinst = null, $opts = array()) {
 452         global $config;
 453         $timespan_def = null;
 454         if (!isset($opts['timespan']))
 455                 $timespan_def = reset($config['timespan']);
 456         else foreach ($config['timespan'] as &$ts)
 457                 if ($ts['name'] == $opts['timespan'])
 458                         $timespan_def = $ts;
 459
 460         if (!isset($opts['rrd_opts']))
 461                 $opts['rrd_opts'] = array();
 462         if (isset($opts['logarithmic']) && $opts['logarithmic'])
 463                 array_unshift($opts['rrd_opts'], '-o');
 464
 465         $rrdinfo = null;
 466         $rrdfile = sprintf('%s/%s%s%s/%s%s%s', $host, $plugin, is_null($pinst) ? '' : '-', $pinst, $type, is_null($tinst) ? '' : '-', $tinst);
 467         foreach ($config['datadirs'] as $datadir)
 468                 if (is_file($datadir.'/'.$rrdfile.'.rrd')) {
 469                         $rrdinfo = rrd_info($datadir.'/'.$rrdfile.'.rrd');
 470                         if (isset($rrdinfo['RRA']) && is_array($rrdinfo['RRA']))
 471                                 break;
 472                         else
 473                                 $rrdinfo = null;
 474                 }
 475
 476         if (is_null($rrdinfo))
 477                 return false;
 478
 479         $graph = array();
 480         $has_avg = false;
 481         $has_max = false;
 482         $has_min = false;
 483         reset($rrdinfo['RRA']);
 484         $l_max = 0;
 485         while (list($k, $v) = each($rrdinfo['RRA'])) {
 486                 if ($v['cf'] == 'MAX')
 487                         $has_max = true;
 488                 else if ($v['cf'] == 'AVERAGE')
 489                         $has_avg = true;
 490                 else if ($v['cf'] == 'MIN')
 491                         $has_min = true;
 492         }
 493         reset($rrdinfo['DS']);
 494         while (list($k, $v) = each($rrdinfo['DS'])) {
 495                 if (strlen($k) > $l_max)
 496                         $l_max = strlen($k);
 497                 if ($has_min)
 498                         $graph[] = sprintf('DEF:%s_min=%s:%s:MIN', $k, $rrdinfo['filename'], $k);
 499                 if ($has_avg)
 500                         $graph[] = sprintf('DEF:%s_avg=%s:%s:AVERAGE', $k, $rrdinfo['filename'], $k);
 501                 if ($has_max)
 502                         $graph[] = sprintf('DEF:%s_max=%s:%s:MAX', $k, $rrdinfo['filename'], $k);
 503         }
 504         if ($has_min && $has_max || $has_min && $has_avg || $has_avg && $has_max) {
 505                 $n = 1;
 506                 reset($rrdinfo['DS']);
 507                 while (list($k, $v) = each($rrdinfo['DS'])) {
 508                         $graph[] = sprintf('LINE:%s_%s', $k, $has_min ? 'min' : 'avg');
 509                         $graph[] = sprintf('CDEF:%s_var=%s_%s,%s_%s,-', $k, $k, $has_max ? 'max' : 'avg', $k, $has_min ? 'min' : 'avg');
 510                         $graph[] = sprintf('AREA:%s_var#%s::STACK', $k, rrd_get_color($n++, false));
 511                 }
 512         }
 513
 514         reset($rrdinfo['DS']);
 515         $n = 1;
 516         while (list($k, $v) = each($rrdinfo['DS'])) {
 517                 $graph[] = sprintf('LINE1:%s_avg#%s:%s ', $k, rrd_get_color($n++, true), $k.substr('                  ', 0, $l_max-strlen($k)));
 518                 if (isset($opts['tinylegend']) && $opts['tinylegend'])
 519                         continue;
 520                 if ($has_avg)
 521                         $graph[] = sprintf('GPRINT:%s_avg:AVERAGE:%%5.1lf%%s Avg%s', $k, $has_max || $has_min || $has_avg ? ',' : "\\l");
 522                 if ($has_min)
 523                         $graph[] = sprintf('GPRINT:%s_min:MIN:%%5.1lf%%s Max%s', $k, $has_max || $has_avg ? ',' : "\\l");
 524                 if ($has_max)
 525                         $graph[] = sprintf('GPRINT:%s_max:MAX:%%5.1lf%%s Max%s', $k, $has_avg ? ',' : "\\l");
 526                 if ($has_avg)
 527                         $graph[] = sprintf('GPRINT:%s_avg:LAST:%%5.1lf%%s Last\\l', $k);
 528         }
 529
 530         $rrd_cmd = array(RRDTOOL, 'graph', '-', '-a', 'PNG', '-w', $config['rrd_width'], '-h', $config['rrd_height'], '-s', -1*$timespan_def['seconds'], '-t', $rrdfile);
 531         $rrd_cmd = array_merge($rrd_cmd, $config['rrd_opts'], $opts['rrd_opts'], $graph);
 532
 533         $cmd = RRDTOOL;
 534         for ($i = 1; $i < count($rrd_cmd); $i++)
 535                 $cmd .= ' '.escapeshellarg($rrd_cmd[$i]);
 536
 537         return $cmd;
 538 }
 539
 540 /**
 541  * Draw RRD file based on it's structure
 542  * @timespan
 543  * @host
 544  * @plugin
 545  * @pinst
 546  * @type
 547  * @tinst
 548  * @opts
 549  * @return Commandline to call RRDGraph in order to generate the final graph
 550  */
 551 function collectd_draw_generic($timespan, $host, $plugin, $pinst = null, $type, $tinst = null) {
 552         global $config, $GraphDefs;
 553         $timespan_def = null;
 554         foreach ($config['timespan'] as &$ts)
 555                 if ($ts['name'] == $timespan)
 556                         $timespan_def = $ts;
 557         if (is_null($timespan_def))
 558                 $timespan_def = reset($config['timespan']);
 559
 560         if (!isset($GraphDefs[$type]))
 561                 return false;
 562
 563         $rrd_file = sprintf('%s/%s%s%s/%s%s%s', $host, $plugin, is_null($pinst) ? '' : '-', $pinst, $type, is_null($tinst) ? '' : '-', $tinst);
 564         $rrd_cmd  = array(RRDTOOL, 'graph', '-', '-a', 'PNG', '-w', $config['rrd_width'], '-h', $config['rrd_height'], '-s', -1*$timespan_def['seconds'], '-t', $rrd_file);
 565         $rrd_cmd  = array_merge($rrd_cmd, $config['rrd_opts']);
 566         $rrd_args = $GraphDefs[$type];
 567
 568         foreach ($config['datadirs'] as $datadir) {
 569                 $file = $datadir.'/'.$rrd_file.'.rrd';
 570                 if (!is_file($file))
 571                         continue;
 572
 573                 $file = str_replace(":", "\\:", $file);
 574                 $rrd_args = str_replace('{file}', $file, $rrd_args);
 575
 576                 $rrdgraph = array_merge($rrd_cmd, $rrd_args);
 577                 $cmd = RRDTOOL;
 578                 for ($i = 1; $i < count($rrdgraph); $i++)
 579                         $cmd .= ' '.escapeshellarg($rrdgraph[$i]);
 580
 581                 return $cmd;
 582         }
 583         return false;
 584 }
 585
 586 /**
 587  * Draw stack-graph for set of RRD files
 588  * @opts Graph options like colors
 589  * @sources List of array(name, file, ds)
 590  * @return Commandline to call RRDGraph in order to generate the final graph
 591  */
 592 function collectd_draw_meta_stack(&$opts, &$sources) {
 593         global $config;
 594         $timespan_def = null;
 595         if (!isset($opts['timespan']))
 596                 $timespan_def = reset($config['timespan']);
 597         else foreach ($config['timespan'] as &$ts)
 598                 if ($ts['name'] == $opts['timespan'])
 599                         $timespan_def = $ts;
 600
 601         if (!isset($opts['title']))
 602                 $opts['title'] = 'Unknown title';
 603         if (!isset($opts['rrd_opts']))
 604                 $opts['rrd_opts'] = array();
 605         if (!isset($opts['colors']))
 606                 $opts['colors'] = array();
 607         if (isset($opts['logarithmic']) && $opts['logarithmic'])
 608                 array_unshift($opts['rrd_opts'], '-o');
 609
 610         $cmd = array(RRDTOOL, 'graph', '-', '-a', 'PNG', '-w', $config['rrd_width'], '-h', $config['rrd_height'], '-s', -1*$timespan_def['seconds'], '-t', $opts['title']);
 611         $cmd = array_merge($cmd, $config['rrd_opts'], $opts['rrd_opts']);
 612         $max_inst_name = 0;
 613
 614         foreach($sources as &$inst_data) {
 615                 $inst_name = $inst_data['name'];
 616                 $file      = $inst_data['file'];
 617                 $ds        = isset($inst_data['ds']) ? $inst_data['ds'] : 'value';
 618
 619                 if (strlen($inst_name) > $max_inst_name)
 620                         $max_inst_name = strlen($inst_name);
 621
 622                 if (!is_file($file))
 623                         continue;
 624
 625                 $cmd[] = 'DEF:'.$inst_name.'_min='.$file.':'.$ds.':MIN';
 626                 $cmd[] = 'DEF:'.$inst_name.'_avg='.$file.':'.$ds.':AVERAGE';
 627                 $cmd[] = 'DEF:'.$inst_name.'_max='.$file.':'.$ds.':MAX';
 628                 $cmd[] = 'CDEF:'.$inst_name.'_nnl='.$inst_name.'_avg,UN,0,'.$inst_name.'_avg,IF';
 629         }
 630         $inst_data = end($sources);
 631         $inst_name = $inst_data['name'];
 632         $cmd[] = 'CDEF:'.$inst_name.'_stk='.$inst_name.'_nnl';
 633
 634         $inst_data1 = end($sources);
 635         while (($inst_data0 = prev($sources)) !== false) {
 636                 $inst_name0 = $inst_data0['name'];
 637                 $inst_name1 = $inst_data1['name'];
 638
 639                 $cmd[] = 'CDEF:'.$inst_name0.'_stk='.$inst_name0.'_nnl,'.$inst_name1.'_stk,+';
 640                 $inst_data1 = $inst_data0;
 641         }
 642
 643         foreach($sources as &$inst_data) {
 644                 $inst_name = $inst_data['name'];
 645                 $legend = sprintf('%s', $inst_name);
 646                 while (strlen($legend) < $max_inst_name)
 647                         $legend .= ' ';
 648                 $number_format = isset($opts['number_format']) ? $opts['number_format'] : '%6.1lf';
 649
 650                 if (isset($opts['colors'][$inst_name]))
 651                         $line_color = new CollectdColor($opts['colors'][$inst_name]);
 652                 else
 653                         $line_color = new CollectdColor('random');
 654                 $area_color = new CollectdColor($line_color);
 655                 $area_color->fade();
 656
 657                 $cmd[] = 'AREA:'.$inst_name.'_stk#'.$area_color->as_string();
 658                 $cmd[] = 'LINE1:'.$inst_name.'_stk#'.$line_color->as_string().':'.$legend;
 659                 if (!(isset($opts['tinylegend']) && $opts['tinylegend'])) {
 660                         $cmd[] = 'GPRINT:'.$inst_name.'_min:MIN:'.$number_format.' Min,';
 661                         $cmd[] = 'GPRINT:'.$inst_name.'_avg:AVERAGE:'.$number_format.' Avg,';
 662                         $cmd[] = 'GPRINT:'.$inst_name.'_max:MAX:'.$number_format.' Max,';
 663                         $cmd[] = 'GPRINT:'.$inst_name.'_avg:LAST:'.$number_format.' Last\\l';
 664                 }
 665         }
 666
 667         $rrdcmd = RRDTOOL;
 668         for ($i = 1; $i < count($cmd); $i++)
 669                 $rrdcmd .= ' '.escapeshellarg($cmd[$i]);
 670         return $rrdcmd;
 671 }
 672
 673 /**
 674  * Draw stack-graph for set of RRD files
 675  * @opts Graph options like colors
 676  * @sources List of array(name, file, ds)
 677  * @return Commandline to call RRDGraph in order to generate the final graph
 678  */
 679 function collectd_draw_meta_line(&$opts, &$sources) {
 680         global $config;
 681         $timespan_def = null;
 682         if (!isset($opts['timespan']))
 683                 $timespan_def = reset($config['timespan']);
 684         else foreach ($config['timespan'] as &$ts)
 685                 if ($ts['name'] == $opts['timespan'])
 686                         $timespan_def = $ts;
 687
 688         if (!isset($opts['title']))
 689                 $opts['title'] = 'Unknown title';
 690         if (!isset($opts['rrd_opts']))
 691                 $opts['rrd_opts'] = array();
 692         if (!isset($opts['colors']))
 693                 $opts['colors'] = array();
 694         if (isset($opts['logarithmic']) && $opts['logarithmic'])
 695                 array_unshift($opts['rrd_opts'], '-o');
 696
 697         $cmd = array(RRDTOOL, 'graph', '-', '-a', 'PNG', '-w', $config['rrd_width'], '-h', $config['rrd_height'], '-s', -1*$timespan_def['seconds'], '-t', $opts['title']);
 698         $cmd = array_merge($cmd, $config['rrd_opts'], $opts['rrd_opts']);
 699         $max_inst_name = 0;
 700
 701         foreach ($sources as &$inst_data) {
 702                 $inst_name = $inst_data['name'];
 703                 $file      = $inst_data['file'];
 704                 $ds        = isset($inst_data['ds']) ? $inst_data['ds'] : 'value';
 705
 706                 if (strlen($inst_name) > $max_inst_name)
 707                         $max_inst_name = strlen($inst_name);
 708
 709                 if (!is_file($file))
 710                         continue;
 711
 712                 $cmd[] = 'DEF:'.$inst_name.'_min='.$file.':'.$ds.':MIN';
 713                 $cmd[] = 'DEF:'.$inst_name.'_avg='.$file.':'.$ds.':AVERAGE';
 714                 $cmd[] = 'DEF:'.$inst_name.'_max='.$file.':'.$ds.':MAX';
 715         }
 716
 717         foreach ($sources as &$inst_data) {
 718                 $inst_name = $inst_data['name'];
 719                 $legend = sprintf('%s', $inst_name);
 720                 while (strlen($legend) < $max_inst_name)
 721                         $legend .= ' ';
 722                 $number_format = isset($opts['number_format']) ? $opts['number_format'] : '%6.1lf';
 723
 724                 if (isset($opts['colors'][$inst_name]))
 725                         $line_color = new CollectdColor($opts['colors'][$inst_name]);
 726                 else
 727                         $line_color = new CollectdColor('random');
 728
 729                 $cmd[] = 'LINE1:'.$inst_name.'_avg#'.$line_color->as_string().':'.$legend;
 730                 if (!(isset($opts['tinylegend']) && $opts['tinylegend'])) {
 731                         $cmd[] = 'GPRINT:'.$inst_name.'_min:MIN:'.$number_format.' Min,';
 732                         $cmd[] = 'GPRINT:'.$inst_name.'_avg:AVERAGE:'.$number_format.' Avg,';
 733                         $cmd[] = 'GPRINT:'.$inst_name.'_max:MAX:'.$number_format.' Max,';
 734                         $cmd[] = 'GPRINT:'.$inst_name.'_avg:LAST:'.$number_format.' Last\\l';
 735                 }
 736         }
 737
 738         $rrdcmd = RRDTOOL;
 739         for ($i = 1; $i < count($cmd); $i++)
 740                 $rrdcmd .= ' '.escapeshellarg($cmd[$i]);
 741         return $rrdcmd;
 742 }
 743
 744 ?>