Monolog\Handler\CubeHandler Class Reference

Logs to Cube. More...

Inheritance diagram for Monolog\Handler\CubeHandler:

Collaboration diagram for Monolog\Handler\CubeHandler:

Public Member Functions
	__construct ($url, $level=Logger::DEBUG, $bubble=true)
	Create a Cube handler. More...
Public Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	handle (array $record)
	{Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record. Parameters array $record The record to handle Returns Boolean true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling. } More...
Public Member Functions inherited from Monolog\Handler\AbstractHandler
	__construct ($level=Logger::DEBUG, $bubble=true)
	isHandling (array $record)
	{Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record. Parameters array $record Partial log record containing only a level key Returns Boolean } More...
	handleBatch (array $records)
	{Handles a set of records at once. Parameters array $records The records to handle (an array of record arrays) } More...
	close ()
	Closes the handler. More...
	pushProcessor ($callback)
	{Adds a processor in the stack. Parameters callable $callback Returns self } More...
	popProcessor ()
	{Removes the processor on top of the stack and returns it. Returns callable } More...
	setFormatter (FormatterInterface $formatter)
	{Sets the formatter. Parameters FormatterInterface $formatter Returns self } More...
	getFormatter ()
	{Gets the formatter. Returns FormatterInterface } More...
	setLevel ($level)
	Sets minimum logging level at which this handler will be triggered. More...
	getLevel ()
	Gets minimum logging level at which this handler will be triggered. More...
	setBubble ($bubble)
	Sets the bubbling behavior. More...
	getBubble ()
	Gets the bubbling behavior. More...
	__destruct ()
	isHandling (array $record)
	Checks whether the given record will be handled by this handler. More...
	handle (array $record)
	Handles a record. More...
	handleBatch (array $records)
	Handles a set of records at once. More...
	pushProcessor ($callback)
	Adds a processor in the stack. More...
	popProcessor ()
	Removes the processor on top of the stack and returns it. More...
	setFormatter (FormatterInterface $formatter)
	Sets the formatter. More...
	getFormatter ()
	Gets the formatter. More...

Protected Member Functions
	connectUdp ()
	Establish a connection to an UDP socket. More...
	connectHttp ()
	Establish a connection to a http server. More...
	write (array $record)
	{Writes the record down to the log of the implementing handler. Parameters array $record Returns void } More...
Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	write (array $record)
	Writes the record down to the log of the implementing handler. More...
	processRecord (array $record)
	Processes a record. More...
Protected Member Functions inherited from Monolog\Handler\AbstractHandler
	getDefaultFormatter ()
	Gets the default formatter. More...

Private Member Functions
	writeUdp ($data)
	writeHttp ($data)

Private Attributes
	$udpConnection = null
	$httpConnection = null
	$scheme = null
	$host = null
	$port = null
	$acceptedSchemes = array('http', 'udp')

Additional Inherited Members
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Detailed Description

Logs to Cube.

Wan Chen kami@.nosp@m.kami.nosp@m.sama..nosp@m.me

Definition at line 22 of file CubeHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\CubeHandler::__construct	(		$url,
			$level = Logger::DEBUG,
			$bubble = true
	)

Create a Cube handler.

Exceptions

UnexpectedValueException

when given url is not a valid url. A valid url must consists of three parts : protocol://host:port Only valid protocol used by Cube are http and udp

Definition at line 38 of file CubeHandler.php.

    {
        $urlInfos = parse_url($url);
 
        if (!isset($urlInfos['scheme']) || !isset($urlInfos['host']) || !isset($urlInfos['port'])) {
            throw new \UnexpectedValueException('URL "'.$url.'" is not valid');
        }
 
        if (!in_array($urlInfos['scheme'], $this->acceptedSchemes)) {
            throw new \UnexpectedValueException(
                'Invalid protocol (' . $urlInfos['scheme']  . ').'
                . ' Valid options are ' . implode(', ', $this->acceptedSchemes));
        }
 
        $this->scheme = $urlInfos['scheme'];
        $this->host = $urlInfos['host'];
        $this->port = $urlInfos['port'];
 
        parent::__construct($level, $bubble);
    }

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\AbstractHandler\$level, and $url.

Member Function Documentation

connectHttp()

Monolog\Handler\CubeHandler::connectHttp ( )

protected

Establish a connection to a http server.

Definition at line 83 of file CubeHandler.php.

    {
        if (!extension_loaded('curl')) {
            throw new \LogicException('The curl extension is needed to use http URLs with the CubeHandler');
        }
 
        $this->httpConnection = curl_init('http://'.$this->host.':'.$this->port.'/1.0/event/put');
 
        if (!$this->httpConnection) {
            throw new \LogicException('Unable to connect to ' . $this->host . ':' . $this->port);
        }
 
        curl_setopt($this->httpConnection, CURLOPT_CUSTOMREQUEST, "POST");
        curl_setopt($this->httpConnection, CURLOPT_RETURNTRANSFER, true);
    }

Referenced by Monolog\Handler\CubeHandler\writeHttp().

Here is the caller graph for this function:

connectUdp()

Monolog\Handler\CubeHandler::connectUdp ( )

protected

Establish a connection to an UDP socket.

Exceptions

LogicException

when unable to connect to the socket

Definition at line 64 of file CubeHandler.php.

    {
        if (!extension_loaded('sockets')) {
            throw new MissingExtensionException('The sockets extension is required to use udp URLs with the CubeHandler');
        }
 
        $this->udpConnection = socket_create(AF_INET, SOCK_DGRAM, 0);
        if (!$this->udpConnection) {
            throw new \LogicException('Unable to create a socket');
        }
 
        if (!socket_connect($this->udpConnection, $this->host, $this->port)) {
            throw new \LogicException('Unable to connect to the socket at ' . $this->host . ':' . $this->port);
        }
    }

Referenced by Monolog\Handler\CubeHandler\writeUdp().

Here is the caller graph for this function:

write()

Monolog\Handler\CubeHandler::write ( array  $record )

protected

{Writes the record down to the log of the implementing handler.

Parameters

array

$record

Returns

void

}

Reimplemented from Monolog\Handler\AbstractProcessingHandler.

Definition at line 102 of file CubeHandler.php.

    {
        $date = $record['datetime'];
 
        $data = array('time' => $date->format('Y-m-d\TH:i:s.uO'));
        unset($record['datetime']);
 
        if (isset($record['context']['type'])) {
            $data['type'] = $record['context']['type'];
            unset($record['context']['type']);
        } else {
            $data['type'] = $record['channel'];
        }
 
        $data['data'] = $record['context'];
        $data['data']['level'] = $record['level'];
 
        if ($this->scheme === 'http') {
            $this->writeHttp(json_encode($data));
        } else {
            $this->writeUdp(json_encode($data));
        }
    }

References $data, Monolog\Handler\CubeHandler\writeHttp(), and Monolog\Handler\CubeHandler\writeUdp().

Here is the call graph for this function:

writeHttp()

Monolog\Handler\CubeHandler::writeHttp (   $data )

private

Definition at line 135 of file CubeHandler.php.

    {
        if (!$this->httpConnection) {
            $this->connectHttp();
        }
 
        curl_setopt($this->httpConnection, CURLOPT_POSTFIELDS, '['.$data.']');
        curl_setopt($this->httpConnection, CURLOPT_HTTPHEADER, array(
                'Content-Type: application/json',
                'Content-Length: ' . strlen('['.$data.']'))
        );
 
        Curl\Util::execute($ch, 5, false);
    }

References $data, Monolog\Handler\CubeHandler\connectHttp(), and Monolog\Handler\Curl\Util\execute().

Referenced by Monolog\Handler\CubeHandler\write().

Here is the call graph for this function:

Here is the caller graph for this function:

writeUdp()

Monolog\Handler\CubeHandler::writeUdp (   $data )

private

Definition at line 126 of file CubeHandler.php.

    {
        if (!$this->udpConnection) {
            $this->connectUdp();
        }
 
        socket_send($this->udpConnection, $data, strlen($data), 0);
    }

References $data, and Monolog\Handler\CubeHandler\connectUdp().

Referenced by Monolog\Handler\CubeHandler\write().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$acceptedSchemes

Monolog\Handler\CubeHandler::$acceptedSchemes = array('http', 'udp')

private

Definition at line 29 of file CubeHandler.php.

$host

Monolog\Handler\CubeHandler::$host = null

private

Definition at line 27 of file CubeHandler.php.

$httpConnection

Monolog\Handler\CubeHandler::$httpConnection = null

private

Definition at line 25 of file CubeHandler.php.

$port

Monolog\Handler\CubeHandler::$port = null

private

Definition at line 28 of file CubeHandler.php.

$scheme

Monolog\Handler\CubeHandler::$scheme = null

private

Definition at line 26 of file CubeHandler.php.

$udpConnection

Monolog\Handler\CubeHandler::$udpConnection = null

private

Definition at line 24 of file CubeHandler.php.

---

The documentation for this class was generated from the following file:

• Services/Logging/lib/vendor/monolog/monolog/src/Monolog/Handler/CubeHandler.php