com.netflix.servo.jmx

Class JmxMonitorRegistry

java.lang.Object

com.netflix.servo.jmx.JmxMonitorRegistry

All Implemented Interfaces:

MonitorRegistry

public final class JmxMonitorRegistry
extends java.lang.Object
implements MonitorRegistry

Monitor registry backed by JMX. The monitor annotations on registered objects will be used to export the data to JMX. For details about the representation in JMX see MonitorMBean. The ObjectName used for each monitor depends on the implementation of ObjectNameMapper that is specified for the registry. See ObjectNameMapper.DEFAULT for the default naming implementation.

Constructor Summary

Constructors

Constructor and Description
JmxMonitorRegistry(java.lang.String name) Creates a new instance that registers metrics with the local mbean server using the default ObjectNameMapper ObjectNameMapper.DEFAULT.
JmxMonitorRegistry(java.lang.String name, ObjectNameMapper mapper) Creates a new instance that registers metrics with the local mbean server using the ObjectNameMapper provided.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Monitor<?>>	getRegisteredMonitors() The set of registered Monitor objects.
boolean	isRegistered(Monitor<?> monitor) Check whether a monitor has been registerd.
void	register(Monitor<?> monitor) Register a new monitor in the registry.
void	unregister(Monitor<?> monitor) Unregister a Monitor from the registry.

Methods inherited from class java.lang.Object

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

Constructor Detail

JmxMonitorRegistry

public JmxMonitorRegistry(java.lang.String name)

Creates a new instance that registers metrics with the local mbean server using the default ObjectNameMapper ObjectNameMapper.DEFAULT.

Parameters:

name - the registry name

JmxMonitorRegistry

public JmxMonitorRegistry(java.lang.String name,
                          ObjectNameMapper mapper)

Creates a new instance that registers metrics with the local mbean server using the ObjectNameMapper provided.

Parameters:

name - the registry name

mapper - the monitor to object name mapper

Method Detail

getRegisteredMonitors

public java.util.Collection<Monitor<?>> getRegisteredMonitors()

The set of registered Monitor objects.

Specified by:

getRegisteredMonitors in interface MonitorRegistry

register

public void register(Monitor<?> monitor)

Register a new monitor in the registry.

Specified by:

register in interface MonitorRegistry

unregister

public void unregister(Monitor<?> monitor)

Unregister a Monitor from the registry.

Specified by:

unregister in interface MonitorRegistry

isRegistered

public boolean isRegistered(Monitor<?> monitor)

Description copied from interface: MonitorRegistry

Check whether a monitor has been registerd.

Specified by:

isRegistered in interface MonitorRegistry