@ManagedResource public class IntegrationMBeanExporter extends MBeanExporter implements ApplicationContextAware, EmbeddedValueResolverAware
MBean exporter for Spring Integration components in an existing application. Add an instance of this as a bean definition in the same context as the components you need to monitor and all message channels and message handlers will be exposed.
Channels will report metrics on send and receive (counts, rates, errors) and handlers will report metrics on
execution duration. Channels will be registered under their name (bean id), if explicit, or the last part of their
internal name (e.g. "nullChannel") if registered by the framework. A handler that is attached to an endpoint will be
registered with the endpoint name (bean id) if there is one, otherwise under the name of the input channel. Handler
object names contain a bean
key that reports the source of the name: "endpoint" if the name is the
endpoint id; "anonymous" if it is the input channel; and "handler" as a fallback, where the object name is just the
toString()
of the handler.
This component is itself an MBean, reporting attributes concerning the names and object names of the channels and
handlers. It doesn't register itself to avoid conflicts with the standard <context:mbean-export/>
from Spring (which should therefore be used any time you need to expose those features).
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_DOMAIN |
AUTODETECT_ALL, AUTODETECT_ASSEMBLER, AUTODETECT_MBEAN, AUTODETECT_NONE
REGISTRATION_FAIL_ON_EXISTING, REGISTRATION_IGNORE_EXISTING, REGISTRATION_REPLACE_EXISTING, server
Constructor and Description |
---|
IntegrationMBeanExporter() |
adaptMBeanIfPossible, addExcludedBean, afterPropertiesSet, createAndConfigureMBean, createModelMBean, getObjectName, isBeanDefinitionLazyInit, isMBean, onRegister, onUnregister, registerBeanNameOrInstance, registerBeans, registerManagedResource, registerManagedResource, setAllowEagerInit, setAssembler, setAutodetect, setAutodetectMode, setAutodetectModeName, setBeanClassLoader, setBeanFactory, setBeans, setEnsureUniqueRuntimeObjectNames, setExcludedBeans, setExposeManagedResourceClassLoader, setListeners, setNamingStrategy, setNotificationListenerMappings, setNotificationListeners, unregisterManagedResource
doRegister, doUnregister, getRegisteredObjectNames, getServer, onRegister, setRegistrationBehavior, setRegistrationBehaviorName, setRegistrationPolicy, setServer, unregisterBeans
public static final String DEFAULT_DOMAIN
public void setObjectNameStaticProperties(Map<String,String> objectNameStaticProperties)
objectNameStaticProperties
- the objectNameStaticProperties to setpublic void setDefaultDomain(String domain)
spring.application
(which is useful in
SpringSource HQ).domain
- the domain name to setpublic void setComponentNamePatterns(String[] componentNamePatterns)
componentNamePatterns
- the patterns.public void setApplicationContext(ApplicationContext applicationContext) throws BeansException
setApplicationContext
in interface ApplicationContextAware
BeansException
public void setEmbeddedValueResolver(StringValueResolver resolver)
setEmbeddedValueResolver
in interface EmbeddedValueResolverAware
public void afterSingletonsInstantiated()
afterSingletonsInstantiated
in interface SmartInitializingSingleton
afterSingletonsInstantiated
in class MBeanExporter
public void destroy()
destroy
in interface DisposableBean
destroy
in class MBeanExporter
@ManagedOperation public void stopActiveComponents(long howLong)
howLong
- The time to wait in total for all activities to complete
in milliseconds.@ManagedOperation public void stopMessageSources()
@ManagedOperation public void stopInboundMessageProducers()
OrderlyShutdownCapable
)
- may cause interrupts.@ManagedOperation public void stopActiveChannels()
protected final void orderlyShutdownCapableComponentsBefore()
protected final void orderlyShutdownCapableComponentsAfter()
@ManagedMetric(metricType=COUNTER, displayName="MessageChannel Channel Count") public int getChannelCount()
@ManagedMetric(metricType=COUNTER, displayName="MessageHandler Handler Count") public int getHandlerCount()
@ManagedAttribute public String[] getHandlerNames()
@ManagedMetric(metricType=GAUGE, displayName="Active Handler Count") public int getActiveHandlerCount()
@ManagedMetric(metricType=GAUGE, displayName="Active Handler Count") public long getActiveHandlerCountLong()
@ManagedMetric(metricType=GAUGE, displayName="Queued Message Count") public int getQueuedMessageCount()
@ManagedAttribute public String[] getChannelNames()
public MessageHandlerMetrics getHandlerMetrics(String name)
public Statistics getHandlerDuration(String name)
public MessageSourceMetrics getSourceMetrics(String name)
public int getSourceMessageCount(String name)
public long getSourceMessageCountLong(String name)
public MessageChannelMetrics getChannelMetrics(String name)
public int getChannelSendCount(String name)
public long getChannelSendCountLong(String name)
public int getChannelSendErrorCount(String name)
public long getChannelSendErrorCountLong(String name)
public int getChannelReceiveCount(String name)
public long getChannelReceiveCountLong(String name)
@ManagedOperation public Statistics getChannelSendRate(String name)
public Statistics getChannelErrorRate(String name)