[jira] [Commented] (TS-4715) clean up log format documentation

["Jon Sime (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/TS-4715?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15511702#comment-15511702 ] 

Jon Sime commented on TS-4715:
------------------------------

Commit 6d2c6cb addresses almost all these points, and includes a lot of other cleanup/reorganization/additions to the Admin guide's logging chapter. It also bumps it up to a top-level chapter, instead of jamming it together with the monitoring sections into the slightly-obscuring "Event and Error Monitoring" where it used to be. There's now two separate, very simply labeled chapters: "Logging" and "Monitoring."

I'm not closing this issue from that commit because I've yet to make an exhaustive pass through the docs to make sure all log field references are actually linked (instead of just listing the field name as a bareword), and verifying that all the log fields in the proxy code are actually in the docs now. Once those two things are taken care of, this issue will be fully addressed.

> clean up log format documentation
> ---------------------------------
>
>                 Key: TS-4715
>                 URL: https://issues.apache.org/jira/browse/TS-4715
>             Project: Traffic Server
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: James Peach
>            Assignee: Jon Sime
>             Fix For: Docs
>
>
> 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.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)