basis/logging/insomniac/insomniac-docs.factor

   1 USING: help.markup help.syntax assocs strings logging
   2 logging.analysis smtp ;
   3 IN: logging.insomniac
   4
   5 HELP: insomniac-sender
   6 { $var-description "The originating e-mail address for mailing log reports. Must be set before " { $vocab-link "logging.insomniac" } " is used." } ;
   7
   8 HELP: insomniac-recipients
   9 { $var-description "A sequence of e-mail addresses to mail log reports to. Must be set before " { $vocab-link "logging.insomniac" } " is used." } ;
  10
  11 HELP: ?analyze-log
  12 { $values { "service" "a log service name" } { "word-names" "a sequence of strings" } { "string/f" string } }
  13 { $description "Analyzes the most recent log and outputs the string analysis, or outputs " { $link f } " if it doesn't exist." }
  14 { $see-also analyze-log } ;
  15
  16 HELP: email-log-report
  17 { $values { "service" "a log service name" } { "word-names" "a sequence of strings" } }
  18 { $description "E-mails a log report for the given log service. The " { $link insomniac-sender } " and " { $link insomniac-recipients } " parameters must be set up first. The " { $snippet "word-names" } " parameter is documented in " { $link analyze-entries } "." } ;
  19
  20 HELP: schedule-insomniac
  21 { $values { "service" "a log service name" } { "word-names" "a sequence of strings" } }
  22 { $description "Starts a thread which e-mails log reports and rotates logs daily." } ;
  23
  24 ARTICLE: "logging.insomniac" "Automated log analysis"
  25 "The " { $vocab-link "logging.insomniac" } " vocabulary builds on the " { $vocab-link "logging.analysis" } " vocabulary. It provides support for e-mailing log reports and rotating logs on a daily basis. E-mails are sent using the " { $vocab-link "smtp" } " vocabulary."
  26 $nl
  27 "Required configuration parameters:"
  28 { $subsection insomniac-sender }
  29 { $subsection insomniac-recipients }
  30 "E-mailing a one-off report:"
  31 { $subsection email-log-report }
  32 "E-mailing reports and rotating logs on a daily basis:"
  33 { $subsection schedule-insomniac } ;
  34
  35 ABOUT: "logging.insomniac"