• Home
• org.jmxtrans.agent
• jmxtrans-agent
• 1.2.0
• source code
• ResultNameStrategy.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.jmxtrans.agent.ResultNameStrategy Maven / Gradle / Ivy

/*
 * Copyright (c) 2010-2013 the original author or authors
 * 
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 */
package org.jmxtrans.agent;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.management.ObjectName;
import java.util.Map;

/**
 * Build a {@linkplain QueryResult#name} from a collected metric ({@linkplain Query}).
 *
 * Build name must be escaped to be compatible with all {@linkplain 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 {@link java.net.InetAddress#getHostName()}
#reversed_hostname#
reversed localhost - hostname {@link java.net.InetAddress#getHostName()}
#escaped_hostname#
localhost - hostname {@link java.net.InetAddress#getHostName()} with '.' replaced by '_'
#canonical_hostname#
localhost - canonical hostname {@link java.net.InetAddress#getCanonicalHostName()}
server1.ecommerce.mycompany.com
#reversed_canonical_hostname#
reversed localhost - canonical hostname {@link java.net.InetAddress#getCanonicalHostName()}
com.mycompany.ecommerce.server1
#escaped_canonical_hostname#
localhost - canonical hostname {@link java.net.InetAddress#getCanonicalHostName()} with '.' replaced by '_'
server1_ecommerce_mycompany_com
#hostaddress#
localhost - hostaddress {@link java.net.InetAddress#getHostAddress()}
#escaped_hostname#
localhost - hostaddress {@link java.net.InetAddress#getHostAddress()} with '.' replaced by '_'

 *
 * @author Cyrille Le Clerc
 */
public interface ResultNameStrategy {

    @Nonnull
    String getResultName(@Nonnull Query query, @Nonnull ObjectName objectName, @Nullable String attribute, @Nullable String compositeDataKey, @Nullable Integer position);

    void postConstruct(@Nonnull Map settings);
}