Operational Logging - Status Update - Functional Specification

Functional Specification

This page documents the functional specification for the status updates improvement to the Java Broker.

Log Messages

This is the list of initial status messages that the broker will be configured to produce at for status logging.
These messages will be parameterised as shown and will be accesed via an interface so that we need only maintain the text in a single location. While the messages here do no show These standarised messages will also allow for easy internationalisation.
Each section includes the expected full format of a log message. So taking the Broker logging as an example an entry in the log file for the startup of a 0.6 release broker would be:

2009-07-09 15:50:20 +0100 MESSAGE BRK-1001 : Startup : Version 0.6 Build: exported

The expected format is shown at the start of each section in italics. This is then followed by the list of messages that can be logged. This formating (as fully defined here) is the reason that each log message that follows does not need to contain a lot of details. For example, when logging the creation of a Channel you would want to know more details than just the prefetch count hence when the message is logged it would look like this:

2009-07-09 15:50:20 +0100 MESSAGE [ con:1(guest@127.0.0.1/)/ch:2 ] CHN-1001 : Create : Prefetch 400

Broker
<DATETIME> MESSAGE <Message>
BRK-1001 : Startup : Version: <Version> Build: <Build>
BRK-1002 : Starting : Listening on <Transport> port <Port>
BRK-1003 : Shuting down : <Transport> port <Port>
BRK-1004 : Ready
BRK-1005 : Stopped
BRK-1006 : Using configuration : <path>
BRK-1007 : Using logging configuration : <path>

ManagementConsole
<DATETIME> MESSAGE <Message>
MNG-1001 : Startup
MNG-1002 : Starting : <service> : Listening on port <Port>
MNG-1003 : Shuting down : <service> : port <Port>
MNG-1004 : Ready
MNG-1005 : Stopped
MNG-1006 : Using SSL Keystore : <path>

VirtualHost
<DATETIME> MESSAGE [ vh:(<name>) ] <Message>
VHT-1001 : Created : <name>
VHT-1002 : Work directory : <path>
VHT-1003 : Closed

MessageStore
<DATETIME> MESSAGE [ vh:(<name>) ] <Message>
MST-1001 : Created : <name>
MST-1002 : Store location : <path>
MST-1003 : Closed : <name>
MST-1004 : Recovery Start [: <queue.name>]
MST-1005 : Recovered <count> messages for queue <queue.name>
MST-1006 : Recovery Complete [: <queue.name>]
MST-1007 : Closed

Connection
<DATETIME> MESSAGE [ con:1(guest@127.0.0.1/) ] <Message>
CON-1001 : Open : Client ID <id> : Protocol Version : <version>
CON-1002 : Close

Channel
<DATETIME> MESSAGE [ con:1(guest@127.0.0.1/)/ch:2 ] <Message>
CHN-1001 : Create : Prefetch <count>
CHN-1002 : Flowed <value>
CHN-1003 : Close

Queue
<DATETIME> MESSAGE [ con:1(guest@127.0.0.1/)/ch:2/qu(myqueue) ] <Message>
QUE-1001 : Create : [AutoDelete] [Durable|Transient] [Priority:<levels>] [Owner:<name>]
QUE-1002 : Close

Exchange
<DATETIME> MESSAGE [ con:1(guest@127.0.0.1/)/ch:2/ex(amq.direct) ] <Message>
EXH-1001 : Create : [Durable] Type:<value> Name:<value>
EXH-1002 : Close

Binding
<DATETIME> MESSAGE [ con:1(guest@127.0.0.1/)/ch:2/ex(amq.direct)/qu(myQueue)/rk(myQueue) ] <Message>
BND-1001 : Create [: Arguments : <key=value>]
BND-1002 : Close

Subscription
<DATETIME> MESSAGE [ con:1(guest@127.0.0.1/)/ch:2/sub:1:qu(myqueue) ] <Message>
SUB-1001 : Create : [Durable] [Arguments : <key=value>]
SUB-1002 : Close

Comments