com.netflix.servo.jmx

Interface ObjectNameMapper

All Known Implementing Classes:

OrderedObjectNameMapper

public interface ObjectNameMapper

Allows for different implementations when mapping a monitor to a JMX ObjectName. The mapper can be can be specified when using the JmxMonitorRegistry. This interface also has a reference to the default mapping implementation. Note that an ObjectName's properties are meant to be unordered, however, some tools such as VisualVM use the order to build a hierarchy view where the default implementation may not be desirable.

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectNameMapper	DEFAULT The default mapping implementation.

Method Summary

Modifier and Type	Method and Description
javax.management.ObjectName	createObjectName(java.lang.String domain, Monitor<?> monitor) Given the domain and monitor generates an ObjectName to use.

Field Detail

DEFAULT

static final ObjectNameMapper DEFAULT

The default mapping implementation. This implementation simply appends the monitor's name followed by all the tags as properties of the ObjectName. The mapper remaps any characters that are not alphanumeric, a period, or hypen to an underscore.

Method Detail

createObjectName

javax.management.ObjectName createObjectName(java.lang.String domain,
                                             Monitor<?> monitor)

Given the domain and monitor generates an ObjectName to use.

Parameters:

domain - the JMX domain

monitor - the monitor

Returns:

The created ObjectName