mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
020c5fd7e1
* removing $graphs global * remove unused things * fix some additional graphs * Fix graphs persisting too soon * correct name for poller module performance graph * only one type of graph is used here
126 lines
2.8 KiB
Markdown
126 lines
2.8 KiB
Markdown
source: Developing/os/Custom-Graphs.md
|
|
path: blob/master/doc/
|
|
|
|
First we define our graphs in `includes/definitions.inc.php` to share
|
|
our work and contribute in the development of LibreNMS. :-) (or place
|
|
in `config.php` if you don't plan to contribute)
|
|
|
|
```php
|
|
// Pulse Secure Graphs
|
|
$config['graph_types']['device']['pulse_sessions'] = ['section' => 'firewall', 'order' => 0, 'descr' => 'Active Sessions'];
|
|
$config['graph_types']['device']['pulse_users'] = ['section' => 'firewall', 'order' => 0, 'descr' => 'Active Users'];
|
|
```
|
|
|
|
#### Polling OS
|
|
|
|
OS polling is not necessarily where custom polling should be done,
|
|
please speak to one of the core devs in
|
|
[Discord](https://t.libren.ms/discord) for guidance.
|
|
|
|
Let's update our example file to add additional polling:
|
|
|
|
```bash
|
|
includes/polling/os/pulse.inc.php
|
|
```
|
|
|
|
We declare two specific graphs for users and sessions numbers. Theses
|
|
two graphs will be displayed on the firewall section of the graphs tab
|
|
as it was written in the definition include file.
|
|
|
|
```php
|
|
<?php
|
|
|
|
use LibreNMS\RRD\RrdDefinition;
|
|
|
|
$users = snmp_get($device, 'iveConcurrentUsers.0', '-OQv', 'PULSESECURE-PSG-MIB');
|
|
|
|
if (is_numeric($users)) {
|
|
$rrd_def = RrdDefinition::make()->addDataset('users', 'GAUGE', 0);
|
|
|
|
$fields = array(
|
|
'users' => $users,
|
|
);
|
|
|
|
$tags = compact('rrd_def');
|
|
data_update($device, 'pulse_users', $tags, $fields);
|
|
$os->enableGraph('pulse_users');
|
|
}
|
|
|
|
$sessions = snmp_get($device, 'iveConcurrentUsers.0', '-OQv', 'PULSESECURE-PSG-MIB');
|
|
|
|
if (is_numeric($sessions)) {
|
|
$rrd_def = RrdDefinition::make()->addDataset('sessions', 'GAUGE', 0);
|
|
|
|
$fields = array(
|
|
'sessions' => $sessions,
|
|
);
|
|
|
|
$tags = compact('rrd_def');
|
|
data_update($device, 'pulse_sessions', $tags, $fields);
|
|
$os->enableGraph('pulse_sessions');
|
|
}
|
|
```
|
|
|
|
#### Displaying
|
|
|
|
The specific graphs are not displayed automatically so we need to
|
|
write the following PHP code:
|
|
|
|
**Pulse Sessions**
|
|
|
|
```bash
|
|
includes/html/graphs/device/pulse_sessions.inc.php
|
|
```
|
|
|
|
```php
|
|
<?php
|
|
|
|
$rrd_filename = rrd_name($device['hostname'], 'pulse_sessions');
|
|
|
|
require 'includes/graphs/common.inc.php';
|
|
|
|
$ds = 'sessions';
|
|
|
|
$colour_area = '9999cc';
|
|
$colour_line = '0000cc';
|
|
|
|
$colour_area_max = '9999cc';
|
|
|
|
$graph_max = 1;
|
|
$graph_min = 0;
|
|
|
|
$unit_text = 'Sessions';
|
|
|
|
require 'includes/graphs/generic_simplex.inc.php';
|
|
```
|
|
|
|
**Pulse Users**
|
|
|
|
```bash
|
|
includes/html/graphs/device/pulse_users.inc.php
|
|
```
|
|
|
|
```php
|
|
<?php
|
|
|
|
$rrd_filename = rrd_name($device['hostname'], 'pulse_users');
|
|
|
|
require 'includes/html/graphs/common.inc.php';
|
|
|
|
$ds = 'users';
|
|
|
|
$colour_area = '9999cc';
|
|
$colour_line = '0000cc';
|
|
|
|
$colour_area_max = '9999cc';
|
|
|
|
$graph_max = 1;
|
|
|
|
$unit_text = 'Users';
|
|
|
|
require 'includes/html/graphs/generic_simplex.inc.php';
|
|
```
|
|
|
|
That should be it, after data has started to be collected graphs
|
|
should appear in the WebUI.
|