Spring Framework 6.1.4 · org.springframework.web.socket.config.WebSocketMessageBrokerStats

A central class for aggregating information about internal state and counters from key infrastructure components of the setup that comes with @EnableWebSocketMessageBroker for Java config and <websocket:message-broker> for XML.

By default aggregated information is logged every 30 minutes at INFO level. The frequency of logging can be changed via setLoggingPeriod(long).

This class is declared as a Spring bean by the above configuration with the name "webSocketMessageBrokerStats" and can be easily exported to JMX, e.g. with the MBeanExporter.

Field Summary

Modifier and Type	Field and Description
private TaskExecutor	inboundChannelExecutor
private static final Log	logger
private long	loggingPeriod
private ScheduledFuture<?>	loggingTask
private TaskExecutor	outboundChannelExecutor
private TaskScheduler	sockJsTaskScheduler
private StompBrokerRelayMessageHandler	stompBrokerRelay
private StompSubProtocolHandler	stompSubProtocolHandler
private SubProtocolWebSocketHandler	webSocketHandler

Constructor Summary

Access	Constructor and Description
public	WebSocketMessageBrokerStats()

Method Summary

Modifier and Type	Method and Description
public void	afterSingletonsInstantiated() Implements org.springframework.beans.factory.SmartInitializingSingleton.afterSingletonsInstantiated. Invoked right at the end of the singleton pre-instantiation phase, with a guarantee that all regular singleton beans have been created already.
public String	getClientInboundExecutorStatsInfo() Get stats about the executor processing incoming messages from WebSocket clients.
public String	getClientOutboundExecutorStatsInfo() Get stats about the executor processing outgoing messages to WebSocket clients.
private String	getExecutorStatsInfo(Executor executor)
public long	getLoggingPeriod() Return the configured logging period frequency in milliseconds.
public String	getSockJsTaskSchedulerStatsInfo() Get stats about the SockJS task scheduler.
public String	getStompBrokerRelayStatsInfo() Get stats about STOMP broker relay (when using a full-featured STOMP broker).
public String	getStompSubProtocolStatsInfo() Get stats about STOMP-related WebSocket message processing.
public String	getWebSocketSessionStatsInfo() Get stats about WebSocket sessions.
private ScheduledFuture<?>	initLoggingTask(long initialDelay)
private StompSubProtocolHandler	initStompSubProtocolHandler()
public void	setInboundChannelExecutor(TaskExecutor inboundChannelExecutor)
public void	setLoggingPeriod(long period) Set the frequency for logging information at INFO level in milliseconds.
public void	setOutboundChannelExecutor(TaskExecutor outboundChannelExecutor)
public void	setSockJsTaskScheduler(TaskScheduler sockJsTaskScheduler)
public void	setStompBrokerRelay(StompBrokerRelayMessageHandler stompBrokerRelay)
public void	setSubProtocolWebSocketHandler(SubProtocolWebSocketHandler webSocketHandler)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

inboundChannelExecutor	back to summary
private TaskExecutor inboundChannelExecutor Annotations @Nullable

logger	back to summary
private static final Log logger

loggingPeriod	back to summary
private long loggingPeriod

loggingTask	back to summary
private ScheduledFuture<?> loggingTask Annotations @Nullable

outboundChannelExecutor	back to summary
private TaskExecutor outboundChannelExecutor Annotations @Nullable

sockJsTaskScheduler	back to summary
private TaskScheduler sockJsTaskScheduler Annotations @Nullable

stompBrokerRelay	back to summary
private StompBrokerRelayMessageHandler stompBrokerRelay Annotations @Nullable

stompSubProtocolHandler	back to summary
private StompSubProtocolHandler stompSubProtocolHandler Annotations @Nullable

webSocketHandler	back to summary
private SubProtocolWebSocketHandler webSocketHandler Annotations @Nullable

Constructor Detail

WebSocketMessageBrokerStats	back to summary
public WebSocketMessageBrokerStats()

Method Detail

afterSingletonsInstantiated back to summary

afterSingletonsInstantiated	back to summary
public void afterSingletonsInstantiated() Implements org.springframework.beans.factory.SmartInitializingSingleton.afterSingletonsInstantiated. Doc from org.springframework.beans.factory.SmartInitializingSingleton.afterSingletonsInstantiated. Invoked right at the end of the singleton pre-instantiation phase, with a guarantee that all regular singleton beans have been created already. `ListableBeanFactory#getBeansOfType` calls within this method won't trigger accidental side effects during bootstrap. Note This callback won't be triggered for singleton beans lazily initialized on demand after `BeanFactory` bootstrap, and not for any other bean scope either. Carefully use it for beans with the intended bootstrap semantics only. Annotations @Override

public void afterSingletonsInstantiated()

Implements org.springframework.beans.factory.SmartInitializingSingleton.afterSingletonsInstantiated.

Doc from org.springframework.beans.factory.SmartInitializingSingleton.afterSingletonsInstantiated.

Invoked right at the end of the singleton pre-instantiation phase, with a guarantee that all regular singleton beans have been created already. ListableBeanFactory#getBeansOfType calls within this method won't trigger accidental side effects during bootstrap.

Note

This callback won't be triggered for singleton beans lazily initialized on demand after BeanFactory bootstrap, and not for any other bean scope either. Carefully use it for beans with the intended bootstrap semantics only.

Annotations

@Override

getClientInboundExecutorStatsInfo	back to summary
public String getClientInboundExecutorStatsInfo() Get stats about the executor processing incoming messages from WebSocket clients.

getClientOutboundExecutorStatsInfo	back to summary
public String getClientOutboundExecutorStatsInfo() Get stats about the executor processing outgoing messages to WebSocket clients.

getExecutorStatsInfo	back to summary
private String getExecutorStatsInfo(Executor executor)

getLoggingPeriod	back to summary
public long getLoggingPeriod() Return the configured logging period frequency in milliseconds.

getSockJsTaskSchedulerStatsInfo	back to summary
public String getSockJsTaskSchedulerStatsInfo() Get stats about the SockJS task scheduler.

getStompBrokerRelayStatsInfo	back to summary
public String getStompBrokerRelayStatsInfo() Get stats about STOMP broker relay (when using a full-featured STOMP broker).

getStompSubProtocolStatsInfo	back to summary
public String getStompSubProtocolStatsInfo() Get stats about STOMP-related WebSocket message processing.

getWebSocketSessionStatsInfo	back to summary
public String getWebSocketSessionStatsInfo() Get stats about WebSocket sessions.

initLoggingTask	back to summary
private ScheduledFuture<?> initLoggingTask(long initialDelay) Annotations @Nullable

initStompSubProtocolHandler	back to summary
private StompSubProtocolHandler initStompSubProtocolHandler() Annotations @Nullable

setInboundChannelExecutor	back to summary
public void setInboundChannelExecutor(TaskExecutor inboundChannelExecutor)

setLoggingPeriod	back to summary
public void setLoggingPeriod(long period) Set the frequency for logging information at INFO level in milliseconds. If set 0 or less than 0, the logging task is cancelled. By default this property is set to 30 minutes (30 * 60 * 1000).

setLoggingPeriod

back to summary

public void setLoggingPeriod(long period)

Set the frequency for logging information at INFO level in milliseconds. If set 0 or less than 0, the logging task is cancelled.

By default this property is set to 30 minutes (30 * 60 * 1000).

setOutboundChannelExecutor	back to summary
public void setOutboundChannelExecutor(TaskExecutor outboundChannelExecutor)

setSockJsTaskScheduler	back to summary
public void setSockJsTaskScheduler(TaskScheduler sockJsTaskScheduler)

setStompBrokerRelay	back to summary
public void setStompBrokerRelay(StompBrokerRelayMessageHandler stompBrokerRelay)

setSubProtocolWebSocketHandler	back to summary
public void setSubProtocolWebSocketHandler(SubProtocolWebSocketHandler webSocketHandler)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class WebSocketMessageBrokerStats

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail