net.centro.rtb.monitoringcenter.util

Class MetricNamingUtil

java.lang.Object

net.centro.rtb.monitoringcenter.util.MetricNamingUtil

public class MetricNamingUtil
extends Object

This utility class handles the naming concerns for metrics and health checks. In particular, this class encapsulates the separator to be used in composite metric names, input sanitization logic, and a facility for building composite names from supplied parts.

Field Summary

Fields

Modifier and Type	Field and Description
static String	REPLACEMENT_CHAR
static String	SEPARATOR

Method Summary

Modifier and Type	Method and Description
static String	join(String[] nameParts) Joins an array of strings into a composite name.
static String	join(String topLevelName, String... additionalNames) Joins the passed in strings into a composite name.
static String	sanitize(String valueStr) Sanitizes the input string by trimming it and replacing illegal characters with REPLACEMENT_CHAR.

Methods inherited from class java.lang.Object

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

Field Detail

REPLACEMENT_CHAR

public static final String REPLACEMENT_CHAR

See Also:

Constant Field Values

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

Method Detail

sanitize

public static String sanitize(String valueStr)

Sanitizes the input string by trimming it and replacing illegal characters with REPLACEMENT_CHAR. An illegal character is any character but "\w" and "-". That is, this method does not allow the separator (SEPARATOR) character.

Parameters:

valueStr - the string to sanitize.

Returns:

a sanitized string or null if input was null.

join

public static String join(String[] nameParts)

Joins an array of strings into a composite name. This method sanitizes each element of the array by trimming it and replacing illegal characters with REPLACEMENT_CHAR. An illegal character is any character but "\w", "-", and SEPARATOR.

Parameters:

nameParts - array of strings to combine into a composite name.

Returns:

a composite name, comprised of sanitized elements of the passed in array, delimited by the separator.

Throws:

NullPointerException - if the passed in array is null.

IllegalArgumentException - if the passed in array is empty.

join

public static String join(String topLevelName,
                          String... additionalNames)

Joins the passed in strings into a composite name. This method sanitizes each provided string by trimming it and replacing illegal characters with REPLACEMENT_CHAR. An illegal character is any character but "\w", "-", and SEPARATOR.

Parameters:

topLevelName - top-level part of the name.

additionalNames - additional parts of the name.

Returns:

a composite name, comprised of the sanitized passed in strings, delimited by the separator.

Throws:

IllegalArgumentException - if top-level part of the name is blank.