Details
-
Task
-
Resolution: Unresolved
-
Neutral
-
None
-
None
-
None
-
-
Empty show more show less
-
Empty show more show less
Description
Document logging features in Magnolia CMS.
- This topic is hard to find. Even seasoned Magnolia users don't necessary know about it
MAGNOLIA-3738.- Make topic more visible. Elevate "Logging" to a top level concept in overall documentation structure.
- Merge all logging related info such as audit trail under this topic. Audit trail is a use case.
- Motivation: Describe situations where logging is needed. Talk to a developer to get more ideas.
- get details on errors
- collect data on system usage
- audit user access
- debug forms and mail etc.
- Magnolia logging is based on Apache log4j, a standard Java-based logging utility
- Tools > Logging menu lets you select the classes to log and logging level
- Unique Magnolia advantage: start logging a class or change level threshold without restarting the server
- Tools > Log Viewer menu lets you view the logged data
- Alternative: Reading logs on the file system. Tell where to find them.
- Rotating logs. Explain default rotation schedule.
- Use cases. Mail module article has an example of logging mail errors.
Checklists
Acceptance criteria