graphpanel.php

<?php
/**
Contains types of Panels.
PHP version 5
@category Panel_Class
@package Histou
@author Philip Griesbacher <griesbacher@consol.de>
@license http://opensource.org/licenses/gpl-license.php GNU Public License
@link https://github.com/Griesbacher/histou
**/
namespace histou\grafana;

/**
Base Panel.
PHP version 5
@category Panel_Class
@package Histou
@author Philip Griesbacher <griesbacher@consol.de>
@license http://opensource.org/licenses/gpl-license.php GNU Public License
@link https://github.com/Griesbacher/histou
**/
class GraphPanel extends Panel
{
    /**
    Constructor.
    @param string  $title      name of the panel.
    @param boolean $legendShow hide the legend or not
    @return object.
    **/
    public function __construct($title, $legendShow = SHOW_LEGEND, $id = -1)
    {
        parent::__construct($title, 'graph', $id);
        $this->data['tooltip'] = array(
                                'show' =>  false,
                                'values' =>  false,
                                'min' =>  false,
                                'max' =>  false,
                                'current' =>  false,
                                'total' =>  false,
                                'avg' =>  false,
                                'shared' =>  true
                            );
        $this->data['legend'] = array(
                                "show" => $legendShow,
                                "values" => false,
                                "min" => false,
                                "max" => false,
                                "current" => false,
                                "total" => false,
                                "avg" => false,
                                "alignAsTable" => false,
                                "rightSide" => false,
                                "hideEmpty" => true
                            );
        $this->data['fill'] = 0;
        $this->data['linewidth'] = 2;
        $this->data['targets'] = array();
        $this->data['seriesOverrides'] = array();
        $this->data['datasource'] = "-- Mixed --";
    }

    /**
    Setter for setTooltip
    @param int $tooltip setTooltip.
    @return null.
    **/
    public function setTooltip(array $tooltip)
    {
        $this->data['tooltip'] = $tooltip;
    }

    /**
    Adds an 'line' to the panel.
    @param string $target tablename.
    @param string $alias  alias.
    @param array  $tags   tags for the query.
    @return null.
    **/
    /*public function addTargetSimple($target, $alias = "", $factor = 1, array $tags = array())
    {
        if ($factor == 1) {
            $influxdbQuery = sprintf('select mean(value) from "%s" where AND $timeFilter group by time($interval)', $target);
        } else {
            $influxdbQuery = sprintf('select (mean(value) * $factor) from "%s" where AND $timeFilter group by time($interval)', $target);
        }
        array_push(
            $this->data['targets'],
            array(
            "fields" => array(
                              array(
                                    "func" => "mean",
                                    "name" => "value",
                                   )
                             ),
            "groupBy" => array(
                               array(
                                     "interval" => "auto",
                                     "type" => "time",
                                    )
                              ),
            "measurement" => $target,
            "query" => $influxdbQuery,
            "alias" => $alias,
            "tags" => $tags,
            "datasource" => INFLUX_DB
            )
        );
    }*/

    /**
    Changes the color of a line.
    @param string $alias linename.
    @param string $color hexcolor.
    @return null.
    **/
    public function addAliasColor($alias, $color)
    {
        if (!isset($this->data['aliasColors'])) {
            $this->data['aliasColors'] = array();
        }
        $this->data['aliasColors'][$alias] = $color;
    }

    /**
    Setter for leftYAxisLabel
    @param string $label label.
    @return null.
    **/
    public function setLeftYAxisLabel($label)
    {
        $this->data['leftYAxisLabel'] = $label;
    }

    /**
    Setter for rightYAxisLabel
    @param string $label label.
    @return null.
    **/
    public function setRightYAxisLabel($label)
    {
        $this->data['rightYAxisLabel'] = $label;
    }

    /**
    Tries to convert the given unit in a "grafana unit" if not possible the leftYAxisLabel will be set.
    @param string $unit unit.
    @return null.
    **/
    public function setLeftUnit($unit)
    {
        $gUnit = $this->convertUnit($unit);
        if (array_key_exists('y_formats', $this->data) && sizeof($this->data['y_formats']) > 0) {
            $this->data['y_formats'][0] = $gUnit;
        } else {
            $this->data['y_formats'] = array($gUnit, 'short');
        }
        if ($gUnit == 'short') {
            $this->setLeftYAxisLabel($unit);
        }
    }

    /**
    Tries to convert the given unit in a "grafana unit" if not possible the rightYAxisLabel will be set.
    @param string $unit unit.
    @return null.
    **/
    public function setRightUnit($unit)
    {
        $gUnit = $this->convertUnit($unit);
        if (array_key_exists('y_formats', $this->data) && sizeof($this->data['y_formats']) > 0) {
            $this->data['y_formats'][1] = $gUnit;
        } else {
            $this->data['y_formats'] = array('short', $gUnit);
        }
        if ($gUnit == 'short') {
            $this->setRightYAxisLabel($unit);
        }
    }

    /**
    Try to convert the given unit in a grafana unit.
    @param string $label unit.
    @return string if found a grafanaunit.
    **/
    private function convertUnit($unit)
    {
        switch ($unit) {
            //Time
            case 'ns':
            case 'µs':
            case 'ms':
            case 's':
            case 'm':
            case 'h':
            case 'd':
                return $unit;
            //Data
            case 'b':
                return 'bits';
                break;
            case 'B':
                return 'bytes';
            case 'KB':
            case 'KiB':
            case 'kiB':
            case 'kB':
                return 'kbytes';
            case 'MB':
            case 'MiB':
            case 'miB':
            case 'mB':
                return 'mbytes';
            case 'GB':
            case 'GiB':
            case 'giB':
            case 'gB':
                return 'gbytes';
            case '%':
            case 'percent':
            case 'pct':
            case 'pct.':
            case 'pc':
                return 'percent';
            default:
                return 'short';
        }
    }

    /**
    Adds any threshold lines
    @param string $host      hostname.
    @param string $service   servicename.
    @param string $command   commandname.
    @param array  $perfLabel hostname.
    @param string $type      line label.
    @param string $color     hexcolor.
    @return null.
    **/
    /*private function addThreshold($host, $service, $command, $perfLabel, $type, $color, $alias)
    {
        foreach (array('normal', 'min', 'max') as $tag) {
            $target = \histou\helper\str::influxdbTablename($host, $service, $command, $perfLabel, $type);
            $localAlias = '';
            if ($alias == '') {
                if ($tag == 'normal') {
                    $localAlias = $type;
                } else {
                    $localAlias = $type.'-'.$tag;
                }
            } elseif ($tag != 'normal') {
                $localAlias = $alias.'-'.$tag;
            } else {
                $localAlias = $alias;
            }

            $this->addTargetSimple(
                $target,
                $localAlias,
                1,
                array(array('key' => 'type', 'operator'  => '=', 'value' => $tag))
            );
            $this->addAliasColor($localAlias, $color);
        }
    }*/

    /**
    Adds yellow warning lines
    @param string $host      hostname.
    @param string $service   servicename.
    @param string $command   commandname.
    @param array  $perfLabel hostname.
    @return null.
    **/
    public function addWarning($host, $service, $command, $perfLabel, $alias = '')
    {
        $this->addThreshold($host, $service, $command, $perfLabel, 'warn', '#FFFC15', $alias);
    }

    /**
    Adds red critical lines
    @param string $host      hostname.
    @param string $service   servicename.
    @param string $command   commandname.
    @param array  $perfLabel hostname.
    @return null.
    **/
    public function addCritical($host, $service, $command, $perfLabel, $alias = '')
    {
        $this->addThreshold($host, $service, $command, $perfLabel, 'crit', '#FF3727', $alias);
    }

    /**
    Setter for Linewidth
    @param int $width Linewidth.
    @return null.
    **/
    public function setLinewidth($width)
    {
        $this->data['linewidth'] = $width;
    }

    /**
    Adds dots to the value line if there is a downtime
    @param string $host      hostname.
    @param string $service   servicename.
    @param string $command   commandname.
    @param array  $perfLabel hostname.
    @param string $color     Color of the dots
    @return null.
    **/
    /*public function addDowntime($host, $service, $command, $perfLabel, $color = '#EEE')
    {
        $target = sprintf(
            '%s%s%s%s%s%s%s%svalue',
            $host,
            INFLUX_FIELDSEPERATOR,
            $service,
            INFLUX_FIELDSEPERATOR,
            $command,
            INFLUX_FIELDSEPERATOR,
            $perfLabel,
            INFLUX_FIELDSEPERATOR
        );
        $alias = "downtime";
        $this->addTargetSimple(
            $target,
            $alias,
            1,
            array(array('key' => 'downtime', 'operator'  => '=', 'value' => '1'))
        );
        array_push(
            $this->data['seriesOverrides'],
            array(
            'lines' => true,
            'alias' => $alias,
            'linewidth' => 3,
            'legend' => false,
            'fill' => 3,
            )
        );
        $this->addAliasColor($alias, $color);
    }*/

    /**
    Fills the area below a line.
    @param string $alias     name of the query.
    @param int    $intensity intensity of the color.
    @return null.
    **/
    public function fillBelowLine($alias, $intensity)
    {
        array_push(
            $this->data['seriesOverrides'],
            array(
            'alias' => $alias,
            'fill' => $intensity,
            )
        );
    }
    /**
    Negates the Y Axis.
    @param string $alias     name of the query.
    @return null.
    **/
    public function negateY($alias)
    {
        array_push(
            $this->data['seriesOverrides'],
            array(
            'alias' => $alias,
            'transform' => 'negative-Y'
            )
        );
    }
    /**
    Display the values on the left or right y axis, left = 1 right = 2.
    @param string $alias name of the query.
    @return null.
    **/
    public function setYAxis($alias, $number = 1)
    {
        array_push(
            $this->data['seriesOverrides'],
            array(
            'alias' => $alias,
            'yaxis' => $number
            )
        );
    }

    public function createTarget($host, $service, $command, $performanceLabel, array $filterTags = array())
    {
        return array(
                    'measurement' => 'metrics',
                    'alias' => '$col',
                    'select' => array(),
                    'tags' => $this->createFilterTags($host, $service, $command, $performanceLabel, $filterTags),
                    'dsType' => 'influxdb',
                    'resultFormat' => 'time_series',
                    'datasource' => INFLUX_DB
                    );
    }

    /**
    Creates filter tags array based on host, service...
    **/
    public function createFilterTags($host, $service, $command, $performanceLabel, array $filterTags = array())
    {
        $tags = array();
        $filter = array('host' => $host, 'service' => $service, 'command' => $command, 'performanceLabel' => $performanceLabel);
        $filter = array_merge($filter, $filterTags);
        $i = 0;
        foreach ($filter as $key => $value) {
            if ($i == 0) {
                array_push($tags, array('key'=> $key, 'operator' => '=', 'value' => $value ));
            } else {
                array_push($tags, array('condition' => 'AND', 'key'=> $key, 'operator' => '=', 'value' => $value ));
            }
            $i++;
        }
        return $tags;
    }

    /**
    This creates a target with an value.
    **/
    public function genTargetSimple($host, $service, $command, $performanceLabel, $alias = '')
    {
        if ($alias == '') {
            $alias = $performanceLabel;
        }
        $target = $this->createTarget($host, $service, $command, $performanceLabel);
        $target = $this->addXToTarget($target, array('value'), $alias, '#085DFF');
        return $target;
    }

    public function addWarnToTarget($target, $alias = '')
    {
        return $this->addXToTarget($target, array('warn', 'warn-min', 'warn-max'), $alias, '#FFFC15');
    }

    public function addCritToTarget($target, $alias = '')
    {
        return $this->addXToTarget($target, array('crit', 'crit-min', 'crit-max'), $alias, '#FF3727');
    }

    private function addXToTarget($target, $types, $alias, $color, $keepAlias = true)
    {
        foreach ($types as $type) {
            if ($keepAlias) {
                $alias = $alias.'-'.$type;
            }
            array_push($target['select'], $this->createSelect($type, $alias));
            $this->addAliasColor($alias, $color);
        }
        return $target;
    }

    public function createSelect($name, $alias)
    {
        return array(
                    array('type' => 'field', 'params' => array($name)),
                    array('type' => 'mean', 'params' => array()),
                    array('type' => 'alias', 'params' => array($alias))
                    );
    }
    /**
    This creates a target for an downtime.
    **/
    public function genDowntimeTarget($host, $service, $command, $performanceLabel, $alias = '')
    {
        if ($alias == '') {
            $alias = 'downtime';
        }
        $target = $this->createTarget($host, $service, $command, $performanceLabel, array('downtime' => "true"));
        $target = $this->addXToTarget($target, array('value'), $alias, '#EEE', false);
		array_push(
            $this->data['seriesOverrides'],
            array(
            'lines' => true,
            'alias' => $alias,
            'linewidth' => 3,
            'legend' => false,
            'fill' => 3,
            )
        );
        return $target;
    }


    /**
    Adds the target to the dashboard.
    **/
    public function addTarget($target)
    {
        array_push($this->data['targets'], $target);
    }
}