* Fatal: Schwerwiegende Fehler, führt normalerweise zu einem kompletten Programmabbruch (LogLevel=0)
* Error: 'Normale' Fehler (LogLevel=1)
* Warning: Warnungen (LogLevel=2)
* Notification: Notifizierung, wird benutzt um sich über bestimmte Ereignisse im System informieren zu lassen (Beschattung wurde aktiviert, oder Rasenbewässerung gestartet) (LogLevel=3)
* Information: Informationsmeldungen, zur Protokollierung von Schaltvorgängen usw. (LogLevel=4)
* Debug: Debug Meldungen (LogLevel=5)
* Communication: Protokollierung von Kommunikations Instanzen (Senden/Empfangen über RS232, Sockets, ...) (LogLevel=6)
* Trace: Sehr detailierte Meldungen, um diverse Ablauffehler zu finden (LogLevel=7)
* Test: Test Meldungen, verwende ich nur temporär um Fehler zu finden, man kann nach diesen Meldungen suchen und sie nach finden des Fehlerers wieder entfernen(LogLevel=8)
*
*
* @page outputs Unterstützte Outputs
* Es werden zur Zeit 8 verschiedene Outputs unterstützt, für jeden kann man den LogLevel spezifisch definieren:
*
*
* - SingleMsg Output: enthält die letzte LogMeldung, vorgesehen als Widget, um sofort auf einen Fehler aufmerksam gemacht zu werden (verwendung von LogLevel Error oder Warning). Anzeige der Meldung kann durch Klick auf die Meldung Quittiert/Resetet werden.
* - Html Output: Output in HTML Form zur Verwendung im WebFront, Anzahl der Messages kann konfiguriert werden
* - IPS Output: IPS interner Logging Output
* - File Output: Protokollierung in ein File, für jeden Tag wird ein neues LogFile angelegt, Anzahl der Tage kann definiert werden, danach werden die Files autom. gelöscht. Standardmäßig wird in das IPS "logs" Verzeichnis gelogged, kann aber über eine Konstante auch verändert werden.
* - Log4IPS Output: XML Protokollierung, die sich an die allgemein bekannte Form Log4Net,Log4Java usw. anlehnt. Ansehen kann man sich das File am besten mit diversen Tools (ich persönlich verwende Log4View, freie Version kann man sich auf der Homepage des Herstellers Log4View downloaden ).
* - Email Output: Bietet die Möglichkeit sich über Fehler im System per Email informieren zu lassen. Ein Sende Verzögerung kann konfiguriert werden, bei 0 wird bei jedem Fehler (wenn LogLevel auf Error) sofort gesendet, ansonsten wird die angegebene Zeit gewartet und danach alle aufgetretenen Fehler als Liste versandt. Um den Email Output verwenden zu können muß man im File "IPSLogger_Configuration.ips.php" die ID für das SMTP Device eintragen. Optional kann man auch noch 1-3 Email Adressen eingtragen, standardmäßig wird der Emfänger verwendet, der im Device angegeben ist. Vorsicht: bei Delay 0 kann man sich potenziell einen Spam-Server basteln falls man irgenwo einen Endlos-Loop mit Fehler hat ...
* - Echo Output: Echo Output, kann in der Entwicklungs Phase von Scripten genützt werden.
* - Prowl Output: Ermöglicht das Senden von Messages direkt auf das iPhone.
*
*
* @page practie Best Practice
* @section logging Logging mit Script Konstante oder FileNamen
* @code
IPSUtils_Include ("IPSLogger.inc.php", "IPSLibrary::app::core::IPSLogger");
define ("c_LogId", "MyProcedure");
// Code …
IPSLogger_Inf(c_LogId, "Schalte Licht …");
@endcode
* @code
IPSUtils_Include ("IPSLogger.inc.php", "IPSLibrary::app::core::IPSLogger");
IPSLogger_Inf(__file__, "Schalte Licht …");
@endcode
*
* @section logerrors Loggen von Fehlern
* @code
IPSUtils_Include ("IPSLogger.inc.php", "IPSLibrary::app::core::IPSLogger");
$VariableId = @IPS_GetVariableIDByName('MeineVariable', 0);
if ($VariableId==0) {
IPSLogger_Err(__file__, "Variable mit Namen 'MeineVariable' konnte nicht gefunden werden");
exit; // Abbruch der aktuellen Verarbeitung
}
@endcode
*
* @file IPSLogger.inc.php
* @author Andreas Brauneis
* @version
* Version 2.50.1, 31.01.2012
*
*/
global $_IPS;
if (!array_key_exists('ABORT_ON_ERROR',$_IPS)) {
$_IPS['ABORT_ON_ERROR'] = false;
}
include_once "IPSLogger_Constants.inc.php";
include_once "IPSLogger_Output.inc.php";
// ---------------------------------------------------------------------------------------------------------------------------
/** Procedure to log a Fatal Error
*
* @param $LogContext - Context of Logging (Identifier or Filename).
* @param $LogMessage - Message to be logged
*/
if (!function_exists('IPSLogger_Fat')) {
function IPSLogger_Fat($LogContext, $LogMessage) {
IPSLogger_Out(c_LogLevel_Fatal, c_LogType_Fatal, $LogContext, $LogMessage);
}
}
// ---------------------------------------------------------------------------------------------------------------------------
/** Procedure to log a Error
*
* @param $LogContext - Context of Logging (Identifier or Filename).
* @param $LogMessage - Message to be logged
*/
if (!function_exists('IPSLogger_Err')) {
function IPSLogger_Err($LogContext, $LogMessage) {
IPSLogger_Out(c_LogLevel_Error, c_LogType_Error, $LogContext, $LogMessage);
}
}
// ---------------------------------------------------------------------------------------------------------------------------
/** Procedure to log a Warning
*
* @param $LogContext - Context of Logging (Identifier or Filename).
* @param $LogMessage - Message to be logged
*/
if (!function_exists('IPSLogger_Wrn')) {
function IPSLogger_Wrn($LogContext, $LogMessage) {
IPSLogger_Out(c_LogLevel_Warning, c_LogType_Warning, $LogContext, $LogMessage);
}
}
// ---------------------------------------------------------------------------------------------------------------------------
/** Procedure to log a Notification
*
* @param $LogContext - Context of Logging (Identifier or Filename).
* @param $LogMessage - Message to be logged
* @param $Priority - Priority of Notificaton Message (0 means high priority, higher values indicates a lower priority)
*/
if (!function_exists('IPSLogger_Not')) {
function IPSLogger_Not($LogContext, $LogMessage, $Priority=0) {
IPSLogger_Out(c_LogLevel_Notification, c_LogType_Notification, $LogContext, $LogMessage, $Priority);
}
}
// ---------------------------------------------------------------------------------------------------------------------------
/** Procedure to log Informations
*
* @param $LogContext - Context of Logging (Identifier or Filename).
* @param $LogMessage - Message to be logged
*/
if (!function_exists('IPSLogger_Inf')) {
function IPSLogger_Inf($LogContext, $LogMessage) {
IPSLogger_Out(c_LogLevel_Information, c_LogType_Information, $LogContext, $LogMessage);
}
}
// ---------------------------------------------------------------------------------------------------------------------------
/** Debugging Procedure for IPS LogHandler
*
* @param $LogContext - Context of Logging (Identifier or Filename).
* @param $LogMessage - Message to be logged
*/
if (!function_exists('IPSLogger_Dbg')) {
function IPSLogger_Dbg($LogContext, $LogMessage) {
IPSLogger_Out(c_LogLevel_Debug, c_LogType_Debug, $LogContext, $LogMessage);
}
}
// ---------------------------------------------------------------------------------------------------------------------------
/** Procedure to log Communications
*
* @param $LogContext - Context of Logging (Identifier or Filename).
* @param $LogMessage - Message to be logged
*/
if (!function_exists('IPSLogger_Com')) {
function IPSLogger_Com($LogContext, $LogMessage) {
IPSLogger_Out(c_LogLevel_Communication, c_LogType_Communication, $LogContext, $LogMessage);
}
}
// ---------------------------------------------------------------------------------------------------------------------------
/** Procedure to log Test Messages
*
* @param $LogContext - Context of Logging (Identifier or Filename).
* @param $LogMessage - Message to be logged
*/
if (!function_exists('IPSLogger_Tst')) {
function IPSLogger_Tst($LogContext, $LogMessage) {
IPSLogger_Out(c_LogLevel_Test, c_LogType_Test, $LogContext, $LogMessage);
}
}
// ---------------------------------------------------------------------------------------------------------------------------
/** Procedure for Tracing Messages
*
* @param $LogContext - Context of Logging (Identifier or Filename).
* @param $LogMessage - Message to be logged
*/
if (!function_exists('IPSLogger_Trc')) {
function IPSLogger_Trc($LogContext, $LogMessage) {
IPSLogger_Out(c_LogLevel_Trace, c_LogType_Trace, $LogContext, $LogMessage);
}
}
// ---------------------------------------------------------------------------------------------------------------------------
/** Procedure to set a custom trace level for a specific logcontext
*
* @param $LogContext - Context of Logging (Identifier or Filename).
* @param $LogLevel - the level at which logging should start
*/
function IPSLogger_SetLoggingLevel($LogContext, $LogLevel) {
IPSLogger_SetContextLoggingLevel($LogContext, $LogLevel);
}
/** @}*/
?>