basis/logging/parser/parser-docs.factor

   1 USING: calendar help.markup help.syntax ;
   2 IN: logging.parser
   3
   4 HELP: parse-log
   5 { $values { "lines" "a sequence of strings" } { "entries" "a sequence of log entries" } }
   6 { $description "Parses a sequence of log entries. Malformed entries are printed out and ignore. The result is a sequence of arrays of the shape " { $snippet "{ timestamp level name>> message }" } ", where"
   7     { $list
   8         { { $snippet "timestamp" } " is a " { $link timestamp } }
   9         { { $snippet "level" } " is a log level; see " { $link "logging.levels" } }
  10         { { $snippet "word-name" } " is a string" }
  11         { { $snippet "message" } " is a string" }
  12     }
  13 } ;
  14
  15 ARTICLE: "logging.parser" "Log file parser"
  16 "The " { $vocab-link "logging.parser" } " vocabulary parses log files output by the " { $vocab-link "logging" } " vocabulary. It is used by " { $link "logging.analysis" } " and " { $vocab-link "logging.insomniac" } " to analyze logs."
  17 $nl
  18 "There is only one primary entry point:"
  19 { $subsections parse-log } ;
  20
  21 ABOUT: "logging.parser"