Monolog\Formatter\GelfMessageFormatter Class Reference

Serializes a log message to GELF. More...

Inheritance diagram for Monolog\Formatter\GelfMessageFormatter:

Collaboration diagram for Monolog\Formatter\GelfMessageFormatter:

Public Member Functions
	__construct ($systemName=null, $extraPrefix=null, $contextPrefix='ctxt_', $maxLength=null)
	format (array $record)
	{Formats a log record. Parameters array $record A record to format Returns mixed The formatted record } More...
Public Member Functions inherited from Monolog\Formatter\NormalizerFormatter
	__construct ($dateFormat=null)
	format (array $record)
	{Formats a log record. Parameters array $record A record to format Returns mixed The formatted record } More...
	formatBatch (array $records)
	{Formats a set of log records. Parameters array $records A set of records to format Returns mixed The formatted set of records } More...
	detectAndCleanUtf8 (&$data)
	Detect invalid UTF-8 string characters and convert to valid UTF-8. More...

Data Fields
const	DEFAULT_MAX_LENGTH = 32766
Data Fields inherited from Monolog\Formatter\NormalizerFormatter
const	SIMPLE_DATE = "Y-m-d H:i:s"

Protected Attributes
	$systemName
	$extraPrefix
	$contextPrefix
	$maxLength
Protected Attributes inherited from Monolog\Formatter\NormalizerFormatter
	$dateFormat

Private Attributes
	$logLevels
	Translates Monolog log levels to Graylog2 log priorities. More...

Additional Inherited Members
Protected Member Functions inherited from Monolog\Formatter\NormalizerFormatter
	normalize ($data, $depth=0)
	normalizeException ($e)
	toJson ($data, $ignoreErrors=false)
	Return the JSON representation of a value. More...

Detailed Description

Serializes a log message to GELF.

See also

http://www.graylog2.org/about/gelf

Author

Matt Lehner mlehn.nosp@m.er@g.nosp@m.mail..nosp@m.com

Definition at line 23 of file GelfMessageFormatter.php.

Constructor & Destructor Documentation

__construct()

Monolog\Formatter\GelfMessageFormatter::__construct	(		$systemName = null,
			$extraPrefix = null,
			$contextPrefix = 'ctxt_',
			$maxLength = null
	)

Definition at line 61 of file GelfMessageFormatter.php.

References Monolog\Formatter\GelfMessageFormatter\$contextPrefix, Monolog\Formatter\GelfMessageFormatter\$extraPrefix, Monolog\Formatter\GelfMessageFormatter\$maxLength, and Monolog\Formatter\GelfMessageFormatter\$systemName.

    {
        parent::__construct('U.u');

        $this->systemName = $systemName ?: gethostname();

        $this->extraPrefix = $extraPrefix;
        $this->contextPrefix = $contextPrefix;
        $this->maxLength = is_null($maxLength) ? self::DEFAULT_MAX_LENGTH : $maxLength;
    }

Member Function Documentation

format()

Monolog\Formatter\GelfMessageFormatter::format

(

array

$record

)

{Formats a log record.

Parameters

array

$record

A record to format

Returns

mixed The formatted record

}

Implements Monolog\Formatter\FormatterInterface.

Definition at line 75 of file GelfMessageFormatter.php.

References $key, $message, and Monolog\Formatter\NormalizerFormatter\toJson().

    {
        $record = parent::format($record);

        if (!isset($record['datetime'], $record['message'], $record['level'])) {
            throw new \InvalidArgumentException('The record should at least contain datetime, message and level keys, '.var_export($record, true).' given');
        }

        $message = new Message();
        $message
            ->setTimestamp($record['datetime'])
            ->setShortMessage((string) $record['message'])
            ->setHost($this->systemName)
            ->setLevel($this->logLevels[$record['level']]);

        // message length + system name length + 200 for padding / metadata 
        $len = 200 + strlen((string) $record['message']) + strlen($this->systemName);

        if ($len > $this->maxLength) {
            $message->setShortMessage(substr($record['message'], 0, $this->maxLength));
        }

        if (isset($record['channel'])) {
            $message->setFacility($record['channel']);
        }
        if (isset($record['extra']['line'])) {
            $message->setLine($record['extra']['line']);
            unset($record['extra']['line']);
        }
        if (isset($record['extra']['file'])) {
            $message->setFile($record['extra']['file']);
            unset($record['extra']['file']);
        }

        foreach ($record['extra'] as $key => $val) {
            $val = is_scalar($val) || null === $val ? $val : $this->toJson($val);
            $len = strlen($this->extraPrefix . $key . $val);
            if ($len > $this->maxLength) {
                $message->setAdditional($this->extraPrefix . $key, substr($val, 0, $this->maxLength));
                break;
            }
            $message->setAdditional($this->extraPrefix . $key, $val);
        }

        foreach ($record['context'] as $key => $val) {
            $val = is_scalar($val) || null === $val ? $val : $this->toJson($val);
            $len = strlen($this->contextPrefix . $key . $val);
            if ($len > $this->maxLength) {
                $message->setAdditional($this->contextPrefix . $key, substr($val, 0, $this->maxLength));
                break;
            }
            $message->setAdditional($this->contextPrefix . $key, $val);
        }

        if (null === $message->getFile() && isset($record['context']['exception']['file'])) {
            if (preg_match("/^(.+):([0-9]+)$/", $record['context']['exception']['file'], $matches)) {
                $message->setFile($matches[1]);
                $message->setLine($matches[2]);
            }
        }

        return $message;
    }

Here is the call graph for this function:

Field Documentation

$contextPrefix

Monolog\Formatter\GelfMessageFormatter::$contextPrefix

protected

Definition at line 40 of file GelfMessageFormatter.php.

Referenced by Monolog\Formatter\GelfMessageFormatter\__construct().

$extraPrefix

Monolog\Formatter\GelfMessageFormatter::$extraPrefix

protected

Definition at line 35 of file GelfMessageFormatter.php.

Referenced by Monolog\Formatter\GelfMessageFormatter\__construct().

$logLevels

Monolog\Formatter\GelfMessageFormatter::$logLevels

private

Initial value:

= array(
        Logger::DEBUG     => 7,
        Logger::INFO      => 6,
        Logger::NOTICE    => 5,
        Logger::WARNING   => 4,
        Logger::ERROR     => 3,
        Logger::CRITICAL  => 2,
        Logger::ALERT     => 1,
        Logger::EMERGENCY => 0,
    )

Translates Monolog log levels to Graylog2 log priorities.

Definition at line 50 of file GelfMessageFormatter.php.

$maxLength

Monolog\Formatter\GelfMessageFormatter::$maxLength

protected

Definition at line 45 of file GelfMessageFormatter.php.

Referenced by Monolog\Formatter\GelfMessageFormatter\__construct().

$systemName

Monolog\Formatter\GelfMessageFormatter::$systemName

protected

Definition at line 30 of file GelfMessageFormatter.php.

Referenced by Monolog\Formatter\GelfMessageFormatter\__construct().

DEFAULT_MAX_LENGTH

const Monolog\Formatter\GelfMessageFormatter::DEFAULT_MAX_LENGTH = 32766

Definition at line 25 of file GelfMessageFormatter.php.

---

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

• libs/composer/vendor/monolog/monolog/src/Monolog/Formatter/GelfMessageFormatter.php