[TS-4715] clean up log format documentation

• Type: Improvement
• Status: In Progress
• Priority: Major
• Resolution: Unresolved
• Fix Version/s: Docs
• Component/s: Documentation
• Assignee: Jon Sime
• Reporter: James Peach
• Created: 03/Aug/16 23:49
• Updated: 22/Sep/16 01:00

Description

While looking at the log documentation, it seemed like we could make some improvements

• Move the logging tags into a separate page. This would make it easier to find them from the index and give us an opportunity to group them by category.
• Verify that all log fields are documented. Might be helpful to have a code change or tool that lists them.
• Add logging tag anchor links. It would be helpful to be able to link to a specific logging tag like we do for records.config variables.
• All mentions of log fields should like to their definitions.
• The "Custom Field Cross-Reference" section is confusing since there is already a previous section documenting the predefined formats. We should condense this.
• The "Log Field Slicing" section should be moved to the section that describes the general log format syntax.