[DOCU-168] Support procedures Created: 07/Jul/11  Updated: 03/Nov/15

Status: Closed
Project: Documentation
Component/s: content
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Antti Hietala Assignee: Antti Hietala
Resolution: Unresolved Votes: 1
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 Description   

Document tasks that Support commonly asks clients to do:

  • Exporting configuration
  • Configuring a debug log
  • Debugging a particular class. (How to know which class to debug? Erroring class name is usually in the error log.)
  • Where does the log write?
  • How to copy a log file to a service like pastebin.com and send a link

If Support asks to "turn on your debug log and send it", these procedures should tell you how to do exactly that.

Publish the documents under the Support section on documentation site. They need to be standardized and publicly available so Support can point users to them systematically.

Resources and existing material:

  • Support page on wiki has some procedures the. See child pages titled "Tracking..." Make them official.
  • Mail module article has a good procedure for error logging. Don't reinvent the wheel. Adapt procedure to debug logging.
  • Running Magnolia explains how to start Magnolia so that startup log is displayed in the terminal.
  • Audit trail


 Comments   
Comment by Magnolia International [ 07/Jul/11 ]
  • debug logs – either via Magnolia > Tools, or log4j.xml
  • jmx: enable jmx in setenv.sh (we provide a commented line), and use jmxterm or jconsole. (I'd tend to favor jmxterm so we can give precise copy-pastable instructions/scripts)

Some more existing material:

Comment by Ruth Stocks [ 24/Aug/11 ]

New page at - http://docuauthor.magnolia-cms.com/support/support-procedures.html

Comment by Antti Hietala [ 07/Oct/11 ]

Edited and published as Issue details. Still need to write the JMX/jconsole piece so keeping open.

Comment by Antti Hietala [ 18/Oct/11 ]

Moved all logging related material to a new top-level topic Logging. (This move was planned in Documentation site menu structure.) Documented JConsole, Jmxterm and capturing HTTP headers.

Generated at Mon Feb 12 01:06:34 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.