DUE TO SPAM, SIGN-UP IS DISABLED. Goto Selfserve wiki signup and request an account.
...
This design follows on from the high level design work to provide a more detailed description of the format that all logged messages will take. The design is split in to two sections:
- Entity LogSubject Detail
- Log Formating
...
LogSubject Detail
Each Entity LogSubject in the system has a format that for logging its own indentifier. When an Entity is actually logged then it must establish its full path by logging the children entities based on the logging hierarchy.
...
It is invisaged that each Model instance will have a LogSubject member variable to act as a cache for their log format.
LogSubject Identifiers
The following is the basic Entity LogSubject identifiers:
Entity LogSubject | Identifier | |
|---|---|---|
Broker | b | |
MessageStore | ms | |
VirtualHost | vh(<name>) | |
Conection | con:<uid>(<username>, <ip>, <username>@<ip>/<vhost-name>) | |
Channel | ch:<uid> | |
Queue | qu(<queueName>) | |
Exchange | ex(<exchangeName>) | |
Binding | bd(<routingKey>) | |
Subscription | sub:<uid>:qu(<queue-name>) <queueName>) | |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4f211719-6bbf-4d20-8d2e-65a85e2fb32b"><ac:plain-text-body><![CDATA[ | Plugin | pl(name[, <optional values>]*)]]></ac:plain-text-body></ac:structured-macro> |
The plugin format allows for simple identification of the plugin such as 'ACL', 'Firewall' as well as giving the plugin the option to extend its base format. This extension is to allow easy processing of the log file.
...
LogSubject Paths
Broker, VirtualHost & Connection are root identifiers which means no parent nodes need be pre-appended to the log statement.
Entity LogSubject | Log Path | Example | |
|---|---|---|---|
MessageStore | vh(name)/ms | <datetime> [ vh(/)/ms ] <Message> | |
Channel | <Connection>/ch:<uid> | <datetime> [ con:1(user, 127user@127.0.0.1, /)/ch:1 ] <Message> | |
Queue | <Virtualhost>/qu(<queueName>) | <datetime> [ vh(/)/qu(testQueue) ] <Message> | |
Exchange | <Virtualhost>/ex(<exchangeName>) | <datetime> [ vh(/)/ex(amq.direct) ] <Message> | |
Binding | <Virtualhost>/<Exchange>/<Queue>/bd(<routingKey>) | <datetime> [ vh(/)/ex(amq.direct)/qu(testQueue)/bd(testQueue) ] <Message> | |
Subscription | <Channel>/ sub:<uid>:qu(<queue-name>) | <datetime> [ consub:2:1(user, 127.0.0.1, /)/ch:1/sub:2 ] <Message> <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="16602d08-a721-4441-b8fb-350773a7022e"><ac:plain-text-body><![CDATA[qu(testQueue)] | |
Plugin | <Entity>/pl(name[, <optional values>]*) | <datetime> [ con:1(user, 127.0.0.1, /)/ch:1/pl(ACL, Consume, qu(testQueue))] <Message> | ]]></ac:plain-text-body></ac:structured-macro> |
The plugin entitiy allows for plugins to log additional details about their operation on an entity. For example as shown above an ACL plugin can log details about the attempt to consume from Queue 'testQueue'.
...
| No Format | ||
|---|---|---|
| ||
<ISO-8601 Datetime (UTC based w/ TZ)> <Logging Level> [ <LogActor> <Logging] Entity[ Detail><LogSubject> ] <Log Message><LogMessage> |
| No Format | ||
|---|---|---|
| ||
2009-06-29 13:35:10,1234 +0100 Message [ con:1(guest, 127user@127.0.0.1, /)]/[ch:2]/ [sub:1:qu(myqueue) ] Subscription Event Occcured |