com.wavefront.sdk.common.Utils Maven / Gradle / Ivy
package com.wavefront.sdk.common;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.wavefront.sdk.common.annotation.NonNull;
import com.wavefront.sdk.common.annotation.Nullable;
import com.wavefront.sdk.entities.histograms.HistogramGranularity;
import com.wavefront.sdk.entities.tracing.SpanLog;
import com.wavefront.sdk.entities.tracing.SpanLogsDTO;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.Logger;
import static com.wavefront.sdk.common.Constants.SPAN_LOG_KEY;
/**
* Common Util methods
*
* @author Sushant Dewan ([email protected]).
*/
public class Utils {
private static final Logger logger = Logger.getLogger(
Utils.class.getCanonicalName());
private static final ObjectMapper JSON_PARSER = new ObjectMapper();
public static String sanitize(String s) {
return sanitizeInternal(s, true);
}
public static String sanitizeWithoutQuotes(String s) {
return sanitizeInternal(s, false);
}
public static String sanitizeValue(String s) {
/*
* Sanitize string of tags value, etc.
*/
String res = s.trim();
if (s.contains("\"") || s.contains("'")) {
// for single quotes, once we are double-quoted, single quotes can exist happily inside it.
res = res.replaceAll("\"", "\\\\\"");
}
return "\"" + res.replaceAll("\\n", "\\\\n") + "\"";
}
public static String metricToLineData(String name, double value, @Nullable Long timestamp,
String source, @Nullable Map tags,
String defaultSource) {
/*
* Wavefront Metrics Data format
* [] source= [pointTags]
*
* Example: "new-york.power.usage 42422 1533531013 source=localhost datacenter=dc1"
*/
if (name == null || name.isEmpty()) {
throw new IllegalArgumentException("metrics name cannot be blank");
}
if (source == null || source.isEmpty()) {
source = defaultSource;
}
final StringBuilder sb = new StringBuilder();
sb.append(sanitize(name));
sb.append(' ');
sb.append(value);
if (timestamp != null) {
sb.append(' ');
sb.append(timestamp);
}
sb.append(" source=");
sb.append(sanitize(source));
if (tags != null) {
for (final Map.Entry tag : tags.entrySet()) {
String key = tag.getKey();
String val = tag.getValue();
if (key == null || key.isEmpty()) {
throw new IllegalArgumentException("metric point tag key cannot be blank");
}
if (val == null || val.isEmpty()) {
throw new IllegalArgumentException("metric point tag value cannot be blank for " +
"tag key: " + key);
}
sb.append(' ');
sb.append(sanitize(key));
sb.append('=');
sb.append(sanitizeValue(val));
}
}
sb.append('\n');
return sb.toString();
}
public static String histogramToLineData(String name, List> centroids,
Set histogramGranularities,
@Nullable Long timestamp, String source,
@Nullable Map tags,
String defaultSource) {
/*
* Wavefront Histogram Data format
* {!M | !H | !D} [] # [centroids] source=
* [pointTags]
*
* Example: "!M 1533531013 #20 30.0 #10 5.1 request.latency source=appServer1 region=us-west"
*/
if (name == null || name.isEmpty()) {
throw new IllegalArgumentException("histogram name cannot be blank");
}
if (histogramGranularities == null || histogramGranularities.isEmpty()) {
throw new IllegalArgumentException("Histogram granularities cannot be null or empty");
}
if (centroids == null || centroids.isEmpty()) {
throw new IllegalArgumentException("A distribution should have at least one centroid");
}
if (source == null || source.isEmpty()) {
source = defaultSource;
}
final StringBuilder sb = new StringBuilder();
for (HistogramGranularity histogramGranularity : histogramGranularities) {
sb.append(histogramGranularity.identifier);
if (timestamp != null) {
sb.append(' ');
sb.append(Long.toString(timestamp));
}
for (Pair centroid : centroids) {
sb.append(" #");
sb.append(centroid._2);
sb.append(' ');
sb.append(centroid._1);
}
sb.append(' ');
sb.append(sanitize(name));
sb.append(" source=");
sb.append(sanitize(source));
if (tags != null) {
for (final Map.Entry tag : tags.entrySet()) {
String key = tag.getKey();
String val = tag.getValue();
if (key == null || key.isEmpty()) {
throw new IllegalArgumentException("histogram tag key cannot be blank");
}
if (val == null || val.isEmpty()) {
throw new IllegalArgumentException("histogram tag value cannot be blank for " +
"tag key: " + key);
}
sb.append(' ');
sb.append(sanitize(tag.getKey()));
sb.append('=');
sb.append(sanitizeValue(tag.getValue()));
}
}
sb.append('\n');
}
return sb.toString();
}
public static String tracingSpanToLineData(String name, long startMillis, long durationMillis,
String source, UUID traceId, UUID spanId,
@Nullable List parents,
@Nullable List followsFrom,
@Nullable List> tags,
@Nullable List spanLogs, String defaultSource) {
/*
* Wavefront Tracing Span Data format
* source= [pointTags]
*
* Example: "getAllUsers source=localhost
* traceId=7b3bf470-9456-11e8-9eb6-529269fb1459
* spanId=0313bafe-9457-11e8-9eb6-529269fb1459
* parent=2f64e538-9457-11e8-9eb6-529269fb1459
* application=Wavefront http.method=GET
* 1533531013 343500"
*/
if (name == null || name.isEmpty()) {
throw new IllegalArgumentException("span name cannot be blank");
}
if (source == null || source.isEmpty()) {
source = defaultSource;
}
final StringBuilder sb = new StringBuilder();
sb.append(sanitizeValue(name));
sb.append(" source=");
sb.append(sanitize(source));
sb.append(" traceId=");
sb.append(traceId);
sb.append(" spanId=");
sb.append(spanId);
if (parents != null) {
for (UUID parent : parents) {
sb.append(" parent=");
sb.append(parent.toString());
}
}
if (followsFrom != null) {
for (UUID item : followsFrom) {
sb.append(" followsFrom=");
sb.append(item.toString());
}
}
if (tags != null) {
for (final Pair tag : tags) {
String key = tag._1;
String val = tag._2;
if (key == null || key.isEmpty()) {
throw new IllegalArgumentException("span tag key cannot be blank");
}
if (val == null || val.isEmpty()) {
throw new IllegalArgumentException("span tag value cannot be blank for " +
"tag key: " + key);
}
sb.append(' ');
sb.append(sanitize(key));
sb.append('=');
sb.append(sanitizeValue(val));
}
}
if (spanLogs != null && !spanLogs.isEmpty()) {
sb.append(' ');
sb.append(sanitize(SPAN_LOG_KEY));
sb.append('=');
sb.append(sanitize("true"));
}
sb.append(' ');
sb.append(startMillis);
sb.append(' ');
sb.append(durationMillis);
// TODO - Support SpanLogs
sb.append('\n');
return sb.toString();
}
public static String spanLogsToLineData(UUID traceId, UUID spanId, @NonNull List spanLogs)
throws JsonProcessingException {
/*
* Wavefront Span Log Data format
* Example:
* {
* "traceId": "7b3bf470-9456-11e8-9eb6-529269fb1459",
* "spanId": "0313bafe-9457-11e8-9eb6-529269fb1459",
* "logs": [
* {
* "timestamp": "1533531013",
* "fields": {
* "event": "error",
* "error.kind": "exception",
* "message": "timed out",
* "stack": "File \"example.py\", line 7, in \\ncaller()\nFile \"example.py\""
* }
* }
* ]
* }
*/
StringBuilder toReturn = new StringBuilder();
toReturn.append(JSON_PARSER.writeValueAsString(new SpanLogsDTO(traceId, spanId, spanLogs)));
toReturn.append("\n");
return toReturn.toString();
}
public static void shutdownExecutorAndWait(ExecutorService tpe) {
tpe.shutdown();
try {
if (!tpe.awaitTermination(60, TimeUnit.SECONDS)) {
tpe.shutdownNow();
if (!tpe.awaitTermination(60, TimeUnit.SECONDS))
logger.log(Level.FINE, "pool did not terminate");
}
} catch (InterruptedException ie) {
tpe.shutdownNow();
Thread.currentThread().interrupt();
}
}
private static String sanitizeInternal(String s, boolean addQuotes) {
/*
* Sanitize string of metric name, source and key of tags according to the rule of Wavefront proxy.
*/
StringBuilder sb = new StringBuilder();
if (addQuotes) {
sb.append('"');
}
for (int i = 0; i < s.length(); i++) {
char cur = s.charAt(i);
boolean isLegal = true;
if (!(44 <= cur && cur <= 57) && !(65 <= cur && cur <= 90) && !(97 <= cur && cur <= 122) &&
cur != 95) {
if (!((i == 0 && cur == 0x2206) || (i == 0 && cur == 0x0394) || (i == 0 && cur == 126))) {
// first character can also be \u2206 (∆ - INCREMENT) or \u0394 (Δ - GREEK CAPITAL LETTER DELTA)
// or ~ tilda character for internal metrics
isLegal = false;
}
}
if (cur == '/') {
isLegal = false;
}
sb.append(isLegal ? cur : '-');
}
if (addQuotes) {
sb.append('"');
}
return sb.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy