LogstashFormatter.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Logger\Monolog;
 
use MediaWiki\Exception\MWExceptionHandler;
 
class LogstashFormatter extends \Monolog\Formatter\LogstashFormatter {
 
    public const V0 = 0;
    public const V1 = 1;
 
    protected $reservedKeys = [
        // from LogstashFormatter
        'message', 'channel', 'level', 'type',
        // from WebProcessor
        'url', 'ip', 'http_method', 'server', 'referrer',
        // from WikiProcessor
        'host', 'wiki', 'reqId', 'mwversion',
        // from config magic
        'normalized_message',
    ];
 
    protected $version;
 
    public function __construct( string $applicationName, ?string $systemName = null,
        string $extraKey = '', string $contextKey = 'ctxt_', $version = self::V0
    ) {
        $this->version = $version;
        parent::__construct( $applicationName, $systemName, $extraKey, $contextKey );
    }
 
    public function format( array $record ): string {
        $record = \Monolog\Formatter\NormalizerFormatter::format( $record );
        if ( $this->version === self::V1 ) {
            $message = $this->formatV1( $record );
        } elseif ( $this->version === self::V0 ) {
            $message = $this->formatV0( $record );
        } else {
            $message = __METHOD__ . ' unknown version ' . $this->version;
        }
 
        return $this->toJson( $message ) . "\n";
    }
 
    protected function formatV0( array $record ) {
        if ( $this->contextKey !== '' ) {
            return $this->formatMonologV0( $record );
        }
 
        $context = !empty( $record['context'] ) ? $record['context'] : [];
        $record['context'] = [];
        $formatted = $this->formatMonologV0( $record );
 
        $formatted['@fields'] = $this->fixKeyConflicts( $formatted['@fields'], $context );
 
        return $formatted;
    }
 
    protected function formatMonologV0( array $record ) {
        if ( empty( $record['datetime'] ) ) {
            $record['datetime'] = gmdate( 'c' );
        }
        $message = [
            '@timestamp' => $record['datetime'],
            '@source' => $this->systemName,
            '@fields' => [],
        ];
        if ( isset( $record['message'] ) ) {
            $message['@message'] = $record['message'];
        }
        if ( isset( $record['channel'] ) ) {
            $message['@tags'] = [ $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->extraKey . $key] = $val;
            }
        }
        if ( !empty( $record['context'] ) ) {
            foreach ( $record['context'] as $key => $val ) {
                $message['@fields'][$this->contextKey . $key] = $val;
            }
        }
 
        return $message;
    }
 
    protected function formatV1( array $record ) {
        if ( $this->contextKey ) {
            return $this->formatMonologV1( $record );
        }
 
        $context = !empty( $record['context'] ) ? $record['context'] : [];
        $record['context'] = [];
        $formatted = $this->formatMonologV1( $record );
 
        return $this->fixKeyConflicts( $formatted, $context );
    }
 
    protected function formatMonologV1( array $record ) {
        if ( empty( $record['datetime'] ) ) {
            $record['datetime'] = gmdate( 'c' );
        }
        $message = [
            '@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'];
        }
        // level -> monolog_level is new in 2.0
        // https://github.com/Seldaek/monolog/blob/2.0.2/src/Monolog/Formatter/LogstashFormatter.php#L86-L88
        if ( isset( $record['level'] ) ) {
            $message['monolog_level'] = $record['level'];
        }
        if ( $this->applicationName ) {
            $message['type'] = $this->applicationName;
        }
        if ( !empty( $record['extra'] ) ) {
            foreach ( $record['extra'] as $key => $val ) {
                $message[$this->extraKey . $key] = $val;
            }
        }
        if ( !empty( $record['context'] ) ) {
            foreach ( $record['context'] as $key => $val ) {
                $message[$this->contextKey . $key] = $val;
            }
        }
 
        return $message;
    }
 
    protected function fixKeyConflicts( array $fields, array $context ) {
        foreach ( $context as $key => $val ) {
            if (
                in_array( $key, $this->reservedKeys, true ) &&
                isset( $fields[$key] ) && $fields[$key] !== $val
            ) {
                $fields['logstash_formatter_key_conflict'][] = $key;
                $key = 'c_' . $key;
            }
            $fields[$key] = $val;
        }
        return $fields;
    }
 
    protected function normalizeException( \Throwable $e, int $depth = 0 ) {
        $data = [
            'class' => get_class( $e ),
            'message' => $e->getMessage(),
            'code' => $e->getCode(),
            'file' => $e->getFile() . ':' . $e->getLine(),
            'trace' => MWExceptionHandler::getRedactedTraceAsString( $e ),
        ];
 
        $previous = $e->getPrevious();
        if ( $previous ) {
            $data['previous'] = $this->normalizeException( $previous );
        }
 
        return $data;
    }
}