Package org.apache.activemq.artemis.core.server.plugin.impl

Class LoggingActiveMQServerPlugin

java.lang.Object

org.apache.activemq.artemis.core.server.plugin.impl.LoggingActiveMQServerPlugin

All Implemented Interfaces:

Serializable, ActiveMQServerAddressPlugin, ActiveMQServerBasePlugin, ActiveMQServerBindingPlugin, ActiveMQServerBridgePlugin, ActiveMQServerConnectionPlugin, ActiveMQServerConsumerPlugin, ActiveMQServerCriticalPlugin, ActiveMQServerFederationPlugin, ActiveMQServerMessagePlugin, ActiveMQServerPlugin, ActiveMQServerQueuePlugin, ActiveMQServerResourcePlugin, ActiveMQServerSessionPlugin

public class LoggingActiveMQServerPlugin
extends Object
implements ActiveMQServerPlugin, Serializable

plugin to log various events within the broker, configured with the following booleans:

• LOG_CONNECTION_EVENTS - connections creation/destroy
• LOG_SESSION_EVENTS - sessions creation/close
• LOG_CONSUMER_EVENTS - consumers creation/close
• LOG_DELIVERING_EVENTS - messages delivered to consumer, acked by consumer
• LOG_SENDING_EVENTS - messaged is sent, message is routed
• LOG_INTERNAL_EVENTS - critical failures, bridge deployments, queue creation/destroyed, message expired

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOG_ALL_EVENTS
static final String	LOG_CONNECTION_EVENTS
static final String	LOG_CONSUMER_EVENTS
static final String	LOG_DELIVERING_EVENTS
static final String	LOG_INTERNAL_EVENTS
static final String	LOG_SENDING_EVENTS
static final String	LOG_SESSION_EVENTS
static final String	UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
LoggingActiveMQServerPlugin()

Method Summary

Modifier and Type	Method	Description
void	afterCloseConsumer(ServerConsumer consumer, boolean failed)	After a consumer is closed
void	afterCloseSession(ServerSession session, boolean failed)	After a session is closed
void	afterCreateConnection(RemotingConnection connection)	A connection has been created.
void	afterCreateConsumer(ServerConsumer consumer)	After a consumer has been created
void	afterCreateQueue(Queue queue)	After a queue has been created
void	afterCreateSession(ServerSession session)	After a session has been created.
void	afterDeliver(ServerConsumer consumer, MessageReference reference)	After a message is delivered to a client consumer
void	afterDeployBridge(Bridge bridge)	After a bridge has been deployed
void	afterDestroyConnection(RemotingConnection connection)	A connection has been destroyed.
void	afterDestroyQueue(Queue queue, SimpleString address, SecurityAuth session, boolean checkConsumerCount, boolean removeConsumers, boolean autoDeleteAddress)	After a queue has been destroyed
void	afterMessageRoute(Message message, RoutingContext context, boolean direct, boolean rejectDuplicates, RoutingStatus result)	After a message is routed
void	afterSend(ServerSession session, Transaction tx, Message message, boolean direct, boolean noAutoCreateQueue, RoutingStatus result)	After a message is sent
void	afterSessionMetadataAdded(ServerSession session, String key, String data)	After session metadata is added to the session
void	beforeCloseConsumer(ServerConsumer consumer, boolean failed)	Before a consumer is closed
void	beforeCloseSession(ServerSession session, boolean failed)	Before a session is closed
void	beforeCreateConsumer(long consumerID, QueueBinding queueBinding, SimpleString filterString, boolean browseOnly, boolean supportLargeMessage)	Before a consumer is created
void	beforeCreateQueue(QueueConfiguration queueConfig)	Before a queue is created
void	beforeCreateSession(String name, String username, int minLargeMessageSize, RemotingConnection connection, boolean autoCommitSends, boolean autoCommitAcks, boolean preAcknowledge, boolean xa, String publicAddress, SessionCallback callback, boolean autoCreateQueues, OperationContext context, Map<SimpleString,RoutingType> prefixes)	Before a session is created.
void	beforeDeliver(ServerConsumer consumer, MessageReference reference)	Before a message is delivered to a client consumer
void	beforeDeployBridge(BridgeConfiguration config)	Before a bridge is deployed
void	beforeDestroyQueue(SimpleString queueName, SecurityAuth session, boolean checkConsumerCount, boolean removeConsumers, boolean autoDeleteAddress)	Before a queue is destroyed
void	beforeMessageRoute(Message message, RoutingContext context, boolean direct, boolean rejectDuplicates)	Before a message is routed
void	beforeSend(ServerSession session, Transaction tx, Message message, boolean direct, boolean noAutoCreateQueue)	Before a message is sent
void	beforeSessionMetadataAdded(ServerSession session, String key, String data)	Before session metadata is added to the session
void	criticalFailure(CriticalComponent components)	A Critical failure has been detected.
void	init(Map<String,String> properties)	used to pass configured properties to Plugin
boolean	isLogAll()
boolean	isLogConnectionEvents()
boolean	isLogConsumerEvents()
boolean	isLogDeliveringEvents()
boolean	isLogInternalEvents()
boolean	isLogSendingEvents()
boolean	isLogSessionEvents()
void	messageAcknowledged(Transaction tx, MessageReference ref, AckReason reason, ServerConsumer consumer)	A message has been acknowledged
void	messageExpired(MessageReference message, SimpleString messageExpiryAddress, ServerConsumer consumer)	A message has been expired
void	onMessageRouteException(Message message, RoutingContext context, boolean direct, boolean rejectDuplicates, Exception e)	When there was an error routing the message
void	onSendException(ServerSession session, Transaction tx, Message message, boolean direct, boolean noAutoCreateQueue, Exception e)	When there was an exception sending the message

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.activemq.artemis.core.server.plugin.ActiveMQServerAddressPlugin

afterAddAddress, afterRemoveAddress, afterUpdateAddress, beforeAddAddress, beforeRemoveAddress, beforeUpdateAddress

Methods inherited from interface org.apache.activemq.artemis.core.server.plugin.ActiveMQServerBasePlugin

registered, setInit, unregistered

Methods inherited from interface org.apache.activemq.artemis.core.server.plugin.ActiveMQServerBindingPlugin

afterAddBinding, afterRemoveBinding, beforeAddBinding, beforeRemoveBinding

Methods inherited from interface org.apache.activemq.artemis.core.server.plugin.ActiveMQServerBridgePlugin

afterAcknowledgeBridge, afterDeliverBridge, beforeDeliverBridge

Methods inherited from interface org.apache.activemq.artemis.core.server.plugin.ActiveMQServerConsumerPlugin

beforeCreateConsumer

Methods inherited from interface org.apache.activemq.artemis.core.server.plugin.ActiveMQServerFederationPlugin

afterCloseFederatedQueueConsumer, afterCreateFederatedQueueConsumer, afterFederatedQueueConsumerMessageHandled, beforeCloseFederatedQueueConsumer, beforeCreateFederatedQueueConsumer, beforeFederatedQueueConsumerMessageHandled, federatedAddressConditionalCreateConsumer, federatedAddressConditionalCreateDivertConsumer, federatedQueueConditionalCreateConsumer, federationStreamStarted, federationStreamStopped

Methods inherited from interface org.apache.activemq.artemis.core.server.plugin.ActiveMQServerMessagePlugin

afterDeliver, afterSend, beforeDeliver, beforeSend, canAccept, messageAcknowledged, messageAcknowledged, messageExpired, messageMoved

Methods inherited from interface org.apache.activemq.artemis.core.server.plugin.ActiveMQServerQueuePlugin

afterExpiryScan, beforeCreateQueue, beforeDestroyQueue, beforeExpiryScan

Methods inherited from interface org.apache.activemq.artemis.core.server.plugin.ActiveMQServerResourcePlugin

afterPutTransaction, afterRemoveTransaction, beforePutTransaction, beforeRemoveTransaction

Methods inherited from interface org.apache.activemq.artemis.core.server.plugin.ActiveMQServerSessionPlugin

duplicateSessionMetadataFailure

Field Details

LOG_ALL_EVENTS

public static final String LOG_ALL_EVENTS

See Also:

• Constant Field Values

LOG_CONNECTION_EVENTS

public static final String LOG_CONNECTION_EVENTS

See Also:

• Constant Field Values

LOG_SESSION_EVENTS

public static final String LOG_SESSION_EVENTS

See Also:

• Constant Field Values

LOG_CONSUMER_EVENTS

public static final String LOG_CONSUMER_EVENTS

See Also:

• Constant Field Values

LOG_DELIVERING_EVENTS

public static final String LOG_DELIVERING_EVENTS

See Also:

• Constant Field Values

LOG_SENDING_EVENTS

public static final String LOG_SENDING_EVENTS

See Also:

• Constant Field Values

LOG_INTERNAL_EVENTS

public static final String LOG_INTERNAL_EVENTS

See Also:

• Constant Field Values

UNAVAILABLE

public static final String UNAVAILABLE

See Also:

• Constant Field Values

Constructor Details

LoggingActiveMQServerPlugin

public LoggingActiveMQServerPlugin()

Method Details

isLogAll

public boolean isLogAll()

isLogConnectionEvents

public boolean isLogConnectionEvents()

isLogSessionEvents

public boolean isLogSessionEvents()

isLogConsumerEvents

public boolean isLogConsumerEvents()

isLogDeliveringEvents

public boolean isLogDeliveringEvents()

isLogSendingEvents

public boolean isLogSendingEvents()

isLogInternalEvents

public boolean isLogInternalEvents()

init

public void init(Map<String,String> properties)

used to pass configured properties to Plugin

Specified by:

init in interface ActiveMQServerBasePlugin

afterCreateConnection

public void afterCreateConnection(RemotingConnection connection)
                           throws ActiveMQException

A connection has been created.

Specified by:

afterCreateConnection in interface ActiveMQServerConnectionPlugin

Parameters:

connection - The newly created connection

Throws:

ActiveMQException

afterDestroyConnection

public void afterDestroyConnection(RemotingConnection connection)
                            throws ActiveMQException

A connection has been destroyed.

Specified by:

afterDestroyConnection in interface ActiveMQServerConnectionPlugin

Throws:

ActiveMQException

beforeCreateSession

public void beforeCreateSession(String name,
 String username,
 int minLargeMessageSize,
 RemotingConnection connection,
 boolean autoCommitSends,
 boolean autoCommitAcks,
 boolean preAcknowledge,
 boolean xa,
 String publicAddress,
 SessionCallback callback,
 boolean autoCreateQueues,
 OperationContext context,
 Map<SimpleString,RoutingType> prefixes)
                         throws ActiveMQException

Before a session is created.

Specified by:

beforeCreateSession in interface ActiveMQServerSessionPlugin

Throws:

ActiveMQException

afterCreateSession

public void afterCreateSession(ServerSession session)
                        throws ActiveMQException

After a session has been created.

Specified by:

afterCreateSession in interface ActiveMQServerSessionPlugin

Parameters:

session - The newly created session

Throws:

ActiveMQException

beforeCloseSession

public void beforeCloseSession(ServerSession session,
 boolean failed)
                        throws ActiveMQException

Before a session is closed

Specified by:

beforeCloseSession in interface ActiveMQServerSessionPlugin

Throws:

ActiveMQException

afterCloseSession

public void afterCloseSession(ServerSession session,
 boolean failed)
                       throws ActiveMQException

After a session is closed

Specified by:

afterCloseSession in interface ActiveMQServerSessionPlugin

Throws:

ActiveMQException

beforeSessionMetadataAdded

public void beforeSessionMetadataAdded(ServerSession session,
 String key,
 String data)
                                throws ActiveMQException

Before session metadata is added to the session

Specified by:

beforeSessionMetadataAdded in interface ActiveMQServerSessionPlugin

Throws:

ActiveMQException

afterSessionMetadataAdded

public void afterSessionMetadataAdded(ServerSession session,
 String key,
 String data)
                               throws ActiveMQException

After session metadata is added to the session

Specified by:

afterSessionMetadataAdded in interface ActiveMQServerSessionPlugin

Throws:

ActiveMQException

beforeCreateConsumer

public void beforeCreateConsumer(long consumerID,
 QueueBinding queueBinding,
 SimpleString filterString,
 boolean browseOnly,
 boolean supportLargeMessage)
                          throws ActiveMQException

Before a consumer is created

Specified by:

beforeCreateConsumer in interface ActiveMQServerConsumerPlugin

Throws:

ActiveMQException

afterCreateConsumer

public void afterCreateConsumer(ServerConsumer consumer)
                         throws ActiveMQException

After a consumer has been created

Specified by:

afterCreateConsumer in interface ActiveMQServerConsumerPlugin

Parameters:

consumer - the created consumer

Throws:

ActiveMQException

beforeCloseConsumer

public void beforeCloseConsumer(ServerConsumer consumer,
 boolean failed)
                         throws ActiveMQException

Before a consumer is closed

Specified by:

beforeCloseConsumer in interface ActiveMQServerConsumerPlugin

Throws:

ActiveMQException

afterCloseConsumer

public void afterCloseConsumer(ServerConsumer consumer,
 boolean failed)
                        throws ActiveMQException

After a consumer is closed

Specified by:

afterCloseConsumer in interface ActiveMQServerConsumerPlugin

Throws:

ActiveMQException

beforeCreateQueue

public void beforeCreateQueue(QueueConfiguration queueConfig)
                       throws ActiveMQException

Before a queue is created

Specified by:

beforeCreateQueue in interface ActiveMQServerQueuePlugin

Throws:

ActiveMQException

afterCreateQueue

public void afterCreateQueue(Queue queue)
                      throws ActiveMQException

After a queue has been created

Specified by:

afterCreateQueue in interface ActiveMQServerQueuePlugin

Parameters:

queue - The newly created queue

Throws:

ActiveMQException

beforeDestroyQueue

public void beforeDestroyQueue(SimpleString queueName,
 SecurityAuth session,
 boolean checkConsumerCount,
 boolean removeConsumers,
 boolean autoDeleteAddress)
                        throws ActiveMQException

Before a queue is destroyed

Specified by:

beforeDestroyQueue in interface ActiveMQServerQueuePlugin

Throws:

ActiveMQException

afterDestroyQueue

public void afterDestroyQueue(Queue queue,
 SimpleString address,
 SecurityAuth session,
 boolean checkConsumerCount,
 boolean removeConsumers,
 boolean autoDeleteAddress)
                       throws ActiveMQException

After a queue has been destroyed

Specified by:

afterDestroyQueue in interface ActiveMQServerQueuePlugin

Throws:

ActiveMQException

beforeSend

public void beforeSend(ServerSession session,
 Transaction tx,
 Message message,
 boolean direct,
 boolean noAutoCreateQueue)
                throws ActiveMQException

Before a message is sent

Specified by:

beforeSend in interface ActiveMQServerMessagePlugin

Parameters:

session - the session that sends the message

Throws:

ActiveMQException

afterSend

public void afterSend(ServerSession session,
 Transaction tx,
 Message message,
 boolean direct,
 boolean noAutoCreateQueue,
 RoutingStatus result)
               throws ActiveMQException

After a message is sent

Specified by:

afterSend in interface ActiveMQServerMessagePlugin

Parameters:

session - the session that sends the message

Throws:

ActiveMQException

onSendException

public void onSendException(ServerSession session,
 Transaction tx,
 Message message,
 boolean direct,
 boolean noAutoCreateQueue,
 Exception e)
                     throws ActiveMQException

Description copied from interface: ActiveMQServerMessagePlugin

When there was an exception sending the message

Specified by:

onSendException in interface ActiveMQServerMessagePlugin

e - the exception that occurred when sending the message

Throws:

ActiveMQException

beforeMessageRoute

public void beforeMessageRoute(Message message,
 RoutingContext context,
 boolean direct,
 boolean rejectDuplicates)
                        throws ActiveMQException

Before a message is routed

Specified by:

beforeMessageRoute in interface ActiveMQServerMessagePlugin

Throws:

ActiveMQException

afterMessageRoute

public void afterMessageRoute(Message message,
 RoutingContext context,
 boolean direct,
 boolean rejectDuplicates,
 RoutingStatus result)
                       throws ActiveMQException

After a message is routed

Specified by:

afterMessageRoute in interface ActiveMQServerMessagePlugin

Throws:

ActiveMQException

onMessageRouteException

public void onMessageRouteException(Message message,
 RoutingContext context,
 boolean direct,
 boolean rejectDuplicates,
 Exception e)
                             throws ActiveMQException

Description copied from interface: ActiveMQServerMessagePlugin

When there was an error routing the message

Specified by:

onMessageRouteException in interface ActiveMQServerMessagePlugin

e - the exception that occurred during message routing

Throws:

ActiveMQException

beforeDeliver

public void beforeDeliver(ServerConsumer consumer,
 MessageReference reference)
                   throws ActiveMQException

Before a message is delivered to a client consumer

Specified by:

beforeDeliver in interface ActiveMQServerMessagePlugin

Parameters:

consumer - the consumer the message will be delivered to

reference - message reference

Throws:

ActiveMQException

afterDeliver

public void afterDeliver(ServerConsumer consumer,
 MessageReference reference)
                  throws ActiveMQException

After a message is delivered to a client consumer

Specified by:

afterDeliver in interface ActiveMQServerMessagePlugin

Parameters:

consumer - the consumer the message was delivered to

reference - message reference

Throws:

ActiveMQException

messageExpired

public void messageExpired(MessageReference message,
 SimpleString messageExpiryAddress,
 ServerConsumer consumer)

Description copied from interface: ActiveMQServerMessagePlugin

A message has been expired

Specified by:

messageExpired in interface ActiveMQServerMessagePlugin

Parameters:

message - The expired message

messageExpiryAddress - The message expiry address if exists

consumer - the Consumer that acknowledged the message - this field is optional and can be null

messageAcknowledged

public void messageAcknowledged(Transaction tx,
 MessageReference ref,
 AckReason reason,
 ServerConsumer consumer)
                         throws ActiveMQException

A message has been acknowledged

Specified by:

messageAcknowledged in interface ActiveMQServerMessagePlugin

Parameters:

tx - The transaction for the ack

ref - The acked message

reason - The ack reason

consumer - The consumer acking the ref

Throws:

ActiveMQException

beforeDeployBridge

public void beforeDeployBridge(BridgeConfiguration config)
                        throws ActiveMQException

Before a bridge is deployed

Specified by:

beforeDeployBridge in interface ActiveMQServerBridgePlugin

Parameters:

config - The bridge configuration

Throws:

ActiveMQException

afterDeployBridge

public void afterDeployBridge(Bridge bridge)
                       throws ActiveMQException

After a bridge has been deployed

Specified by:

afterDeployBridge in interface ActiveMQServerBridgePlugin

Parameters:

bridge - The newly deployed bridge

Throws:

ActiveMQException

criticalFailure

public void criticalFailure(CriticalComponent components)
                     throws ActiveMQException

A Critical failure has been detected. This will be called before the broker is stopped

Specified by:

criticalFailure in interface ActiveMQServerCriticalPlugin

Throws:

ActiveMQException