Johannes Meyer
parent
872da0c699
commit
43c18261ea
|
|
@ -15,18 +15,30 @@ moduleFolder = "@icingaweb_config_path@/enabledModules"
|
|||
; modulePath = "/vagrant/modules:/usr/share/icingaweb/modules"
|
||||
|
||||
[logging]
|
||||
; General log
|
||||
enable = "1"
|
||||
enable = true
|
||||
; Writing to a Stream
|
||||
type = "stream"
|
||||
verbose = "1"
|
||||
; Write data to the following file
|
||||
target = "@icingaweb_log_path@/icingaweb.log"
|
||||
; Write data to a PHP stream
|
||||
;target = "php://output"
|
||||
|
||||
; For development and debug purposes: Logs additional (non critical) events to a
|
||||
; seperate log
|
||||
debug.enable = "1"
|
||||
debug.type = "stream"
|
||||
debug.target = "@icingaweb_log_path@/icingaweb.debug.log"
|
||||
; Writing to the System Log
|
||||
;type = "syslog"
|
||||
; Prefix all syslog messages generated with the string "Icinga Web"
|
||||
;application = "Icinga Web"
|
||||
;facility = "LOG_USER"
|
||||
|
||||
level = 1
|
||||
; The default level is WARNING, which means that only events of this level and
|
||||
; above will be tracked. Level numbers descend in order of importance where
|
||||
; ERROR (0) is the most important level and DEBUG (3) is the least important
|
||||
; level:
|
||||
;
|
||||
; ERROR = 0 - Error: error conditions
|
||||
; WARNING = 1 - Warning: warning conditions
|
||||
; INFO = 2 - Informational: informational messages
|
||||
; DEBUG = 3 - Debug: debug messages
|
||||
|
||||
; Use ini store to store preferences on local disk
|
||||
[preferences]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,23 @@
|
|||
<?php
|
||||
// {{{ICINGA_LICENSE_HEADER}}}
|
||||
// {{{ICINGA_LICENSE_HEADER}}}
|
||||
|
||||
namespace Icinga\Logger;
|
||||
|
||||
use \Zend_Config;
|
||||
|
||||
/**
|
||||
* Abstract class for writers that write messages to a log
|
||||
*/
|
||||
abstract class LogWriter
|
||||
{
|
||||
/**
|
||||
* Create a new log writer initialized with the given configuration
|
||||
*/
|
||||
abstract public function __construct(Zend_Config $config);
|
||||
|
||||
/**
|
||||
* Log a message with the given severity
|
||||
*/
|
||||
abstract public function log($severity, $message);
|
||||
}
|
||||
|
|
@ -0,0 +1,194 @@
|
|||
<?php
|
||||
// {{{ICINGA_LICENSE_HEADER}}}
|
||||
// {{{ICINGA_LICENSE_HEADER}}}
|
||||
|
||||
namespace Icinga\Logger;
|
||||
|
||||
use \Exception;
|
||||
use \Zend_Config;
|
||||
use Icinga\Exception\ConfigurationError;
|
||||
|
||||
/**
|
||||
* Singleton logger
|
||||
*/
|
||||
class Logger
|
||||
{
|
||||
/**
|
||||
* This logger's instance
|
||||
*
|
||||
* @var Logger
|
||||
*/
|
||||
protected static $instance;
|
||||
|
||||
/**
|
||||
* The log writer to use
|
||||
*
|
||||
* @var LogWriter
|
||||
*/
|
||||
protected $writer;
|
||||
|
||||
/**
|
||||
* The maximum severity to emit
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
protected $verbosity;
|
||||
|
||||
/**
|
||||
* The supported severities
|
||||
*/
|
||||
public static $ERROR = 0;
|
||||
public static $WARNING = 1;
|
||||
public static $INFO = 2;
|
||||
public static $DEBUG = 3;
|
||||
|
||||
/**
|
||||
* Create a new logger object
|
||||
*
|
||||
* @param Zend_Config $config
|
||||
*/
|
||||
public function __construct(Zend_Config $config)
|
||||
{
|
||||
$this->verbosity = $config->level;
|
||||
|
||||
if ($config->enable) {
|
||||
$this->writer = $this->getWriter($config);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new logger object
|
||||
*
|
||||
* @param Zend_Config $config
|
||||
*/
|
||||
public static function create(Zend_Config $config)
|
||||
{
|
||||
static::$instance = new static($config);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a log writer
|
||||
*
|
||||
* @param Zend_Config $config The configuration to initialize the writer with
|
||||
*
|
||||
* @return LogWriter The requested log writer
|
||||
*
|
||||
* @throws ConfigurationError In case the requested writer cannot be found
|
||||
*/
|
||||
protected function getWriter(Zend_Config $config)
|
||||
{
|
||||
$class = 'Icinga\\Logger\\Writer\\' . ucfirst(strtolower($config->type)) . 'Writer';
|
||||
if (!class_exists($class)) {
|
||||
throw new ConfigurationError('Cannot find log writer of type "' . $config->type . '"');
|
||||
}
|
||||
|
||||
return new $class($config);
|
||||
}
|
||||
|
||||
/**
|
||||
* Write a message to the log
|
||||
*
|
||||
* @param string $message The message to write
|
||||
* @param int $severity The severity to use
|
||||
*/
|
||||
public function log($message, $severity)
|
||||
{
|
||||
if ($this->writer !== null && $this->verbosity >= $severity) {
|
||||
$this->writer->log($severity, $message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a string representation of the passed arguments
|
||||
*
|
||||
* This method provides three different processing techniques:
|
||||
* - If the only passed argument is a string it is returned unchanged
|
||||
* - If the only passed argument is an exception it is formatted as follows:
|
||||
* <name> in <file>:<line> with message: <message>[ <- <name> ...]
|
||||
* - If multiple arguments are passed the first is interpreted as format-string
|
||||
* that gets substituted with the remaining ones which can be of any type
|
||||
*
|
||||
* @param array $arguments The arguments to format
|
||||
*
|
||||
* @return string The formatted result
|
||||
*/
|
||||
protected static function formatMessage(array $arguments)
|
||||
{
|
||||
if (count($arguments) === 1) {
|
||||
$message = $arguments[0];
|
||||
|
||||
if ($message instanceof Exception) {
|
||||
$messages = array();
|
||||
$error = $message;
|
||||
do {
|
||||
$messages[] = sprintf(
|
||||
'%s in %s:%d with message: %s',
|
||||
get_class($error),
|
||||
$error->getFile(),
|
||||
$error->getLine(),
|
||||
$error->getMessage()
|
||||
);
|
||||
} while ($error = $error->getPrevious());
|
||||
$message = implode(' <- ', $messages);
|
||||
}
|
||||
|
||||
return $message;
|
||||
}
|
||||
|
||||
return vsprintf(
|
||||
array_shift($arguments),
|
||||
array_map(
|
||||
function ($a) { return is_string($a) ? $a : json_encode($a); },
|
||||
$arguments
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Log a message with severity ERROR
|
||||
*
|
||||
* @param mixed $arg,... A string, exception or format-string + substitutions
|
||||
*/
|
||||
public static function error()
|
||||
{
|
||||
if (static::$instance !== null && func_num_args() > 0) {
|
||||
static::$instance->log(static::formatMessage(func_get_args()), static::$ERROR);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Log a message with severity WARNING
|
||||
*
|
||||
* @param mixed $arg,... A string, exception or format-string + substitutions
|
||||
*/
|
||||
public static function warning()
|
||||
{
|
||||
if (static::$instance !== null && func_num_args() > 0) {
|
||||
static::$instance->log(static::formatMessage(func_get_args()), static::$WARNING);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Log a message with severity INFO
|
||||
*
|
||||
* @param mixed $arg,... A string, exception or format-string + substitutions
|
||||
*/
|
||||
public static function info()
|
||||
{
|
||||
if (static::$instance !== null && func_num_args() > 0) {
|
||||
static::$instance->log(static::formatMessage(func_get_args()), static::$INFO);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Log a message with severity DEBUG
|
||||
*
|
||||
* @param mixed $arg,... A string, exception or format-string + substitutions
|
||||
*/
|
||||
public static function debug()
|
||||
{
|
||||
if (static::$instance !== null && func_num_args() > 0) {
|
||||
static::$instance->log(static::formatMessage(func_get_args()), static::$DEBUG);
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue