org.jmxtrans.agent

Class ResultNameStrategy

java.lang.Object

org.jmxtrans.agent.ResultNameStrategy

public class ResultNameStrategy
extends Object

Build a QueryResult.name from a collected metric (Query).

Build name must be escaped to be compatible with all OutputWriter. The approach is to escape non alpha-numeric chars.

Expressions support '#' based keywords (e.g. #hostname#) and with '%' based variables mapped to objectname properties.

Supported '#' based 'functions':

Function	Description	Sample
#hostname#	localhost - hostname InetAddress.getHostName()
#reversed_hostname#	reversed localhost - hostname InetAddress.getHostName()
#escaped_hostname#	localhost - hostname InetAddress.getHostName() with '.' replaced by '_'
#canonical_hostname#	localhost - canonical hostname InetAddress.getCanonicalHostName()	server1.ecommerce.mycompany.com
#reversed_canonical_hostname#	reversed localhost - canonical hostname InetAddress.getCanonicalHostName()	com.mycompany.ecommerce.server1
#escaped_canonical_hostname#	localhost - canonical hostname InetAddress.getCanonicalHostName() with '.' replaced by '_'	server1_ecommerce_mycompany_com
#hostaddress#	localhost - hostaddress InetAddress.getHostAddress()
#escaped_hostname#	localhost - hostaddress InetAddress.getHostAddress() with '.' replaced by '_'

Author:

Cyrille Le Clerc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResultNameStrategy.StaticEvaluator

Constructor Summary

Constructors

Constructor and Description
ResultNameStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
protected StringBuilder	_getResultName(Query query, ObjectName objectName)
protected String	escapeObjectName(ObjectName objectName) Transforms an ObjectName into a plain String only composed of (a->Z, A-Z, '_').
Map<String,Callable<String>>	getExpressionEvaluators()
String	getResultName(Query query, ObjectName objectName)
String	getResultName(Query query, ObjectName objectName, String key)
void	registerExpressionEvaluator(String expression, Callable<String> evaluator) Registers an expression evaluator with a static value.
void	registerExpressionEvaluator(String expression, String value) Registers an expression evaluator with a static value.
String	resolveExpression(String expression) Replace all the '#' based keywords (e.g.
protected String	resolveExpression(String expression, ObjectName exactObjectName)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultNameStrategy

public ResultNameStrategy()

Method Detail

getResultName

@Nonnull
public String getResultName(@Nonnull
                           Query query,
                           @Nonnull
                           ObjectName objectName)

getResultName

@Nonnull
public String getResultName(@Nonnull
                           Query query,
                           @Nonnull
                           ObjectName objectName,
                           @Nullable
                           String key)

_getResultName

@Nonnull
protected StringBuilder _getResultName(@Nonnull
                                   Query query,
                                   @Nonnull
                                   ObjectName objectName)

resolveExpression

@Nonnull
public String resolveExpression(@Nonnull
                               String expression)

Replace all the '#' based keywords (e.g. #hostname#) by their value.

Parameters:

expression - the expression to resolve (e.g. "servers.#hostname#.")

Returns:

the resolved expression (e.g. "servers.tomcat5")

resolveExpression

protected String resolveExpression(@Nonnull
                       String expression,
                       @Nonnull
                       ObjectName exactObjectName)

escapeObjectName

protected String escapeObjectName(@Nonnull
                      ObjectName objectName)

Transforms an ObjectName into a plain String only composed of (a->Z, A-Z, '_').

'_' is the escape char for not compliant chars.

registerExpressionEvaluator

public void registerExpressionEvaluator(String expression,
                               Callable<String> evaluator)

Registers an expression evaluator with a static value.

registerExpressionEvaluator

public void registerExpressionEvaluator(String expression,
                               String value)

Registers an expression evaluator with a static value.

getExpressionEvaluators

@Nonnull
public Map<String,Callable<String>> getExpressionEvaluators()