Class TextFormat

java.lang.Object

io.prometheus.client.exporter.common.TextFormat

public class TextFormat
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE_004	Content-type for Prometheus text version 0.0.4.
static final String	CONTENT_TYPE_OPENMETRICS_100	Content-type for Openmetrics text version 1.0.0.

Constructor Summary

Constructors

Constructor	Description
TextFormat()

Method Summary

Modifier and Type	Method	Description
static String	chooseContentType(String acceptHeader)	Return the content type that should be used for a given Accept HTTP header.
private static String	omTypeString(Collector.Type t)
(package private) static void	omWriteTimestamp(Writer writer, long timestampMs)
private static String	typeString(Collector.Type t)
static void	write004(Writer writer, Enumeration<Collector.MetricFamilySamples> mfs)	Write out the text version 0.0.4 of the given MetricFamilySamples.
private static void	writeEscapedHelp(Writer writer, String s)
private static void	writeEscapedLabelValue(Writer writer, String s)
static void	writeFormat(String contentType, Writer writer, Enumeration<Collector.MetricFamilySamples> mfs)	Write out the given MetricFamilySamples in a format per the contentType.
static void	writeOpenMetrics100(Writer writer, Enumeration<Collector.MetricFamilySamples> mfs)	Write out the OpenMetrics text version 1.0.0 of the given MetricFamilySamples.

Methods inherited from class Object

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

Field Details

CONTENT_TYPE_004

public static final String CONTENT_TYPE_004

Content-type for Prometheus text version 0.0.4.

See Also:

• Constant Field Values

CONTENT_TYPE_OPENMETRICS_100

public static final String CONTENT_TYPE_OPENMETRICS_100

Content-type for Openmetrics text version 1.0.0.

Since:

0.10.0

See Also:

• Constant Field Values

Constructor Details

TextFormat

public TextFormat()

Method Details

chooseContentType

public static String chooseContentType(String acceptHeader)

Return the content type that should be used for a given Accept HTTP header.

Since:

0.10.0

writeFormat

public static void writeFormat(String contentType,
 Writer writer,
 Enumeration<Collector.MetricFamilySamples> mfs)
                        throws IOException

Write out the given MetricFamilySamples in a format per the contentType.

Throws:

IOException

Since:

0.10.0

write004

public static void write004(Writer writer,
 Enumeration<Collector.MetricFamilySamples> mfs)
                     throws IOException

Write out the text version 0.0.4 of the given MetricFamilySamples.

Throws:

IOException

writeEscapedHelp

private static void writeEscapedHelp(Writer writer,
 String s)
                              throws IOException

Throws:

IOException

writeEscapedLabelValue

private static void writeEscapedLabelValue(Writer writer,
 String s)
                                    throws IOException

Throws:

IOException

typeString

private static String typeString(Collector.Type t)

writeOpenMetrics100

public static void writeOpenMetrics100(Writer writer,
 Enumeration<Collector.MetricFamilySamples> mfs)
                                throws IOException

Write out the OpenMetrics text version 1.0.0 of the given MetricFamilySamples.

Throws:

IOException

Since:

0.10.0

omWriteTimestamp

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

Throws:

IOException

omTypeString

private static String omTypeString(Collector.Type t)