Monolog\Handler\HipChatHandler Class Reference

Sends notifications through the hipchat api to a hipchat room. More...

Inheritance diagram for Monolog\Handler\HipChatHandler:

Collaboration diagram for Monolog\Handler\HipChatHandler:

Public Member Functions
	__construct ($token, $room, $name='Monolog', $notify=false, $level=Logger::CRITICAL, $bubble=true, $useSSL=true, $format='text', $host='api.hipchat.com', $version=self::API_V1)
	handleBatch (array $records)
	{Handles a set of records at once. Parameters array $records The records to handle (an array of record arrays) } More...
Public Member Functions inherited from Monolog\Handler\SocketHandler
	__construct ($connectionString, $level=Logger::DEBUG, $bubble=true)
	close ()
	We will not close a PersistentSocket instance so it can be reused in other requests. More...
	closeSocket ()
	Close socket, if open. More...
	setPersistent ($persistent)
	Set socket connection to nbe persistent. More...
	setConnectionTimeout ($seconds)
	Set connection timeout. More...
	setTimeout ($seconds)
	Set write timeout. More...
	setWritingTimeout ($seconds)
	Set writing timeout. More...
	setChunkSize ($bytes)
	Set chunk size. More...
	getConnectionString ()
	Get current connection string. More...
	isPersistent ()
	Get persistent setting. More...
	getConnectionTimeout ()
	Get current connection timeout setting. More...
	getTimeout ()
	Get current in-transfer timeout. More...
	getWritingTimeout ()
	Get current local writing timeout. More...
	getChunkSize ()
	Get current chunk size. More...
	isConnected ()
	Check to see if the socket is currently available. 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 bool 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 bool } 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 ()
	reset ()

Data Fields
const	API_V1 = 'v1'
	Use API version 1. More...
const	API_V2 = 'v2'
	Use API version v2. More...
const	MAXIMUM_NAME_LENGTH = 15
	The maximum allowed length for the name used in the "from" field. More...
const	MAXIMUM_MESSAGE_LENGTH = 9500
	The maximum allowed length for the message. More...

Protected Member Functions
	generateDataStream ($record)
	{} More...
	getAlertColor ($level)
	Assigns a color to each level of log records. More...
	write (array $record)
	{} More...
	finalizeWrite ()
	Finalizes the request by reading some bytes and then closing the socket. More...
Protected Member Functions inherited from Monolog\Handler\SocketHandler
	write (array $record)
	Connect (if necessary) and write to the socket. More...
	pfsockopen ()
	Wrapper to allow mocking. More...
	fsockopen ()
	Wrapper to allow mocking. More...
	streamSetTimeout ()
	Wrapper to allow mocking. More...
	streamSetChunkSize ()
	Wrapper to allow mocking. More...
	fwrite ($data)
	Wrapper to allow mocking. More...
	streamGetMetadata ()
	Wrapper to allow mocking. More...
	generateDataStream ($record)
	getResource ()
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
	buildContent ($record)
	Builds the body of API call. More...
	buildHeader ($content)
	Builds the header of the API Call. More...
	combineRecords ($records)
	Combines multiple records into one. More...
	validateStringLength ($str, $length)
	Validates the length of a string. More...

Private Attributes
	$token
	$room
	$name
	$notify
	$format
	$host
	$version

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

Detailed Description

Sends notifications through the hipchat api to a hipchat room.

Notes: API token - HipChat API token Room - HipChat Room Id or name, where messages are sent Name - Name used to send the message (from) notify - Should the message trigger a notification in the clients version - The API version to use (HipChatHandler::API_V1 | HipChatHandler::API_V2)

Author

Rafael Dohms rafae.nosp@m.l@do.nosp@m.h.ms

See also

https://www.hipchat.com/docs/api

Definition at line 29 of file HipChatHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\HipChatHandler::__construct	(		$token,
			$room,
			$name = 'Monolog',
			$notify = false,
			$level = Logger::CRITICAL,
			$bubble = true,
			$useSSL = true,
			$format = 'text',
			$host = 'api.hipchat.com',
			$version = self::API_V1
	)

Parameters

string	$token	HipChat API Token
string	$room	The room that should be alerted of the message (Id or Name)
string	$name	Name used in the "from" field.
bool	$notify	Trigger a notification in clients or not
int	$level	The minimum logging level at which this handler will be triggered
bool	$bubble	Whether the messages that are handled can bubble up the stack or not
bool	$useSSL	Whether to connect via SSL.
string	$format	The format of the messages (default to text, can be set to html if you have html in the messages)
string	$host	The HipChat server hostname.
string	$version	The HipChat API version (default HipChatHandler::API_V1)

Definition at line 98 of file HipChatHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\SocketHandler\$connectionString, Monolog\Handler\HipChatHandler\$format, Monolog\Handler\HipChatHandler\$host, Monolog\Handler\AbstractHandler\$level, Monolog\Handler\HipChatHandler\$name, Monolog\Handler\HipChatHandler\$notify, Monolog\Handler\HipChatHandler\$room, Monolog\Handler\HipChatHandler\$token, Monolog\Handler\HipChatHandler\$version, and Monolog\Handler\HipChatHandler\validateStringLength().

    {
        if ($version == self::API_V1 && !$this->validateStringLength($name, static::MAXIMUM_NAME_LENGTH)) {
            throw new \InvalidArgumentException('The supplied name is too long. HipChat\'s v1 API supports names up to 15 UTF-8 characters.');
        }

        $connectionString = $useSSL ? 'ssl://'.$host.':443' : $host.':80';
        parent::__construct($connectionString, $level, $bubble);

        $this->token = $token;
        $this->name = $name;
        $this->notify = $notify;
        $this->room = $room;
        $this->format = $format;
        $this->host = $host;
        $this->version = $version;
    }

Here is the call graph for this function:

Member Function Documentation

buildContent()

Monolog\Handler\HipChatHandler::buildContent (   $record )

private

Builds the body of API call.

Parameters

array

$record

Returns

string

Definition at line 135 of file HipChatHandler.php.

References Monolog\Handler\HipChatHandler\$room, Monolog\Handler\HipChatHandler\getAlertColor(), and Monolog\Handler\HipChatHandler\validateStringLength().

Referenced by Monolog\Handler\HipChatHandler\generateDataStream().

    {
        $dataArray = array(
            'notify' => $this->version == self::API_V1 ?
                ($this->notify ? 1 : 0) :
                ($this->notify ? 'true' : 'false'),
            'message' => $record['formatted'],
            'message_format' => $this->format,
            'color' => $this->getAlertColor($record['level']),
        );

        if (!$this->validateStringLength($dataArray['message'], static::MAXIMUM_MESSAGE_LENGTH)) {
            if (function_exists('mb_substr')) {
                $dataArray['message'] = mb_substr($dataArray['message'], 0, static::MAXIMUM_MESSAGE_LENGTH).' [truncated]';
            } else {
                $dataArray['message'] = substr($dataArray['message'], 0, static::MAXIMUM_MESSAGE_LENGTH).' [truncated]';
            }
        }

        // if we are using the legacy API then we need to send some additional information
        if ($this->version == self::API_V1) {
            $dataArray['room_id'] = $this->room;
        }

        // append the sender name if it is set
        // always append it if we use the v1 api (it is required in v1)
        if ($this->version == self::API_V1 || $this->name !== null) {
            $dataArray['from'] = (string) $this->name;
        }

        return http_build_query($dataArray);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildHeader()

Monolog\Handler\HipChatHandler::buildHeader (   $content )

private

Builds the header of the API Call.

Parameters

string

$content

Returns

string

Definition at line 174 of file HipChatHandler.php.

References $header, and Monolog\Handler\HipChatHandler\$room.

Referenced by Monolog\Handler\HipChatHandler\generateDataStream().

    {
        if ($this->version == self::API_V1) {
            $header = "POST /v1/rooms/message?format=json&auth_token={$this->token} HTTP/1.1\r\n";
        } else {
            // needed for rooms with special (spaces, etc) characters in the name
            $room = rawurlencode($this->room);
            $header = "POST /v2/room/{$room}/notification?auth_token={$this->token} HTTP/1.1\r\n";
        }

        $header .= "Host: {$this->host}\r\n";
        $header .= "Content-Type: application/x-www-form-urlencoded\r\n";
        $header .= "Content-Length: " . strlen($content) . "\r\n";
        $header .= "\r\n";

        return $header;
    }

Here is the caller graph for this function:

combineRecords()

Monolog\Handler\HipChatHandler::combineRecords (   $records )

private

Combines multiple records into one.

Error level of the combined record will be the highest level from the given records. Datetime will be taken from the first record.

Parameters

$records

Returns

array

Definition at line 274 of file HipChatHandler.php.

References Monolog\Handler\AbstractHandler\$level, $messages, $records, Monolog\Handler\AbstractHandler\getFormatter(), PHP_EOL, Monolog\Handler\AbstractProcessingHandler\processRecord(), and Monolog\Handler\HipChatHandler\validateStringLength().

Referenced by Monolog\Handler\HipChatHandler\handleBatch().

    {
        $batchRecord = null;
        $batchRecords = array();
        $messages = array();
        $formattedMessages = array();
        $level = 0;
        $levelName = null;
        $datetime = null;

        foreach ($records as $record) {
            $record = $this->processRecord($record);

            if ($record['level'] > $level) {
                $level = $record['level'];
                $levelName = $record['level_name'];
            }

            if (null === $datetime) {
                $datetime = $record['datetime'];
            }

            $messages[] = $record['message'];
            $messageStr = implode(PHP_EOL, $messages);
            $formattedMessages[] = $this->getFormatter()->format($record);
            $formattedMessageStr = implode('', $formattedMessages);

            $batchRecord = array(
                'message'   => $messageStr,
                'formatted' => $formattedMessageStr,
                'context'   => array(),
                'extra'     => array(),
            );

            if (!$this->validateStringLength($batchRecord['formatted'], static::MAXIMUM_MESSAGE_LENGTH)) {
                // Pop the last message and implode the remaining messages
                $lastMessage = array_pop($messages);
                $lastFormattedMessage = array_pop($formattedMessages);
                $batchRecord['message'] = implode(PHP_EOL, $messages);
                $batchRecord['formatted'] = implode('', $formattedMessages);

                $batchRecords[] = $batchRecord;
                $messages = array($lastMessage);
                $formattedMessages = array($lastFormattedMessage);

                $batchRecord = null;
            }
        }

        if (null !== $batchRecord) {
            $batchRecords[] = $batchRecord;
        }

        // Set the max level and datetime for all records
        foreach ($batchRecords as &$batchRecord) {
            $batchRecord = array_merge(
                $batchRecord,
                array(
                    'level'      => $level,
                    'level_name' => $levelName,
                    'datetime'   => $datetime,
                )
            );
        }

        return $batchRecords;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

finalizeWrite()

Monolog\Handler\HipChatHandler::finalizeWrite ( )

protected

Finalizes the request by reading some bytes and then closing the socket.

If we do not read some but close the socket too early, hipchat sometimes drops the request entirely.

Definition at line 231 of file HipChatHandler.php.

References $res, Monolog\Handler\SocketHandler\closeSocket(), and Monolog\Handler\SocketHandler\getResource().

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

    {
        $res = $this->getResource();
        if (is_resource($res)) {
            @fread($res, 2048);
        }
        $this->closeSocket();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

generateDataStream()

Monolog\Handler\HipChatHandler::generateDataStream (   $record )

protected

{}

Parameters

array

$record

Returns

string

Definition at line 122 of file HipChatHandler.php.

References Monolog\Handler\HipChatHandler\buildContent(), and Monolog\Handler\HipChatHandler\buildHeader().

    {
        $content = $this->buildContent($record);

        return $this->buildHeader($content) . $content;
    }

Here is the call graph for this function:

getAlertColor()

Monolog\Handler\HipChatHandler::getAlertColor (   $level )

protected

Assigns a color to each level of log records.

Parameters

int

$level

Returns

string

Definition at line 198 of file HipChatHandler.php.

References Monolog\Handler\AbstractHandler\$level, Monolog\Logger\DEBUG, Monolog\Logger\ERROR, Monolog\Logger\INFO, and Monolog\Logger\WARNING.

Referenced by Monolog\Handler\HipChatHandler\buildContent().

    {
        switch (true) {
            case $level >= Logger::ERROR:
                return 'red';
            case $level >= Logger::WARNING:
                return 'yellow';
            case $level >= Logger::INFO:
                return 'green';
            case $level == Logger::DEBUG:
                return 'gray';
            default:
                return 'yellow';
        }
    }

Here is the caller graph for this function:

handleBatch()

Monolog\Handler\HipChatHandler::handleBatch

(

array

$records

)

{Handles a set of records at once.

Parameters

array

$records

The records to handle (an array of record arrays)

}

Implements Monolog\Handler\HandlerInterface.

Definition at line 243 of file HipChatHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\HipChatHandler\combineRecords(), Monolog\Handler\AbstractHandler\isHandling(), and Monolog\Handler\HipChatHandler\write().

    {
        if (count($records) == 0) {
            return true;
        }

        $batchRecords = $this->combineRecords($records);

        $handled = false;
        foreach ($batchRecords as $batchRecord) {
            if ($this->isHandling($batchRecord)) {
                $this->write($batchRecord);
                $handled = true;
            }
        }

        if (!$handled) {
            return false;
        }

        return false === $this->bubble;
    }

Here is the call graph for this function:

validateStringLength()

Monolog\Handler\HipChatHandler::validateStringLength (   $str,   $length  )

private

Validates the length of a string.

If the mb_strlen() function is available, it will use that, as HipChat allows UTF-8 characters. Otherwise, it will fall back to strlen().

Note that this might cause false failures in the specific case of using a valid name with less than 16 characters, but 16 or more bytes, on a system where mb_strlen() is unavailable.

Parameters

string	$str
int	$length

Returns

bool

Definition at line 357 of file HipChatHandler.php.

Referenced by Monolog\Handler\HipChatHandler\__construct(), Monolog\Handler\HipChatHandler\buildContent(), and Monolog\Handler\HipChatHandler\combineRecords().

    {
        if (function_exists('mb_strlen')) {
            return (mb_strlen($str) <= $length);
        }

        return (strlen($str) <= $length);
    }

Here is the caller graph for this function:

write()

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

protected

{}

Parameters

array

$record

Definition at line 219 of file HipChatHandler.php.

References Monolog\Handler\HipChatHandler\finalizeWrite(), and Sabre\VObject\write().

Referenced by Monolog\Handler\HipChatHandler\handleBatch().

    {
        parent::write($record);
        $this->finalizeWrite();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$format

Monolog\Handler\HipChatHandler::$format

private

Definition at line 74 of file HipChatHandler.php.

Referenced by Monolog\Handler\HipChatHandler\__construct().

$host

Monolog\Handler\HipChatHandler::$host

private

Definition at line 79 of file HipChatHandler.php.

Referenced by Monolog\Handler\HipChatHandler\__construct().

$name

Monolog\Handler\HipChatHandler::$name

private

Definition at line 64 of file HipChatHandler.php.

Referenced by Monolog\Handler\HipChatHandler\__construct().

$notify

Monolog\Handler\HipChatHandler::$notify

private

Definition at line 69 of file HipChatHandler.php.

Referenced by Monolog\Handler\HipChatHandler\__construct().

$room

Monolog\Handler\HipChatHandler::$room

private

Definition at line 59 of file HipChatHandler.php.

Referenced by Monolog\Handler\HipChatHandler\__construct(), Monolog\Handler\HipChatHandler\buildContent(), and Monolog\Handler\HipChatHandler\buildHeader().

$token

Monolog\Handler\HipChatHandler::$token

private

Definition at line 54 of file HipChatHandler.php.

Referenced by Monolog\Handler\HipChatHandler\__construct().

$version

Monolog\Handler\HipChatHandler::$version

private

Definition at line 84 of file HipChatHandler.php.

Referenced by Monolog\Handler\HipChatHandler\__construct().

API_V1

const Monolog\Handler\HipChatHandler::API_V1 = 'v1'

Use API version 1.

Definition at line 34 of file HipChatHandler.php.

API_V2

const Monolog\Handler\HipChatHandler::API_V2 = 'v2'

Use API version v2.

Definition at line 39 of file HipChatHandler.php.

MAXIMUM_MESSAGE_LENGTH

const Monolog\Handler\HipChatHandler::MAXIMUM_MESSAGE_LENGTH = 9500

The maximum allowed length for the message.

Definition at line 49 of file HipChatHandler.php.

MAXIMUM_NAME_LENGTH

const Monolog\Handler\HipChatHandler::MAXIMUM_NAME_LENGTH = 15

The maximum allowed length for the name used in the "from" field.

Definition at line 44 of file HipChatHandler.php.

---

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

• libs/composer/vendor/monolog/monolog/src/Monolog/Handler/HipChatHandler.php