com.wavefront.sdk.common

Class Utils

java.lang.Object

com.wavefront.sdk.common.Utils

public class Utils
extends java.lang.Object

Common Util methods

Version:

$Id: $Id

Author:

Sushant Dewan (sushant@wavefront.com).

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static double	convertSemVerToGauge(java.lang.String version) convertSemVerToGauge.
static java.lang.String	eventToLineData(java.lang.String name, long startMillis, long endMillis, java.lang.String source, java.util.Map<java.lang.String,java.lang.String> tags, java.util.Map<java.lang.String,java.lang.String> annotations, java.lang.String defaultSource, boolean jsonify) eventToLineData.
static java.util.Optional<java.util.ResourceBundle>	getResource(java.lang.String pathToResource) Return the resource at the given resource path in the resource directory META-INF/.
static double	getSemVerGauge(java.lang.String artifactId) Return the version of the given artifact Id as a gauge value to be reported to Wavefront.
static java.util.Optional<java.lang.String>	getVersion(java.lang.String artifactId) Return the version of the given artifact Id.
static java.lang.String	histogramToLineData(java.lang.String name, java.util.List<Pair<java.lang.Double,java.lang.Integer>> centroids, java.util.Set<HistogramGranularity> histogramGranularities, java.lang.Long timestamp, java.lang.String source, java.util.Map<java.lang.String,java.lang.String> tags, java.lang.String defaultSource) histogramToLineData.
static java.lang.String	logToLineData(java.lang.String name, double value, java.lang.Long timestamp, java.lang.String source, java.util.Map<java.lang.String,java.lang.String> tags, java.lang.String defaultSource) logToLineData.
static java.lang.String	metricToLineData(java.lang.String name, double value, java.lang.Long timestamp, java.lang.String source, java.util.Map<java.lang.String,java.lang.String> tags, java.lang.String defaultSource) metricToLineData.
static java.lang.String	sanitize(java.lang.String s) sanitize.
static java.lang.String	sanitize(java.lang.String s, boolean ignoreSlash) sanitize.
static java.lang.String	sanitizeValue(java.lang.String s) sanitizeValue.
static java.lang.String	sanitizeWithoutQuotes(java.lang.String s) sanitizeWithoutQuotes.
static void	shutdownExecutorAndWait(java.util.concurrent.ExecutorService tpe) shutdownExecutorAndWait.
static java.lang.String	spanLogsToLineData(java.util.UUID traceId, java.util.UUID spanId, java.util.List<SpanLog> spanLogs) spanLogsToLineData.
static java.lang.String	spanLogsToLineData(java.util.UUID traceId, java.util.UUID spanId, java.util.List<SpanLog> spanLogs, java.lang.String span) spanLogsToLineData.
static java.lang.String	spanLogsToLineData(java.util.UUID traceId, java.util.UUID spanId, java.util.List<SpanLog> spanLogs, java.lang.String span, java.lang.String spanSecondaryId) spanLogsToLineData.
static java.lang.String	tracingSpanToLineData(java.lang.String name, long startMillis, long durationMillis, java.lang.String source, java.util.UUID traceId, java.util.UUID spanId, java.util.List<java.util.UUID> parents, java.util.List<java.util.UUID> followsFrom, java.util.List<Pair<java.lang.String,java.lang.String>> tags, java.util.List<SpanLog> spanLogs, java.lang.String defaultSource) tracingSpanToLineData.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

sanitize

public static java.lang.String sanitize(java.lang.String s)

sanitize.

Parameters:

s - a String object

Returns:

a String object

sanitize

public static java.lang.String sanitize(java.lang.String s,
                                        boolean ignoreSlash)

sanitize.

Parameters:

s - a String object

ignoreSlash - a boolean

Returns:

a String object

sanitizeWithoutQuotes

public static java.lang.String sanitizeWithoutQuotes(java.lang.String s)

sanitizeWithoutQuotes.

Parameters:

s - a String object

Returns:

a String object

sanitizeValue

public static java.lang.String sanitizeValue(java.lang.String s)

sanitizeValue.

Parameters:

s - a String object

Returns:

a String object

metricToLineData

public static java.lang.String metricToLineData(java.lang.String name,
                                                double value,
                                                @Nullable
                                                java.lang.Long timestamp,
                                                java.lang.String source,
                                                @Nullable
                                                java.util.Map<java.lang.String,java.lang.String> tags,
                                                java.lang.String defaultSource)

metricToLineData.

Parameters:

name - a String object

value - a double

timestamp - a Long object

source - a String object

tags - a Map object

defaultSource - a String object

Returns:

a String object

logToLineData

public static java.lang.String logToLineData(java.lang.String name,
                                             double value,
                                             @Nullable
                                             java.lang.Long timestamp,
                                             java.lang.String source,
                                             @Nullable
                                             java.util.Map<java.lang.String,java.lang.String> tags,
                                             java.lang.String defaultSource)

logToLineData.

Parameters:

name - a String object

value - a double

timestamp - a Long object

source - a String object

tags - a Map object

defaultSource - a String object

Returns:

a String object

histogramToLineData

public static java.lang.String histogramToLineData(java.lang.String name,
                                                   java.util.List<Pair<java.lang.Double,java.lang.Integer>> centroids,
                                                   java.util.Set<HistogramGranularity> histogramGranularities,
                                                   @Nullable
                                                   java.lang.Long timestamp,
                                                   java.lang.String source,
                                                   @Nullable
                                                   java.util.Map<java.lang.String,java.lang.String> tags,
                                                   java.lang.String defaultSource)

histogramToLineData.

Parameters:

name - a String object

centroids - a List object

histogramGranularities - a Set object

timestamp - a Long object

source - a String object

tags - a Map object

defaultSource - a String object

Returns:

a String object

tracingSpanToLineData

public static java.lang.String tracingSpanToLineData(java.lang.String name,
                                                     long startMillis,
                                                     long durationMillis,
                                                     java.lang.String source,
                                                     java.util.UUID traceId,
                                                     java.util.UUID spanId,
                                                     @Nullable
                                                     java.util.List<java.util.UUID> parents,
                                                     @Nullable
                                                     java.util.List<java.util.UUID> followsFrom,
                                                     @Nullable
                                                     java.util.List<Pair<java.lang.String,java.lang.String>> tags,
                                                     @Nullable
                                                     java.util.List<SpanLog> spanLogs,
                                                     java.lang.String defaultSource)

tracingSpanToLineData.

Parameters:

name - a String object

startMillis - a long

durationMillis - a long

source - a String object

traceId - a UUID object

spanId - a UUID object

parents - a List object

followsFrom - a List object

tags - a List object

spanLogs - a List object

defaultSource - a String object

Returns:

a String object

eventToLineData

public static java.lang.String eventToLineData(java.lang.String name,
                                               long startMillis,
                                               long endMillis,
                                               @Nullable
                                               java.lang.String source,
                                               @Nullable
                                               java.util.Map<java.lang.String,java.lang.String> tags,
                                               @Nullable
                                               java.util.Map<java.lang.String,java.lang.String> annotations,
                                               java.lang.String defaultSource,
                                               boolean jsonify)
                                        throws com.fasterxml.jackson.core.JsonProcessingException

eventToLineData.

Parameters:

name - a String object

startMillis - a long

endMillis - a long

source - a String object

tags - a Map object

annotations - a Map object

defaultSource - a String object

jsonify - a boolean

Returns:

a String object

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if any.

spanLogsToLineData

public static java.lang.String spanLogsToLineData(java.util.UUID traceId,
                                                  java.util.UUID spanId,
                                                  @NonNull
                                                  java.util.List<SpanLog> spanLogs)
                                           throws com.fasterxml.jackson.core.JsonProcessingException

spanLogsToLineData.

Parameters:

traceId - a UUID object

spanId - a UUID object

spanLogs - a List object

Returns:

a String object

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if any.

spanLogsToLineData

public static java.lang.String spanLogsToLineData(java.util.UUID traceId,
                                                  java.util.UUID spanId,
                                                  @NonNull
                                                  java.util.List<SpanLog> spanLogs,
                                                  @Nullable
                                                  java.lang.String span)
                                           throws com.fasterxml.jackson.core.JsonProcessingException

spanLogsToLineData.

Parameters:

traceId - a UUID object

spanId - a UUID object

spanLogs - a List object

span - a String object

Returns:

a String object

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if any.

spanLogsToLineData

public static java.lang.String spanLogsToLineData(java.util.UUID traceId,
                                                  java.util.UUID spanId,
                                                  @NonNull
                                                  java.util.List<SpanLog> spanLogs,
                                                  @Nullable
                                                  java.lang.String span,
                                                  @Nullable
                                                  java.lang.String spanSecondaryId)
                                           throws com.fasterxml.jackson.core.JsonProcessingException

spanLogsToLineData.

Parameters:

traceId - a UUID object

spanId - a UUID object

spanLogs - a List object

span - a String object

spanSecondaryId - a String object

Returns:

a String object

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if any.

shutdownExecutorAndWait

public static void shutdownExecutorAndWait(java.util.concurrent.ExecutorService tpe)

shutdownExecutorAndWait.

Parameters:

tpe - a ExecutorService object

getResource

public static java.util.Optional<java.util.ResourceBundle> getResource(java.lang.String pathToResource)

Return the resource at the given resource path in the resource directory META-INF/.

Parameters:

pathToResource - a String object

Returns:

the resource at the given path, if exists.

getVersion

public static java.util.Optional<java.lang.String> getVersion(java.lang.String artifactId)

Return the version of the given artifact Id. This depends on a file with name "<artifactId>.properties" in the resource directory META-INF/. The file should contain a line that specifies the project version as "project.version".

Parameters:

artifactId - a String object

Returns:

the version for the given artifactId

getSemVerGauge

public static double getSemVerGauge(java.lang.String artifactId)

Return the version of the given artifact Id as a gauge value to be reported to Wavefront. This depends on a file with name "<artifactId>.properties" in the resource directory META-INF/. The file should contain a line that specifies the project version as "project.version". Format of semantic version gauge value reported to Wavefront = <majorVersion>.<2-digit-minorVersion><2-digit-patchVersion> Ex: v2.6.1 => 2.0601

Parameters:

artifactId - a String object

Returns:

the version Gauge value for the given artifactId

convertSemVerToGauge

public static double convertSemVerToGauge(java.lang.String version)

convertSemVerToGauge.

Parameters:

version - a String object

Returns:

a double