Files
librenms-librenms/app/Models/Eventlog.php
2021-09-10 20:09:53 +02:00

76 lines
2.4 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\Alert;
class Eventlog extends DeviceRelatedModel
{
protected $table = 'eventlog';
protected $primaryKey = 'event_id';
public $timestamps = false;
protected $fillable = ['datetime', 'device_id', 'message', 'type', 'reference', 'username', 'severity'];
// ---- Helper Functions ----
/**
* Log events to the event table
*
* @param string $text message describing the event
* @param Device $device related device
* @param string $type brief category for this event. Examples: sensor, state, stp, system, temperature, interface
* @param int $severity 1: ok, 2: info, 3: notice, 4: warning, 5: critical, 0: unknown
* @param int $reference the id of the referenced entity. Supported types: interface
*/
public static function log($text, $device = null, $type = null, $severity = Alert::INFO, $reference = null)
{
$log = new static([
'reference' => $reference,
'type' => $type,
'datetime' => Carbon::now(),
'severity' => $severity,
'message' => $text,
'username' => (class_exists('\Auth') && Auth::check()) ? Auth::user()->username : '',
]);
if ($device instanceof Device) {
$device->eventlogs()->save($log);
} else {
$log->save();
}
}
// ---- Define Relationships ----
public function related(): MorphTo
{
return $this->morphTo('related', 'type', 'reference');
}
}