Serializes a log message to Logstash Event Format

  • see https://www.elastic.co/products/logstash
  • see https://github.com/elastic/logstash/blob/master/logstash-core/src/main/java/org/logstash/Event.java
  • author Tim Mower
CloneableInstantiable
ExtendsMonolog\Formatter\NormalizerFormatter
ImplementsMonolog\Formatter\FormatterInterface
Constants
public Monolog\Formatter\NormalizerFormatter::SIMPLE_DATE = 'Y-m-d\TH:i:sP'
Methods
public __construct(string $applicationName, ?string $systemName = NULL, string $extraKey = 'extra', string $contextKey = 'context')
 
    public Monolog\Formatter\NormalizerFormatter::addJsonEncodeOption( $option)
    public format(array $record) : string
     

    {@inheritdoc}

    public Monolog\Formatter\NormalizerFormatter::formatBatch(array $records)
     

    {@inheritdoc}

    public Monolog\Formatter\NormalizerFormatter::getMaxNormalizeDepth() : int
     

    The maximum number of normalization levels to go through

    public Monolog\Formatter\NormalizerFormatter::getMaxNormalizeItemCount() : int
     

    The maximum number of items to normalize per level

    public Monolog\Formatter\NormalizerFormatter::removeJsonEncodeOption( $option)
    public Monolog\Formatter\NormalizerFormatter::setJsonPrettyPrint(bool $enable) : self
     

    Enables json_encode pretty print.

    public Monolog\Formatter\NormalizerFormatter::setMaxNormalizeDepth(int $maxNormalizeDepth) : self
    public Monolog\Formatter\NormalizerFormatter::setMaxNormalizeItemCount(int $maxNormalizeItemCount) : self
    Properties
    protected $applicationName
     
    • var string an application name for the Logstash log message, used to fill the @type field
    protected $contextKey
     
    • var string the key for 'context' fields from the Monolog record
    protected Monolog\Formatter\NormalizerFormatter::$dateFormat
    protected $extraKey
     
    • var string the key for 'extra' fields from the Monolog record
    protected Monolog\Formatter\NormalizerFormatter::$maxNormalizeDepth
    protected Monolog\Formatter\NormalizerFormatter::$maxNormalizeItemCount
    protected $systemName
     
    • var string the name of the system for the Logstash log message, used to fill the @source field
    Methods
    protected Monolog\Formatter\NormalizerFormatter::formatDate(DateTimeInterface $date)
    protected Monolog\Formatter\NormalizerFormatter::normalize( $data, int $depth = 0)
     
    • return int|bool|string|null|array
    protected Monolog\Formatter\NormalizerFormatter::normalizeException(Throwable $e, int $depth = 0)
     
    • return array
    protected Monolog\Formatter\NormalizerFormatter::toJson( $data, bool $ignoreErrors = false) : string
     

    Return the JSON representation of a value

    • throws RuntimeException if encoding fails and errors are not ignored
    • return string if encoding fails and ignoreErrors is true 'null' is returned
    © 2020 Bruce Wells
    Search Namespaces \ Classes
    ConfigurationNumbers (0-9.) only