com.github.sps.metrics.opentsdb

Class OpenTsdbMetric

java.lang.Object

com.github.sps.metrics.opentsdb.OpenTsdbMetric

public class OpenTsdbMetric
extends Object

Representation of a metric.

Author:

Sean Scanlon , Adam Lugowski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenTsdbMetric.Builder

Method Summary

Modifier and Type	Method and Description
static String	encodeTagsInName(String name, Map<String,String> tags) Add TSDB tags to a CodaHale metric name.
static String	encodeTagsInName(String name, String tags) Add TSDB tags to a CodaHale metric name.
boolean	equals(Object o)
static String	fixEncodedTagsInNameAfterPrefix(String name) Call this function whenever a potentially tag-encoded name is prefixed.
static String	formatTags(Map<String,String> tagMap) Convert a tag map into a space-delimited string.
String	getMetric()
Map<String,String>	getTags()
Long	getTimestamp()
Object	getValue()
static boolean	hasEncodedTagInName(String name) Tests whether a name has been processed with encodeTagsInName.
int	hashCode()
static OpenTsdbMetric.Builder	named(String name) Creates a Builder for a metric name.
static Map<String,String>	parseTags(String tagString) Convert a tag string into a tag map.
static String	sanitize(String name) Sanitizes a metric name, tag key, or tag value by removing characters not allowed by TSDB.
String	toString() Returns a JSON string version of this metric compatible with the HTTP API reporter.
String	toTelnetPutString() Returns a put string version of this metric compatible with the telnet-style reporter.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

parseTags

public static Map<String,String> parseTags(String tagString)
                                    throws IllegalArgumentException

Convert a tag string into a tag map.

Parameters:

tagString - a space-delimited string of key-value pairs. For example, "key1=value1 key_n=value_n"

Returns:

a tag Map

Throws:

IllegalArgumentException - if the tag string is corrupted.

formatTags

public static String formatTags(Map<String,String> tagMap)

Convert a tag map into a space-delimited string.

Parameters:

tagMap -

Returns:

a space-delimited string of key-value pairs. For example, "key1=value1 key_n=value_n"

encodeTagsInName

public static String encodeTagsInName(String name,
                                      String tags)
                               throws IllegalArgumentException

Add TSDB tags to a CodaHale metric name. A CodaHale metric name is a single string, so there is no natural way to encode TSDB tags. This function formats the tags into the metric name so they can later be parsed by the Builder. The name is formatted such that it can be appended to create sub-metric names, as happens with Meter and Histogram.

Parameters:

name - CodaHale metric name

tags - A space-delimited string of TSDB key-value pair tags

Returns:

A metric name encoded with tags.

Throws:

IllegalArgumentException - if the tag string is invalid

encodeTagsInName

public static String encodeTagsInName(String name,
                                      Map<String,String> tags)

Add TSDB tags to a CodaHale metric name. A CodaHale metric name is a single string, so there is no natural way to encode TSDB tags. This function formats the tags into the metric name so they can later be parsed by the Builder. The name is formatted such that it can be appended to create sub-metric names, as happens with Meter and Histogram.

Parameters:

name - CodaHale metric name

tags - a Map of TSDB tags

Returns:

A metric name encoded with tags.

hasEncodedTagInName

public static boolean hasEncodedTagInName(String name)

Tests whether a name has been processed with encodeTagsInName.

Parameters:

name - a metric name

Returns:

true if name has tags encoded, false otherwise.

fixEncodedTagsInNameAfterPrefix

public static String fixEncodedTagsInNameAfterPrefix(String name)

Call this function whenever a potentially tag-encoded name is prefixed.

Parameters:

name - a metric name with encoded tag strings that has been prefixed.

Returns:

a fixed metric name

named

public static OpenTsdbMetric.Builder named(String name)

Creates a Builder for a metric name.

Parameters:

name - name can contain either a pure CodaHale metric name, or a string returned by encodeTagsInName. If it's the latter, the tags are parsed out and passed to withTags.

Returns:

a OpenTsdbMetric.Builder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a JSON string version of this metric compatible with the HTTP API reporter. Example:

 {
     "metric": "sys.cpu.nice",
     "timestamp": 1346846400,
     "value": 18,
     "tags": {
         "host": "web01",
         "dc": "lga"
     }
 }
 

Overrides:

toString in class Object

Returns:

a JSON string version of this metric compatible with the HTTP API reporter.

sanitize

public static String sanitize(String name)

Sanitizes a metric name, tag key, or tag value by removing characters not allowed by TSDB. Supported characters are a-z A-Z 0-9 - _ . /

Parameters:

name - a metric name, tag key, or tag value

Returns:

name where unsupported characters are replaced with "-".

toTelnetPutString

public String toTelnetPutString()

Returns a put string version of this metric compatible with the telnet-style reporter. Format:

 put (metric-name) (timestamp) (value) (tags)
 

Example:

 put sys.cpu.nice 1346846400 18 host=web01 dc=lga
 

Returns:

a string version of this metric compatible with the telnet reporter.

getMetric

public String getMetric()

getTimestamp

public Long getTimestamp()

getValue

public Object getValue()

getTags

public Map<String,String> getTags()