Skip to content

added template helper stack_outline.php #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

added template helper stack_outline.php #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 198 additions & 0 deletions share/pnp/templates.dist/stack_outline.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
<?php

# This script was initially developed by Infoxchange for internal use
# and has kindly been made available to the Open Source community for
# redistribution and further development under the terms of the
# GNU General Public License v2: http://www.gnu.org/licenses/gpl.html
# Copyright 2015 Infoxchange
# Author: George Hansper <[email protected]>
#
# I found this on the check_postgres mailing list
# https://mail.endcrypt.com/pipermail/check_postgres/2009-March/000308.html
# Original posted by Cédric Villemain
# Rewritten to support RRD_STORAGE_TYPE = MULTIPLE and make it a little more flexible
#
# Usage:
# Put this file in the PNP4Nagios templates directory, and provide eg. a check_disk.php template like this:
# <?php
# $opt[1] = "--vertical-label \"bytes\" --title \"Disk usage for $hostname\" -l 0 ";
# require('stack_outline.php');
# ? >
# Or to render multiple values on one graph without stacking...
# <?php
# $opt[1] = "--vertical-label \"bytes\" --title \"Disk usage for $hostname\" -l 0 ";
# $STACK=false;
# $FILL=false;
# require('stack_outline.php');
# ? >
#
# Other control variables:
# $FILL = false;
# ... draw line graphs only (not filled area graphs)
#
# $LIMIT = 8;
# ... at most $LIMIT data-sources per graph eg
# eg. $LIMT=8 if there are 12 Data Sources, render the 1st 8 DS items on the 1st graph, and the next 4 on the second graph
#
# $REGEX = '/abc/';
# ... only create graphs for Data Sources that match the regular expression $REGEX
#
# $REGEX_EXCLUDE = true;
# ... exclude only Data Sources that match the regular expression $REGEX
#
# Any Data Source (perfdata label) named 'time' will be rendered separately below the stacked graph
# The 'time' DS is created by check_postgres and represents the execution time of the plugin
#
# The stack_outline.php can be called multiple times from the same template, with different $REGEX settings
#

###############################################################################
# Common part for stacked graph with outline
###############################################################################

$palette = array(
array('RED', '#EA644A', '#CC3118'),
array('YELLOW', '#ECD748', '#C9B215'),
array('ORANGE', '#EC9D48', '#CC7016'),
array('GREEN', '#54EC48', '#24BC14'),
array('PINK', '#DE48EC', '#B415C7'),
array('BLUE', '#48C4EC', '#1598C3'),
array('PURPLE', '#7648EC', '#4D18E4'),
array('GREY', '#C0C0C0', '#808080')
);

# Set defaults, if not already set
if ( ! isset($def[1]) ) {
$def = array();
$def_n_start=1;
} else {
$def_n_start = count($def)+1;
if ( ! isset( $opt[$def_n_start] ) || $opt[$def_n_start] == '' ) {
# Set the title and other options from the 1st graph, if the user hasn't supplied $opt[]
$opt[$def_n_start] = $opt[1];
}
}

if ( ! isset($FILL) ) {
$FILL=true;
}

if ( ! isset($REGEX_EXCLUDE) ) {
$REGEX_EXCLUDE=false;
}

#-----------------------
$def_n = $def_n_start;
# Graph index - counter for the number of DS's we have included in this graph
$gr_ndx=0;
$cdef_line = '';

foreach ( array_keys($DS) as $ds_ndx ) {
if ( isset( $REGEX ) ) {
if ( $REGEX_EXCLUDE && preg_match($REGEX, $NAME[$ds_ndx] ) ) {
# Skip over anything that matches the regex
continue;
} elseif ( ! $REGEX_EXCLUDE && ! preg_match($REGEX, $NAME[$ds_ndx] ) ) {
# Skip over anything that doesn't match the regex
continue;
}
# Otherwise, proceed with the graph
}
if ($NAME[$ds_ndx] == 'time' ) {
# Skip the time DS for now, save the DS index so we can put it at the end
$ds_ndx_time = $ds_ndx;
continue;
}

$gr_ndx+=1;
if ( isset($LIMIT) && $gr_ndx > $LIMIT ) {
$gr_ndx=1;
if ( ! isset($opt[$def_n+1] ) || $opt[$def_n+1]=='' ) {
$opt[$def_n+1] = $opt[$def_n];
}
$def[$def_n].= $cdef_line;
$def_n++;
}

if ($gr_ndx <= 1 ) {
# This is a new graph (new $def[] ), initialize a few things
$def[$def_n] = '';
$ds_name[$def_n] = '';
$TYPE='';
$cdef_line = '';
} else {
# more items for this graph, should we stack them?
if ( ! isset($STACK) || $STACK == true ) {
# Stacked data
$TYPE="STACK";
} else {
# Not stacked data
$TYPE='';
}
}

switch( substr($UNIT[$ds_ndx],0,1) ) {
case 'T' : $unit_mutiplier = 1099511627776; break;
case 'G' : $unit_mutiplier = 1073741824; break;
case 'M' : $unit_mutiplier = 1048576; break;
case 'k' : $unit_mutiplier = 1024; break;
default : $unit_mutiplier = 1; break;
}

# Area

# Note that we are using the $ds_ndx as the color index
# This means that we use all available colors, rather than re-using low-numbered ones (eg if $gr_ndx is used for color picking)
# It also means that if the same DS is rendered twice, it will get the same color from the palette, which is desirable
# The cdef is used to convert the original data in k,M,G etc back to base units, so rrdtool can do it's own unit rendering
$def[$def_n] .= rrd::def( "raw_{$gr_ndx}", $RRDFILE[$ds_ndx], $DS[$ds_ndx], "MAX");
$def[$def_n] .= rrd::cdef( "var_{$gr_ndx}", "raw_{$gr_ndx},$unit_mutiplier,*" );
if ( $FILL ) {
$def[$def_n] .= rrd::area( "var_{$gr_ndx}", $palette[($ds_ndx-1)%count($palette)][1], sprintf('%-15s',$LABEL[$ds_ndx]), $TYPE);
} else {
$def[$def_n] .= rrd::line1( "var_{$gr_ndx}", $palette[($ds_ndx-1)%count($palette)][2], sprintf('%-15s',$LABEL[$ds_ndx]), $TYPE);
}
$def[$def_n] .= rrd::gprint("var_{$gr_ndx}", array("LAST", "AVERAGE", "MAX"), "%6.3lg %s");
$ds_name[$def_n] .= "$LABEL[$ds_ndx] ";
if ( strlen($ds_name[$def_n]) > 70 ) {
$ds_name[$def_n] = substr($ds_name[$def_n],0,66) . "...";
}

# Line

# Draw a line, too, for each area graph, as an outline
# These lines go last, so they don't get drawn over by the area graphs
# The label is set to '' so these lines do not appear in the legend
# The cdef is there to omit line segments with value 0, to prevent 'uninteresting' lines from overwriting the previous line
# The value 'UNKN' is plotted as an empty space
if ( $FILL ) {
if ( ! isset($STACK) || $STACK == true ) {
$cdef_line .= rrd::cdef( "line_{$gr_ndx}", "var_{$gr_ndx},var_{$gr_ndx},UNKN,IF" );
$cdef_line .= rrd::line1( "line_{$gr_ndx}", $palette[($ds_ndx-1)%count($palette)][2], '', $TYPE);
} else {
$cdef_line .= rrd::line1( "var_{$gr_ndx}", $palette[($ds_ndx-1)%count($palette)][2], '', $TYPE);
}
}
}

if ( $cdef_line != '' ) {
$def[$def_n].= $cdef_line;
}

# Put the execution time graph last
if ( isset($ds_ndx_time) ) {
$def_n++;
$opt[$def_n] = "--title \"Execution time for $servicedesc on $hostname\" -l 0 ";
$ds_name[$def_n] = $LABEL[$ds_ndx_time];
$def[$def_n] = rrd::def( 'exec_time', $RRDFILE[$ds_ndx_time], $DS[$ds_ndx_time], "MAX");
if ( $FILL ) {
$def[$def_n] .= rrd::area( 'exec_time', $palette[5][1], $LABEL[$ds_ndx_time] );
$def[$def_n] .= rrd::line1( 'exec_time', $palette[5][2], '', '' );
} else {
$def[$def_n] .= rrd::line1( 'exec_time', $palette[5][2], $LABEL[$ds_ndx_time] );
}
$def[$def_n] .= rrd::gprint('exec_time', array("LAST", "MIN", "AVERAGE", "MAX"), "%6.3lg %s");
unset($ds_ndx_time);
}

?>