Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

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:

  • LogSubjects LogSubject Detail
  • Log Formating

LogSubject Detail

...

LogSubject

Identifier

Broker

b

MessageStore

ms

VirtualHost

vh(<name>)

Conection

con:<uid>(<username>@<ip>/<vhost-name>)

Channel

ch:<uid>

Queue

qu(<queueName>)

Exchange

ex(<exchangeName>)

Binding

bd(<routingKey>)

Subscription

sub:<uid>:qu(<queueName>)

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f4792ab5-f592-483f-b87d-9c94ee05034c"><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

Log Path

Example

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="aadefcb1-d6aa-488e-8d3c-978fe8e0d8b4"><ac:plain-text-body><![CDATA[

MessageStore

vh(name)/ms

[ vh(/)/ms ] ] ]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9dc27211-5fca-4b2b-aef6-65316c9eba58"><ac:plain-text-body><![CDATA[

Channel

<Connection>/ch:<uid>

[ con:1(user@127.0.0.1/)/ch:1 ] ] ]></ac:plain-text-body></ac:structured-macro><ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b8035ba7-a44e-469f-958c-02ac368322e7"><ac:plain-text-body><![CDATA[

Queue

<Virtualhost>/qu(<queueName>)

[ vh(/)/qu(testQueue) ] ] ]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b83e2ba6-53b8-47e9-891d-01623e9b7a20"><ac:plain-text-body><![CDATA[

Exchange

<Virtualhost>/ex(<exchangeName>)

[ vh(/)/ex(amq.direct) ] ] ]></ac:plain-text-body></ac:structured-macro><ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="299860d3-4971-4c5b-a8fc-7df9ca1ad6db"><ac:plain-text-body><![CDATA[

Binding

<Virtualhost>/<Exchange>/<Queue>/bd(<routingKey>)

[ vh(/)/ex(amq.direct)/qu(testQueue)/bd(testQueue) ] ] ]></ac:plain-text-body></ac:structured-macro><ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="dc166630-954b-4c35-a0ba-5910f890b9c6"><ac:plain-text-body><![CDATA[

Subscription

sub:<uid>:qu(<queue-name>)

[sub:2:qu(testQueue)] ] ]></ac:plain-text-body></ac:structured-macro><ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2e2e03ae-b4d3-43da-a7b6-bcc3935d1c3c"><ac:plain-text-body><![CDATA[

Plugin

<Entity>/pl(name[, <optional values>]*)

[pl(ACL, Consume, qu(testQueue))] ] ]></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'.

...