ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
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_')
 
 format (array $record)
 {Formats a log record.
Parameters
array$recordA 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$recordA record to format
Returns
mixed The formatted record
} More...
 
 formatBatch (array $records)
 {Formats a set of log records.
Parameters
array$recordsA set of records to format
Returns
mixed The formatted set of records
} More...
 

Protected Attributes

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

Private Attributes

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

Additional Inherited Members

- Data Fields inherited from Monolog\Formatter\NormalizerFormatter
const SIMPLE_DATE = "Y-m-d H:i:s"
 
- Protected Member Functions inherited from Monolog\Formatter\NormalizerFormatter
 normalize ($data)
 
 normalizeException (Exception $e)
 
 toJson ($data, $ignoreErrors=false)
 

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_' 
)

Member Function Documentation

◆ format()

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

{Formats a log record.

Parameters
array$recordA record to format
Returns
mixed The formatted record
}

Implements Monolog\Formatter\FormatterInterface.

Definition at line 67 of file GelfMessageFormatter.php.

References Monolog\Formatter\NormalizerFormatter\toJson().

68  {
69  $record = parent::format($record);
70 
71  if (!isset($record['datetime'], $record['message'], $record['level'])) {
72  throw new \InvalidArgumentException('The record should at least contain datetime, message and level keys, '.var_export($record, true).' given');
73  }
74 
75  $message = new Message();
76  $message
77  ->setTimestamp($record['datetime'])
78  ->setShortMessage((string) $record['message'])
79  ->setHost($this->systemName)
80  ->setLevel($this->logLevels[$record['level']]);
81 
82  if (isset($record['channel'])) {
83  $message->setFacility($record['channel']);
84  }
85  if (isset($record['extra']['line'])) {
86  $message->setLine($record['extra']['line']);
87  unset($record['extra']['line']);
88  }
89  if (isset($record['extra']['file'])) {
90  $message->setFile($record['extra']['file']);
91  unset($record['extra']['file']);
92  }
93 
94  foreach ($record['extra'] as $key => $val) {
95  $message->setAdditional($this->extraPrefix . $key, is_scalar($val) ? $val : $this->toJson($val));
96  }
97 
98  foreach ($record['context'] as $key => $val) {
99  $message->setAdditional($this->contextPrefix . $key, is_scalar($val) ? $val : $this->toJson($val));
100  }
101 
102  if (null === $message->getFile() && isset($record['context']['exception']['file'])) {
103  if (preg_match("/^(.+):([0-9]+)$/", $record['context']['exception']['file'], $matches)) {
104  $message->setFile($matches[1]);
105  $message->setLine($matches[2]);
106  }
107  }
108 
109  return $message;
110  }
+ Here is the call graph for this function:

Field Documentation

◆ $contextPrefix

Monolog\Formatter\GelfMessageFormatter::$contextPrefix
protected

◆ $extraPrefix

Monolog\Formatter\GelfMessageFormatter::$extraPrefix
protected

◆ $logLevels

Monolog\Formatter\GelfMessageFormatter::$logLevels
private
Initial value:

Translates Monolog log levels to Graylog2 log priorities.

Definition at line 43 of file GelfMessageFormatter.php.

◆ $systemName

Monolog\Formatter\GelfMessageFormatter::$systemName
protected

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