Просмотр исходного кода

Added documentation for SyslogUdpHandler

Jesper Skovgaard Nielsen 12 лет назад
Родитель
Сommit
359480a45c
2 измененных файлов с 13 добавлено и 0 удалено
  1. 1 0
      README.mdown
  2. 12 0
      src/Monolog/Handler/SyslogUdpHandler.php

+ 1 - 0
README.mdown

@@ -132,6 +132,7 @@ Handlers
   [raven](https://packagist.org/packages/raven/raven).
 - _ZendMonitorHandler_: Logs records to the Zend Monitor present in Zend Server.
 - _NewRelicHandler_: Logs records to a [NewRelic](http://newrelic.com/) application.
+- _SyslogUdpHandler_: Logs records to a remote [Syslogd](http://www.rsyslog.com/) server.
 
 ### Logging in development
 

+ 12 - 0
src/Monolog/Handler/SyslogUdpHandler.php

@@ -14,6 +14,18 @@ namespace Monolog\Handler;
 use Monolog\Logger;
 use Monolog\Handler\SyslogUdp\UdpSocket;
 
+/**
+ * A Handler for logging to a remote syslogd server.
+ * Example usage (given you have a syslogd server on your local machine):
+ * <code>
+ * $logger = new \Monolog\Logger();
+ * $handler = new SyslogUdpHandler("local5", "127.0.0.1");
+ * $handler->setFormatter(new \Monolog\Formatter\LineFormatter());
+ * $logger->pushHandler($handler);
+ * $logger->warn("Hello from abroard!");
+ * </code>
+ */
+
 class SyslogUdpHandler extends AbstractProcessingHandler
 {
     protected $facility;