Class TextFormatUtil

java.lang.Object

io.prometheus.metrics.expositionformats.TextFormatUtil

public class TextFormatUtil
extends Object

Utility methods for writing Prometheus text exposition formats.

This class provides low-level formatting utilities used by both Prometheus text format and OpenMetrics format writers. It handles escaping, label formatting, timestamp conversion, and merging of duplicate metric names.

Constructor Summary

Constructors

Constructor	Description
TextFormatUtil()

Method Summary

Modifier and Type	Method	Description
static MetricSnapshots	mergeDuplicates(MetricSnapshots metricSnapshots)	Merges snapshots with duplicate Prometheus names by combining their data points.
private static MetricSnapshot	mergeSnapshots(List<MetricSnapshot> snapshots)	Merges multiple snapshots of the same type into a single snapshot with combined data points.
(package private) static void	writeDouble(Writer writer, double d)
(package private) static void	writeEscapedString(Writer writer, String s)
(package private) static void	writeLabels(Writer writer, Labels labels, String additionalLabelName, double additionalLabelValue, boolean metricInsideBraces, EscapingScheme scheme)
(package private) static void	writeLong(Writer writer, long value)
(package private) static void	writeName(Writer writer, String name, NameType nameType)
(package private) static void	writeOpenMetricsTimestamp(Writer writer, long timestampMs)
(package private) static void	writePrometheusTimestamp(Writer writer, long timestampMs, boolean timestampsInMs)

Methods inherited from class Object

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

Constructor Details

TextFormatUtil

public TextFormatUtil()

Method Details

mergeDuplicates

public static MetricSnapshots mergeDuplicates(MetricSnapshots metricSnapshots)

Merges snapshots with duplicate Prometheus names by combining their data points. This ensures only one HELP/TYPE declaration per metric family.

writeLong

static void writeLong(Writer writer,
 long value)
               throws IOException

Throws:

IOException

writeDouble

static void writeDouble(Writer writer,
 double d)
                 throws IOException

Throws:

IOException

writePrometheusTimestamp

static void writePrometheusTimestamp(Writer writer,
 long timestampMs,
 boolean timestampsInMs)
                              throws IOException

Throws:

IOException

writeOpenMetricsTimestamp

static void writeOpenMetricsTimestamp(Writer writer,
 long timestampMs)
                               throws IOException

Throws:

IOException

writeEscapedString

static void writeEscapedString(Writer writer,
 String s)
                        throws IOException

Throws:

IOException

writeLabels

static void writeLabels(Writer writer,
 Labels labels,
 String additionalLabelName,
 double additionalLabelValue,
 boolean metricInsideBraces,
 EscapingScheme scheme)
                 throws IOException

Throws:

IOException

writeName

static void writeName(Writer writer,
 String name,
 NameType nameType)
               throws IOException

Throws:

IOException

mergeSnapshots

private static MetricSnapshot mergeSnapshots(List<MetricSnapshot> snapshots)

Merges multiple snapshots of the same type into a single snapshot with combined data points.