mirror of
https://github.com/librenms/librenms.git
synced 2024-09-21 18:38:25 +00:00
d1b7004fef
* Severity Enum Replace old Alert constants * Fix whitespace * Additional uses * style fixes * Fix test too * More missed locations * More
99 lines
3.1 KiB
PHP
99 lines
3.1 KiB
PHP
<?php
|
|
/**
|
|
* Eventlog.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 2018 Tony Murray
|
|
* @author Tony Murray <murraytony@gmail.com>
|
|
*/
|
|
|
|
namespace App\Models;
|
|
|
|
use Carbon\Carbon;
|
|
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
|
use Illuminate\Support\Facades\Auth;
|
|
use LibreNMS\Enum\Severity;
|
|
|
|
class Eventlog extends DeviceRelatedModel
|
|
{
|
|
protected $table = 'eventlog';
|
|
protected $primaryKey = 'event_id';
|
|
public $timestamps = false;
|
|
protected $fillable = ['datetime', 'device_id', 'message', 'type', 'reference', 'username', 'severity'];
|
|
protected $casts = [
|
|
'severity' => Severity::class,
|
|
];
|
|
|
|
// ---- Helper Functions ----
|
|
/**
|
|
* This is used to be able to mock _log()
|
|
*
|
|
* @see _log()
|
|
*
|
|
* @param string $text message describing the event
|
|
* @param Device|int|null $device related device
|
|
* @param string $type brief category for this event. Examples: sensor, state, stp, system, temperature, interface
|
|
* @param Severity $severity 1: ok, 2: info, 3: notice, 4: warning, 5: critical, 0: unknown
|
|
* @param int|string|null $reference the id of the referenced entity. Supported types: interface
|
|
*/
|
|
public static function log($text, $device = null, $type = null, Severity $severity = Severity::Info, $reference = null): void
|
|
{
|
|
$model = app()->make(Eventlog::class);
|
|
$model->_log($text, $device, $type, $severity, $reference);
|
|
}
|
|
|
|
/**
|
|
* Log events to the event table
|
|
*
|
|
* @param string $text
|
|
* @param Device|int|null $device
|
|
* @param string $type
|
|
* @param Severity $severity
|
|
* @param int|string|null $reference
|
|
*/
|
|
public function _log($text, $device = null, $type = null, Severity $severity = Severity::Info, $reference = null): void
|
|
{
|
|
$log = new static([
|
|
'reference' => $reference,
|
|
'type' => $type,
|
|
'datetime' => Carbon::now(),
|
|
'severity' => $severity,
|
|
'message' => $text,
|
|
'username' => (class_exists('\Auth') && Auth::check()) ? Auth::user()->username : '',
|
|
]);
|
|
|
|
if (is_numeric($device)) {
|
|
$log->device_id = $device;
|
|
}
|
|
|
|
if ($device instanceof Device) {
|
|
$device->eventlogs()->save($log);
|
|
} else {
|
|
$log->save();
|
|
}
|
|
}
|
|
|
|
// ---- Define Relationships ----
|
|
|
|
public function related(): MorphTo
|
|
{
|
|
return $this->morphTo('related', 'type', 'reference');
|
|
}
|
|
}
|