Organizr/api/functions/netdata-functions.php

<?php

function netdataSettngsArray()
{
    $array = array(
        'name' => 'Netdata',
        'enabled' => true,
        'image' => 'plugins/images/tabs/netdata.png',
        'category' => 'Monitor',
        'settings' => array(
            'Enable' => array(
                array(
                    'type' => 'switch',
                    'name' => 'homepageNetdataEnabled',
                    'label' => 'Enable',
                    'value' => $GLOBALS['homepageNetdataEnabled']
                ),
                array(
                    'type' => 'select',
                    'name' => 'homepageNetdataAuth',
                    'label' => 'Minimum Authentication',
                    'value' => $GLOBALS['homepageNetdataAuth'],
                    'options' => groupSelect()
                )
            ),
            'Connection' => array(
                array(
                    'type' => 'html',
                    'override' => 12,
                    'label' => 'Info',
                    'html' => 'The URL needs to be on the same domain as your Organizr, and be proxied by subdomain. E.g. If Organizr is accessed at: https://domain.com, then your URL for netdata should be: https://netdata.domain.com'
                ),
                array(
                    'type' => 'input',
                    'name' => 'netdataURL',
                    'label' => 'URL',
                    'value' => $GLOBALS['netdataURL'],
                    'help' => 'Please enter the local IP:PORT of your netdata instance'
                ),
                array(
                    'type' => 'blank',
                    'label' => ''
                ),
            ),
        )
    );

    for($i = 1; $i <= 7; $i++) {
        $array['settings']['Chart '.$i] = array(
            array(
                'type' => 'switch',
                'name' => 'netdata'.$i.'Enabled',
                'label' => 'Enable',
                'value' => $GLOBALS['netdata'.$i.'Enabled']
            ),
            array(
                'type' => 'blank',
                'label' => ''
            ),
            array(
                'type' => 'input',
                'name' => 'netdata'.$i.'Title',
                'label' => 'Title',
                'value' => $GLOBALS['netdata'.$i.'Title'],
                'help' => 'Title for the netdata graph'
            ),
            array(
                'type' => 'select',
                'name' => 'netdata'.$i.'Data',
                'label' => 'Data',
                'value' => $GLOBALS['netdata'.$i.'Data'],
                'options' => netdataOptions(),
            ),
            array(
                'type' => 'select',
                'name' => 'netdata'.$i.'Chart',
                'label' => 'Chart',
                'value' => $GLOBALS['netdata'.$i.'Chart'],
                'options' => netdataChartOptions(),
            ),
            array(
                'type' => 'select',
                'name' => 'netdata'.$i.'Colour',
                'label' => 'Colour',
                'value' => $GLOBALS['netdata'.$i.'Colour'],
                'options' => netdataColourOptions(),
            ),
            array(
                'type' => 'select',
                'name' => 'netdata'.$i.'Size',
                'label' => 'Size',
                'value' => $GLOBALS['netdata'.$i.'Size'],
                'options' => netdataSizeOptions(),
            ),
            array(
                'type' => 'blank',
                'label' => ''
            ),
            array(
                'type' => 'switch',
                'name' => 'netdata'.$i.'lg',
                'label' => 'Show on large screens',
                'value' => $GLOBALS['netdata'.$i.'lg']
            ),
            array(
                'type' => 'switch',
                'name' => 'netdata'.$i.'md',
                'label' => 'Show on medium screens',
                'value' => $GLOBALS['netdata'.$i.'md']
            ),
            array(
                'type' => 'switch',
                'name' => 'netdata'.$i.'sm',
                'label' => 'Show on small screens',
                'value' => $GLOBALS['netdata'.$i.'sm']
            ),
        );
    }

    $array['settings']['Custom data'] = [
        [
            'type' => 'html',
            'label' => '',
            'override' => 12,
            'html' => <<<HTML
            <div>
                <p>This is where you can define custom data sources for your netdata charts. To use a custom source, you need to select 'Custom' in the data field for the chart.</p>
                <p>To define a custom data source, you need to add an entry to the JSON below, where the key is the chart number you want the custom data to be used for. Here is an example to set chart 1's custom data source to RAM percentage:</p>
                <pre>{
                "1": {
                    "url": "/api/v1/data?chart=system.ram&format=array&points=540&group=average&gtime=0&options=absolute|percentage|jsonwrap|nonzero&after=-540&dimensions=used|buffers|active|wired",
                    "value": "result,0",
                    "units": "%",
                    "max": 100
                }
            }</pre>
                <p>The URL is appended to your netdata URL and returns JSON formatted data. The value field tells Organizr how to return the value you want from the netdata API. This should be formatted as comma-separated keys to access the desired value. So the value field here will access data from an array like this:</p>
                <pre>[
                'result': [
                    VALUE,
                    // more values...
                ]
            ]</pre>
            </div>
            HTML
        ],
        [
            'type' => 'textbox',
            'name' => 'netdataCustom',
            'class' => 'javaTextarea',
            'label' => 'Custom definitions',
            'override' => 12,
            'value' => $GLOBALS['netdataCustom'],
            'attr' => 'rows="10"',
        ]
    ];

    $array['settings']['Options'] =  array(
        array(
            'type' => 'select',
            'name' => 'homepageNetdataRefresh',
            'label' => 'Refresh Seconds',
            'value' => $GLOBALS['homepageNetdataRefresh'],
            'options' => optionTime()
        ),
    );

    return $array;
}

function disk($dimension, $url)
{
    $data = [];
    // Get Data
    $dataUrl = $url . '/api/v1/data?chart=system.io&dimensions='.$dimension.'&format=array&points=540&group=average&gtime=0&options=absolute|jsonwrap|nonzero&after=-540';
    try {
        $response = Requests::get($dataUrl);
        if ($response->success) {
            $json = json_decode($response->body, true);
            $data['value'] = $json['latest_values'][0] / 1000;
            $data['percent'] =  getPercent($json['latest_values'][0], $json['max']);
            $data['units'] = 'MiB/s';
            $data['max'] = $json['max'];
        }
    } catch (Requests_Exception $e) {
        writeLog('error', 'Netdata Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
    };

    return $data;
}

function diskSpace($dimension, $url)
{
    $data = [];
    // Get Data
    $dataUrl = $url . '/api/v1/data?chart=disk_space._&format=json&points=509&group=average&gtime=0&options=ms|jsonwrap|nonzero&after=-540&dimension='.$dimension;
    try {
        $response = Requests::get($dataUrl);
        if ($response->success) {
            $json = json_decode($response->body, true);
            $data['value'] = $json['result']['data'][0][1];
            $data['percent'] = $data['value'];
            $data['units'] = '%';
            $data['max'] = 100;
        }
    } catch (Requests_Exception $e) {
        writeLog('error', 'Netdata Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
    };

    return $data;
}

function net($dimension, $url)
{
    $data = [];

    // Get Data
    $dataUrl = $url . '/api/v1/data?chart=system.net&dimensions='.$dimension.'&format=array&points=540&group=average&gtime=0&options=absolute|jsonwrap|nonzero&after=-540';
    try {
        $response = Requests::get($dataUrl);
        if ($response->success) {
            $json = json_decode($response->body, true);
            $data['value'] = $json['latest_values'][0] / 1000;
            $data['percent'] = getPercent($json['latest_values'][0], $json['max']);
            $data['units'] = 'Mbit/s';
            $data['max'] = $json['max'];
        }
    } catch (Requests_Exception $e) {
        writeLog('error', 'Netdata Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
    };

    return $data;
}

function cpu($url)
{
    $data = [];
    $dataUrl = $url . '/api/v1/data?chart=system.cpu&format=array';
    try {
        $response = Requests::get($dataUrl);
        if ($response->success) {
            $json = json_decode($response->body, true);
            $data['value'] = $json[0];
            $data['percent'] = $data['value'];
            $data['max'] = 100;
            $data['units'] = '%';
        }
    } catch (Requests_Exception $e) {
        writeLog('error', 'Netdata Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
    };

    return $data;
}

function ram($url)
{
    $data = [];
    $dataUrl = $url . '/api/v1/data?chart=system.ram&format=array&points=540&group=average&gtime=0&options=absolute|percentage|jsonwrap|nonzero&after=-540&dimensions=used|buffers|active|wired';
    try {
        $response = Requests::get($dataUrl);
        if ($response->success) {
            $json = json_decode($response->body, true);
            $data['value'] = $json['result'][0];
            $data['percent'] = $data['value'];
            $data['max'] = 100;
            $data['units'] = '%';
        }
    } catch (Requests_Exception $e) {
        writeLog('error', 'Netdata Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
    };

    return $data;
}

function swap($url)
{
    $data = [];
    $dataUrl = $url . '/api/v1/data?chart=system.swap&format=array&points=540&group=average&gtime=0&options=absolute|percentage|jsonwrap|nonzero&after=-540&dimensions=used';
    try {
        $response = Requests::get($dataUrl);
        if ($response->success) {
            $json = json_decode($response->body, true);
            $data['value'] = $json['result'][0];
            $data['percent'] = $data['value'];
            $data['max'] = 100;
            $data['units'] = '%';
        }
    } catch (Requests_Exception $e) {
        writeLog('error', 'Netdata Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
    };

    return $data;
}

function ipmiTemp($url, $unit)
{
    $data = [];
    $dataUrl = $url . '/api/v1/data?chart=ipmi.temperatures_c&format=array&points=540&group=average&gtime=0&options=absolute|jsonwrap|nonzero&after=-540';
    try {
        $response = Requests::get($dataUrl);
        if ($response->success) {
            $json = json_decode($response->body, true);
            $data['value'] = $json['result'][0];
            if($unit == 'c') {
                $data['percent'] = ($data['value'] / 50) * 100;
                $data['max'] = 50;
            } else if($unit == 'f') {
                $data['value'] = ($data['value'] * 9/5) + 32;
                $data['percent'] = ($data['value'] / 122) * 100;
                $data['max'] = 122;
            }
            $data['units'] = '°'.strtoupper($unit);
        }
    } catch (Requests_Exception $e) {
        writeLog('error', 'Netdata Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
    };

    return $data;
}

function getPercent($val, $max)
{
    if($max == 0) {
        return 0;
    } else {
        return ( $val / $max ) * 100;
    }
}

function cpuTemp($url, $unit)
{
    $data = [];
    $dataUrl = $url . '/api/v1/data?chart=sensors.coretemp-isa-0000_temperature&format=json&points=509&group=average&gtime=0&options=ms|flip|jsonwrap|nonzero&after=-540';
    try {
        $response = Requests::get($dataUrl);
        if ($response->success) {
            $json = json_decode($response->body, true);
            $vals = $json['latest_values'];
            $vals = array_filter($vals);
            if(count($vals) > 0) {
                $data['value'] = array_sum($vals) / count($vals);
            } else {
                $data['value'] = 0;
            }
            
            if($unit == 'c') {
                $data['percent'] = ($data['value'] / 50) * 100;
                $data['max'] = 50;
            } else if($unit == 'f') {
                $data['value'] = ($data['value'] * 9/5) + 32;
                $data['percent'] = ($data['value'] / 122) * 100;
                $data['max'] = 122;
            }
            $data['units'] = '°'.strtoupper($unit);
        }
    } catch (Requests_Exception $e) {
        writeLog('error', 'Netdata Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
    };

    return $data;
}

function customNetdata($url, $id)
{
    try {
        $customs = json_decode($GLOBALS['netdataCustom'], true, 512, JSON_THROW_ON_ERROR);
    } catch(Exception $e) {
        $customs = false;
    }
        
    if($customs == false) {
        return [
            'error' => 'unable to parse custom JSON'
        ];
    } else if(!isset($customs[$id])) {
        return [
            'error' => 'custom definition not found'
        ];
    } else {
        $data = [];
        $custom = $customs[$id];

        if(isset($custom['url']) && isset($custom['value']) && isset($custom['max']) && isset($custom['units'])) {
            $dataUrl = $url . '/' . $custom['url'];
            try {
                $response = Requests::get($dataUrl);
                if ($response->success) {
                    $json = json_decode($response->body, true);
                    $data['max'] = $custom['max'];
                    $data['units'] = $custom['units'];
    
                    $selectors = explode(',', $custom['value']);
                    foreach($selectors as $selector) {
                        if(is_numeric($selector)) {
                            $selector = (int) $selector;
                        }
                        if(!isset($data['value'])) {
                            $data['value'] = $json[$selector];
                        } else {
                            $data['value'] = $data['value'][$selector];
                        }
                    }
    
                    if($data['max'] == 0) {
                        $data['percent'] = 0;
                    } else {
                        $data['percent'] = ( $data['value'] / $data['max'] ) * 100;
                    }
                }
            } catch (Requests_Exception $e) {
                writeLog('error', 'Netdata Connect Function - Error: ' . $e->getMessage(), 'SYSTEM');
            };
        } else {
            $data['error'] = 'custom definition incomplete';
        }
    
        return $data;
    }
}