wiki.techinc.nl/includes/debug/logger/monolog/CeeFormatter.php
Timo Tijhof 9cb8bb611b debug: Improve docs, fix ingroup tags, clean up tests
* Remove redundant file-level description and ensure the class desc
  and ingroup tag are on the class block instead.
  Ref https://gerrit.wikimedia.org/r/q/owner:Krinkle+message:ingroup

* Widen `@covers` annotations in unit tests.
  Ref https://gerrit.wikimedia.org/r/q/owner:krinkle+is:merged+message:covers

* Create "Debug" documentation group, covering the debug/ directory.
  This will show up on doc.wikimedia.org under "Modules", where
  each class is listed, and the class page will also link back to
  the group as part of its breadcrumb navigation.

  Test with `php maintenance/mwdocgen.php --file docs/,includes/debug/`
  and then view /w/docs/html/

* Improve docs of various classes and explain relationships better.
  In particular, reformat to ensure each class has a oneline
  description that captures its essential function.

Change-Id: I5d1143a9244b7fd888e1dc31f0fd7965272aa900
2023-10-05 11:54:30 +00:00

24 lines
580 B
PHP

<?php
namespace MediaWiki\Logger\Monolog;
/**
* Prefixed version of LogstashFormatter that adds a "cee cookie" for Rsyslog.
*
* The prefix lets Ryslog differentiate between JSON and non-JSON messages.
*
* See also: https://www.rsyslog.com/doc/v8-stable/configuration/modules/mmjsonparse.html
*
* @since 1.33
* @ingroup Debug
*/
class CeeFormatter extends LogstashFormatter {
/**
* Format records with a cee cookie
* @param array $record
* @return string
*/
public function format( array $record ): string {
return "@cee: " . parent::format( $record );
}
}