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

Add php docs for log_event, small cleanups (#6141)

Browse Source 
* Add php docs for log_event, clean up eventlog_severity a bit.

* Update functions.php
This commit is contained in:
Tony Murray
2017-03-12 08:05:31 -05:00
committed by Neil Lathwood
parent e2962adac8
commit 58495a3910
2 changed files with 20 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
html/includes/functions.inc.php
View File

@@ -1408,30 +1408,24 @@ function array_to_htmljson($data)
} }
/** /**
* @param $eventlog_severity * @param int $eventlog_severity
* @return $eventlog_severity_icon * @return string $eventlog_severity_icon
*/ */
function eventlog_severity($eventlog_severity) function eventlog_severity($eventlog_severity)
{ {
switch ($eventlog_severity) { switch ($eventlog_severity) {
case 1: case 1:
return "severity-ok"; //OK return "severity-ok"; //OK
break;
case 2: case 2:
return "severity-info"; //Informational return "severity-info"; //Informational
break;
case 3: case 3:
return "severity-notice"; //Notice return "severity-notice"; //Notice
break;
case 4: case 4:
return "severity-warning"; //Warning return "severity-warning"; //Warning
break;
case 5: case 5:
return "severity-critical"; //Critical return "severity-critical"; //Critical
break;
default: default:
return "severity-unknown"; //Unknown return "severity-unknown"; //Unknown
break;
} }
} // end eventlog_severity } // end eventlog_severity

23
includes/functions.php
View File

@@ -823,23 +823,30 @@ function get_astext($asn)
} }
} }
# Use this function to write to the eventlog table /**
* Log events to the event table
*
* @param string $text message describing the event
* @param array|int $device device array or device_id
* @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
*/
function log_event($text, $device = null, $type = null, $severity = 2, $reference = null) function log_event($text, $device = null, $type = null, $severity = 2, $reference = null)
{ {
if (!is_array($device)) { if (!is_array($device)) {
$device = device_by_id_cache($device); $device = device_by_id_cache($device);
} }
$username = $_SESSION['username'] ?: ''; $insert = array('host' => ($device['device_id'] ?: 0),
'device_id' => ($device['device_id'] ?: 0),
$insert = array('host' => ($device['device_id'] ? $device['device_id'] : 0), 'reference' => ($reference ?: "NULL"),
'device_id' => ($device['device_id'] ? $device['device_id'] : 0), 'type' => ($type ?: "NULL"),
'reference' => ($reference ? $reference : "NULL"),
'type' => ($type ? $type : "NULL"),
'datetime' => array("NOW()"), 'datetime' => array("NOW()"),
'severity' => $severity, 'severity' => $severity,
'message' => $text, 'message' => $text,
'username' => $username); 'username' => $_SESSION['username'] ?: '',
);
dbInsert($insert, 'eventlog'); dbInsert($insert, 'eventlog');
} }