Package org.nuxeo.runtime.metrics.reporter.patch

Class StatsDPayloadBuilder

java.lang.Object

org.nuxeo.runtime.metrics.reporter.patch.StatsDPayloadBuilder

public class StatsDPayloadBuilder
extends Object

Builds metric payload lines in StatsD / DogStatsD protocol format.

Format: metric.name:value|g|#dim1:val1,dim2:val2

Since:

2025.15

Constructor Summary

Constructors

Constructor	Description
StatsDPayloadBuilder(String prefix, String hostname, Map<String,String> dimensions)

Method Summary

Modifier and Type	Method	Description
void	appendMetricLine(StringBuilder sb, String metricName, Map<String,String> metricTags, double value)	Appends a single metric line to the given StringBuilder in StatsD / DogStatsD format.
static String	formatValue(double value)	Formats a numeric value for the metric payload (integer when possible, otherwise decimal with trailing zeros removed).
static String	sanitize(String s)	Sanitizes dimension/tag keys and values for StatsD protocol.
static String	sanitizeMetricName(String s)	Sanitizes metric names for StatsD protocol.

Methods inherited from class java.lang.Object

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

Constructor Details

StatsDPayloadBuilder

public StatsDPayloadBuilder(String prefix,
 String hostname,
 Map<String,String> dimensions)

Method Details

appendMetricLine

public void appendMetricLine(StringBuilder sb,
 String metricName,
 Map<String,String> metricTags,
 double value)

Appends a single metric line to the given StringBuilder in StatsD / DogStatsD format.

sanitizeMetricName

public static String sanitizeMetricName(String s)

Sanitizes metric names for StatsD protocol.

Common rules: letters, numbers, underscores, hyphens, dots (1-250 chars), must start with a letter.

sanitize

public static String sanitize(String s)

Sanitizes dimension/tag keys and values for StatsD protocol.

Common rules: letters, numbers, underscores, hyphens, dots, slashes; cannot start with hyphen, dot, or slash; colons are reserved as key:value separators.

formatValue

public static String formatValue(double value)

Formats a numeric value for the metric payload (integer when possible, otherwise decimal with trailing zeros removed).