[
https://issues.apache.org/jira/browse/QPID-6801?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14967336#comment-14967336
]
Lorenz Quack commented on QPID-6801:
------------------------------------
Good work, Keith. This was some writing and I think you captures all the new
functionality and put the emphasis on the right things.
However, I do have some review comments:
* In Java-Broker-Concepts-Overview.xml you are missing half a sentence.
* In Java-Broker-Concepts-Virtualhosts.xml "...is responsible for producing
log..." should be either "a log" or "logs"
* In Java-Broker-Management-Channel-REST-API.xml
** It seems silly that we list all APIs twice. once for "<version>" and once
for "latest" I consider "latest" to be a special case of "<version>" and I
think the introduction on that page supports that.
** There is a typo: "implementatiions"
* In Java-Broker-Runtime-Log-Files.xml
** In section "Java-Broker-Runtime-Logging" there is a typo in the last
sentence "and how they -many- +may+ be configured."
** In section "Java-Broker-Runtime-Logging-Default-Configuration" the part
about the memory logger seems to imply that warnings and errors from
dependencies are not logged which is incorrect. By default the memory logger
logs the same things the file logger does.
** In section "Java-Broker-Runtime-Logging-Loggers"
*** The first sentence of the second paragraph is grammatically incorrect.
*** The last sentence of the second paragraph is grammatically incorrect.
*** The third paragraph is hard to parse. In the fourth paragraph the "logger"
is missing its plural "s"
** In section "Java-Broker-Runtime-Logging-Loggers-FileLogger" in the last
sentence of the second paragraph "...the number of *days logs* that will be
retained" does not seem correct.
** In section "Java-Broker-Runtime-Logging-Loggers-MemoryLogger" there is an
superfluous ">" at the end
** In section "Java-Broker-Runtime-Logging-InclusionRules"
*** it mentions logger name. we decided that this might cause to much confusion
and relabeled the field to "Log Event Source Name" as can be seen from your
screenshot. Unfortunately, the header of the LogInclusionRule table was missed
in the relabeling. This should probably be fixed.
*** All that punctuation in the given examples are hard to distinguish from the
rest of the sentence punctuation. Maybe surrounding the examples in quotation
mark helps (maybe it will be even worse).
*** "It may take -a- one of the following value"
*** The screenshots seem to suggest that "ALL" and "OFF" are also a valid log
levels while "FATAL" is not.
** In section "Java-Broker-Runtime-Logging-Management"
*** In the list you do not use the oxford comma. It is not really ambiguous
here but my impression was that in general we do use it.
*** "The figure that follows shows -the- a FileLogger."
*** "The inclusion rule -tables- +table+ shows..."
*** "The area towards the bottom of the tab -allow- +allows+ the log files..."
*** The screenshots are very large. I have to scroll right.
*** FYI, You expose your file system layout in the screenshots (Logger
attributes and memory logger).
** Capitalisation of Virtualhost (or virtualhost) and other Qpid entities is
inconsistent
> Documentation for new Broker's new Logging sub-system
> -----------------------------------------------------
>
> Key: QPID-6801
> URL: https://issues.apache.org/jira/browse/QPID-6801
> Project: Qpid
> Issue Type: Improvement
> Components: Documentation, Java Broker
> Reporter: Keith Wall
> Assignee: Keith Wall
> Fix For: qpid-java-6.0
>
>
> Update logging with respect to the new Logging subsystem introduced by
> QPID-6533.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
