mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
Availability module fixes (#15369)
* Refactor poller to allow modules to run even if the device is down Include core in config (but not webui) to avoid silly shenanigans Inject datastore into polling * Needed to split datastore interface * Cleanup some data_udpate() references * Apply fixes from StyleCI * Fix legacy poller :D * Output to the correct stream * Fix lint issues * Apply fixes from StyleCI * Fix discovery not including core and submodule handling * Use whereRaw --------- Co-authored-by: StyleCI Bot <bot@styleci.io>
This commit is contained in:
46
LibreNMS/Interfaces/Data/DataStorageInterface.php
Normal file
46
LibreNMS/Interfaces/Data/DataStorageInterface.php
Normal file
@@ -0,0 +1,46 @@
|
||||
<?php
|
||||
/**
|
||||
* DataStorageInterface.php
|
||||
*
|
||||
* -Description-
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* @link https://www.librenms.org
|
||||
*
|
||||
* @copyright 2023 Tony Murray
|
||||
* @author Tony Murray <murraytony@gmail.com>
|
||||
*/
|
||||
|
||||
namespace LibreNMS\Interfaces\Data;
|
||||
|
||||
interface DataStorageInterface
|
||||
{
|
||||
/**
|
||||
* Datastore-independent function which should be used for all polled metrics.
|
||||
*
|
||||
* RRD Tags:
|
||||
* rrd_def RrdDefinition
|
||||
* rrd_name array|string: the rrd filename, will be processed with rrd_name()
|
||||
* rrd_oldname array|string: old rrd filename to rename, will be processed with rrd_name()
|
||||
* rrd_step int: rrd step, defaults to 300
|
||||
*
|
||||
* @param array $device
|
||||
* @param string $measurement Name of this measurement
|
||||
* @param array $tags tags for the data (or to control rrdtool)
|
||||
* @param array|mixed $fields The data to update in an associative array, the order must be consistent with rrd_def,
|
||||
* single values are allowed and will be paired with $measurement
|
||||
*/
|
||||
public function put($device, $measurement, $tags, $fields);
|
||||
}
|
@@ -25,7 +25,7 @@
|
||||
|
||||
namespace LibreNMS\Interfaces\Data;
|
||||
|
||||
interface Datastore
|
||||
interface Datastore extends DataStorageInterface
|
||||
{
|
||||
/**
|
||||
* Check if this is enabled by the configuration
|
||||
@@ -54,21 +54,4 @@ interface Datastore
|
||||
* @return array
|
||||
*/
|
||||
public function getStats();
|
||||
|
||||
/**
|
||||
* Datastore-independent function which should be used for all polled metrics.
|
||||
*
|
||||
* RRD Tags:
|
||||
* rrd_def RrdDefinition
|
||||
* rrd_name array|string: the rrd filename, will be processed with rrd_name()
|
||||
* rrd_oldname array|string: old rrd filename to rename, will be processed with rrd_name()
|
||||
* rrd_step int: rrd step, defaults to 300
|
||||
*
|
||||
* @param array $device
|
||||
* @param string $measurement Name of this measurement
|
||||
* @param array $tags tags for the data (or to control rrdtool)
|
||||
* @param array|mixed $fields The data to update in an associative array, the order must be consistent with rrd_def,
|
||||
* single values are allowed and will be paired with $measurement
|
||||
*/
|
||||
public function put($device, $measurement, $tags, $fields);
|
||||
}
|
||||
|
@@ -26,7 +26,9 @@
|
||||
namespace LibreNMS\Interfaces;
|
||||
|
||||
use App\Models\Device;
|
||||
use LibreNMS\Interfaces\Data\DataStorageInterface;
|
||||
use LibreNMS\OS;
|
||||
use LibreNMS\Polling\ModuleStatus;
|
||||
|
||||
interface Module
|
||||
{
|
||||
@@ -35,6 +37,16 @@ interface Module
|
||||
*/
|
||||
public function dependencies(): array;
|
||||
|
||||
/**
|
||||
* Should this module be run?
|
||||
*/
|
||||
public function shouldDiscover(OS $os, ModuleStatus $status): bool;
|
||||
|
||||
/**
|
||||
* Should polling run for this device?
|
||||
*/
|
||||
public function shouldPoll(OS $os, ModuleStatus $status): bool;
|
||||
|
||||
/**
|
||||
* Discover this module. Heavier processes can be run here
|
||||
* Run infrequently (default 4 times a day)
|
||||
@@ -49,8 +61,9 @@ interface Module
|
||||
* Run frequently (default every 5 minutes)
|
||||
*
|
||||
* @param \LibreNMS\OS $os
|
||||
* @param \LibreNMS\Interfaces\Data\DataStorageInterface $datastore
|
||||
*/
|
||||
public function poll(OS $os): void;
|
||||
public function poll(OS $os, DataStorageInterface $datastore): void;
|
||||
|
||||
/**
|
||||
* Remove all DB data for this module.
|
||||
|
@@ -25,11 +25,13 @@
|
||||
|
||||
namespace LibreNMS\Interfaces\Polling;
|
||||
|
||||
use LibreNMS\Interfaces\Data\DataStorageInterface;
|
||||
|
||||
interface OSPolling
|
||||
{
|
||||
/**
|
||||
* Poll additional OS data.
|
||||
* Data must be manually saved within this method.
|
||||
*/
|
||||
public function pollOS(): void;
|
||||
public function pollOS(DataStorageInterface $datastore): void;
|
||||
}
|
||||
|
Reference in New Issue
Block a user