mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #11776 from TheGreatDoc/ups-traps

Browse Source 
Added UPS-MIB Trap On Battery (upsTraps.0.1)
This commit is contained in:
Tony Murray
2020-06-14 16:41:42 -05:00
committed by GitHub
parent 9bf91f7153 267a9900d0
commit 240b84aa3f
5 changed files with 156 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
LibreNMS/Snmptrap/Handlers/UpsTrapsOnBattery.php Normal file
View File

@@ -0,0 +1,72 @@
<?php
/**
* UpsTrapsOnBattery.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 <http://www.gnu.org/licenses/>.
*
* @package LibreNMS
* @link http://librenms.org
* @author TheGreatDoc
*/
namespace LibreNMS\Snmptrap\Handlers;
use App\Models\Device;
use LibreNMS\Interfaces\SnmptrapHandler;
use LibreNMS\Snmptrap\Trap;
use Log;
use Illuminate\Support\Str;
class UpsTrapsOnBattery implements SnmptrapHandler
{
/**
* Handle snmptrap.
* Data is pre-parsed and delivered as a Trap.
*
* @param Device $device
* @param Trap $trap
* @return void
*/
public function handle(Device $device, Trap $trap)
{
$min_remaining = Str::before($trap->getOidData($trap->findOid('UPS-MIB::upsEstimatedMinutesRemaining.0')), ' ');
$sec_time = Str::before($trap->getOidData($trap->findOid('UPS-MIB::upsSecondsOnBattery.0')), ' ');
Log::event("UPS running on battery for $sec_time seconds. Estimated $min_remaining minutes remaining", $device->device_id, 'trap', 5);
$sensor_remaining = $device->sensors()->where('sensor_index', '200')->where('sensor_type', 'rfc1628')->first();
if (!$sensor_remaining) {
Log::warning("Snmptrap UpsTraps: Could not find matching sensor \'Estimated battery time remaining\' for device: " . $device->hostname);
return;
}
$sensor_remaining->sensor_current = $min_remaining / $sensor_remaining->sensor_divisor;
$sensor_remaining->save();
$sensor_time = $device->sensors()->where('sensor_index', '100')->where('sensor_type', 'rfc1628')->first();
if (!$sensor_time) {
Log::warning("Snmptrap UpsTraps: Could not find matching sensor \'Time on battery\' for device: " . $device->hostname);
return;
}
$sensor_time->sensor_current = $sec_time / $sensor_time->sensor_divisor;
$sensor_time->save();
$sensor_output = $device->sensors()->where('sensor_type', 'upsOutputSourceState')->first();
if (!$sensor_output) {
Log::warning("Snmptrap UpsTraps: Could not find matching sensor \'upsOutputSourceState\' for device: " . $device->hostname);
return;
}
$sensor_output->sensor_current = 5;
$sensor_output->save();
}
}

9
app/Providers/SnmptrapProvider.php
View File

@@ -25,12 +25,9 @@ class SnmptrapProvider extends ServiceProvider
*/
public function register()
{
$this->app->bind(SnmptrapHandler::class, function ($app, $oid) {
if ($handler = config('snmptraps.trap_handlers.' . reset($oid))) {
return $app->make($handler);
}
return $app->make(Fallback::class);
$this->app->bind(SnmptrapHandler::class, function ($app, $options) {
$oid = reset($options);
return $app->make(config('snmptraps.trap_handlers')[$oid] ?? Fallback::class);
});
}
}

1
config/snmptraps.php
View File

@@ -101,5 +101,6 @@ return [
'VMWARE-VMINFO-MIB::vmwVmSuspended' => \LibreNMS\Snmptrap\Handlers\VmwVmSuspended::class,
'OSPF-TRAP-MIB::ospfIfStateChange' => \LibreNMS\Snmptrap\Handlers\OspfIfStateChange::class,
'OSPF-TRAP-MIB::ospfNbrStateChange' => \LibreNMS\Snmptrap\Handlers\OspfNbrStateChange::class,
'UPS-MIB::upsTraps.0.1' => \LibreNMS\Snmptrap\Handlers\UpsTrapsOnBattery::class,
]
];

10
database/factories/ModelFactory.php
View File

@@ -164,3 +164,13 @@ $factory->define(\App\Models\Component::class, function (Faker\Generator $faker)
'type' => $faker->regexify('[A-Za-z0-9]{4,20}'),
];
});
$factory->define(\App\Models\Sensor::class, function (Faker\Generator $faker) {
$sensor_class = ['airflow','ber','charge','chromatic_dispersion','cooling','count','current','dbm','delay','eer','fanspeed','frequency','humidity','load','loss','power','power_consumed','power_factor','pressure','quality_factor','runtime','signal','snr','state','temperature','voltage','waterflow'];
$sensor_oid = ".1.3.6.1.4.1.4115.1.4.3.3." . $faker->numberBetween(0, 10) . "." . $faker->numberBetween(0, 10) . "." . $faker->numberBetween(0, 10);
return [
'sensor_index' => $faker->randomDigit,
'sensor_class' => $faker->randomElement($sensor_class),
'sensor_current' => $faker->randomDigit,
'sensor_oid' => $sensor_oid,
];
});

70
tests/Feature/SnmpTraps/UpsTrapsOnBatteryTest.php Normal file
View File

@@ -0,0 +1,70 @@
<?php
/**
* UpsTrapsOnBatteryTest.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 <http://www.gnu.org/licenses/>.
*
* @package LibreNMS
* @link http://librenms.org
* @author TheGreatDoc
*/
namespace LibreNMS\Tests\Feature\SnmpTraps;
use App\Models\Device;
use App\Models\Sensor;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use LibreNMS\Snmptrap\Dispatcher;
use LibreNMS\Snmptrap\Trap;
class UpsTrapsOnBatteryTest extends SnmpTrapTestCase
{
public function testOnBattery()
{
$device = factory(Device::class)->create();
$state = factory(Sensor::class)->make(['sensor_class' => 'state', 'sensor_type' => 'upsOutputSourceState', 'sensor_current' => '2']);
$time = factory(Sensor::class)->make(['sensor_class' => 'runtime', 'sensor_index' => '100', 'sensor_type' => 'rfc1628', 'sensor_current' => '0']);
$remaining = factory(Sensor::class)->make(['sensor_class' => 'runtime', 'sensor_index' => '200', 'sensor_type' => 'rfc1628', 'sensor_current' => '371']);
$device->sensors()->save($state);
$device->sensors()->save($time);
$device->sensors()->save($remaining);
$trapText = "$device->hostname
UDP: [$device->ip]:161->[192.168.5.5]:162
DISMAN-EVENT-MIB::sysUpTimeInstance 9:22:15:00.01
SNMPv2-MIB::snmpTrapOID.0 UPS-MIB::upsTraps.0.1
UPS-MIB::upsEstimatedMinutesRemaining.0 100 minutes
UPS-MIB::upsSecondsOnBattery.0 120 seconds
UPS-MIB::upsConfigLowBattTime.0 1 minutes";
\Log::shouldReceive('warning')->never()->with("Snmptrap UpsTraps: Could not find matching sensor \'Estimated battery time remaining\' for device: " . $device->hostname);
\Log::shouldReceive('warning')->never()->with("Snmptrap UpsTraps: Could not find matching sensor \'Time on battery\' for device: " . $device->hostname);
\Log::shouldReceive('warning')->never()->with("Snmptrap UpsTraps: Could not find matching sensor \'upsOutputSourceState\' for device: " . $device->hostname);
$message = "UPS running on battery for 120 seconds. Estimated 100 minutes remaining";
\Log::shouldReceive('event')->once()->with($message, $device->device_id, 'trap', 5);
$trap = new Trap($trapText);
$this->assertTrue(Dispatcher::handle($trap), 'Could not handle UPS-MIB::upsTraps.0.1 trap');
$state = $state->fresh();
$time = $time->fresh();
$remaining = $remaining->fresh();
$this->assertEquals($state->sensor_current, '5');
$this->assertEquals($time->sensor_current, '120');
$this->assertEquals($remaining->sensor_current, '100');
}
}