Serializes a log message to Logstash Event Format. More...

Inheritance diagram for Monolog\Formatter\LogstashFormatter:

Collaboration diagram for Monolog\Formatter\LogstashFormatter:

Public Member Functions

__construct ($applicationName, $systemName=null, $extraPrefix=null, $contextPrefix='ctxt_', $version=self::V0)

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...

format (array $record)

Formats a log record. More...

formatBatch (array $records)

Formats a set of log records. More...

Data Fields
const	V0 = 0

const	V1 = 1

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

Protected Member Functions
	formatV0 (array $record)

	formatV1 (array $record)

Protected Member Functions inherited from Monolog\Formatter\NormalizerFormatter
	normalize ($data)

	normalizeException ($e)

	toJson ($data, $ignoreErrors=false)
	Return the JSON representation of a value. More...

Protected Attributes
	$systemName

	$applicationName

	$extraPrefix

	$contextPrefix

	$version

Protected Attributes inherited from Monolog\Formatter\NormalizerFormatter
	$dateFormat

Detailed Description

Serializes a log message to Logstash Event Format.

See also: http://logstash.net/; https://github.com/logstash/logstash/blob/master/lib/logstash/event.rb

Author: Tim Mower timot.nosp@m.hy.m.nosp@m.ower@.nosp@m.gmai.nosp@m.l.com

Definition at line 22 of file LogstashFormatter.php.

Constructor & Destructor Documentation

◆ __construct()

Monolog\Formatter\LogstashFormatter::__construct	(	$applicationName,
		$systemName = `null`,
		$extraPrefix = `null`,
		$contextPrefix = `'ctxt_'`,
		$version = `self::V0`
	)

Parameters

string	$applicationName	the application that sends the data, used as the "type" field of logstash
string	$systemName	the system/machine name, used as the "source" field of logstash, defaults to the hostname of the machine
string	$extraPrefix	prefix for extra keys inside logstash "fields"
string	$contextPrefix	prefix for context keys inside logstash "fields", defaults to ctxt_
int	$version	the logstash format version to use, defaults to 0

Definition at line 59 of file LogstashFormatter.php.

    {
        // logstash requires a ISO 8601 format date with optional millisecond precision.
        parent::__construct('Y-m-d\TH:i:s.uP');
 
        $this->systemName = $systemName ?: gethostname();
        $this->applicationName = $applicationName;
        $this->extraPrefix = $extraPrefix;
        $this->contextPrefix = $contextPrefix;
        $this->version = $version;
    }

References Monolog\Formatter\LogstashFormatter\$applicationName, Monolog\Formatter\LogstashFormatter\$contextPrefix, Monolog\Formatter\LogstashFormatter\$extraPrefix, Monolog\Formatter\LogstashFormatter\$systemName, and Monolog\Formatter\LogstashFormatter\$version.

Member Function Documentation

◆ format()

Monolog\Formatter\LogstashFormatter::format ( array $record )

{{Formats a log record.

Parameters

array $record A record to format

Returns: mixed The formatted record

}}

Reimplemented from Monolog\Formatter\NormalizerFormatter.

Definition at line 74 of file LogstashFormatter.php.

    {
        $record = parent::format($record);
 
        if ($this->version === self::V1) {
            $message = $this->formatV1($record);
        } else {
            $message = $this->formatV0($record);
        }
 
        return $this->toJson($message) . "\n";
    }

References $message, Monolog\Formatter\LogstashFormatter\formatV0(), Monolog\Formatter\LogstashFormatter\formatV1(), and Monolog\Formatter\NormalizerFormatter\toJson().

Here is the call graph for this function:

◆ formatV0()

Monolog\Formatter\LogstashFormatter::formatV0 ( array $record )

protected

Definition at line 87 of file LogstashFormatter.php.

    {
        if (empty($record['datetime'])) {
            $record['datetime'] = gmdate('c');
        }
        $message = array(
            '@timestamp' => $record['datetime'],
            '@source' => $this->systemName,
            '@fields' => array(),
        );
        if (isset($record['message'])) {
            $message['@message'] = $record['message'];
        }
        if (isset($record['channel'])) {
            $message['@tags'] = array($record['channel']);
            $message['@fields']['channel'] = $record['channel'];
        }
        if (isset($record['level'])) {
            $message['@fields']['level'] = $record['level'];
        }
        if ($this->applicationName) {
            $message['@type'] = $this->applicationName;
        }
        if (isset($record['extra']['server'])) {
            $message['@source_host'] = $record['extra']['server'];
        }
        if (isset($record['extra']['url'])) {
            $message['@source_path'] = $record['extra']['url'];
        }
        if (!empty($record['extra'])) {
            foreach ($record['extra'] as $key => $val) {
                $message['@fields'][$this->extraPrefix . $key] = $val;
            }
        }
        if (!empty($record['context'])) {
            foreach ($record['context'] as $key => $val) {
                $message['@fields'][$this->contextPrefix . $key] = $val;
            }
        }
 
        return $message;
    }

References Monolog\Formatter\LogstashFormatter\$applicationName, $key, and $message.

Referenced by Monolog\Formatter\LogstashFormatter\format().

Here is the caller graph for this function:

◆ formatV1()

Monolog\Formatter\LogstashFormatter::formatV1 ( array $record )

protected

Definition at line 130 of file LogstashFormatter.php.

    {
        if (empty($record['datetime'])) {
            $record['datetime'] = gmdate('c');
        }
        $message = array(
            '@timestamp' => $record['datetime'],
            '@version' => 1,
            'host' => $this->systemName,
        );
        if (isset($record['message'])) {
            $message['message'] = $record['message'];
        }
        if (isset($record['channel'])) {
            $message['type'] = $record['channel'];
            $message['channel'] = $record['channel'];
        }
        if (isset($record['level_name'])) {
            $message['level'] = $record['level_name'];
        }
        if ($this->applicationName) {
            $message['type'] = $this->applicationName;
        }
        if (!empty($record['extra'])) {
            foreach ($record['extra'] as $key => $val) {
                $message[$this->extraPrefix . $key] = $val;
            }
        }
        if (!empty($record['context'])) {
            foreach ($record['context'] as $key => $val) {
                $message[$this->contextPrefix . $key] = $val;
            }
        }
 
        return $message;
    }