Class PrometheusTextFormatWriter

java.lang.Object

io.prometheus.metrics.expositionformats.PrometheusTextFormatWriter

All Implemented Interfaces:

ExpositionFormatWriter

public class PrometheusTextFormatWriter
extends Object
implements ExpositionFormatWriter

Write the Prometheus text format. This is the default if you view a Prometheus endpoint with your Web browser.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrometheusTextFormatWriter.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
private final boolean	timestampsInMs
private final boolean	writeCreatedTimestamps

Constructor Summary

Constructors

Modifier	Constructor	Description
	PrometheusTextFormatWriter(boolean writeCreatedTimestamps)	Deprecated. this constructor is deprecated and will be removed in the next major version - builder() or create() instead
private	PrometheusTextFormatWriter(boolean writeCreatedTimestamps, boolean timestampsInMs)

Method Summary

Modifier and Type	Method	Description
boolean	accepts(String acceptHeader)
static PrometheusTextFormatWriter.Builder	builder()
static PrometheusTextFormatWriter	create()
private ClassicHistogramBuckets	getClassicBuckets(HistogramSnapshot.HistogramDataPointSnapshot data)
String	getContentType()
void	write(OutputStream out, MetricSnapshots metricSnapshots, EscapingScheme scheme)	Writes the given metric snapshots to the output stream using the specified escaping scheme.
private void	writeCounter(Writer writer, CounterSnapshot snapshot, EscapingScheme scheme)
void	writeCreated(Writer writer, MetricSnapshot snapshot, EscapingScheme scheme)
private void	writeEscapedHelp(Writer writer, String s)
private void	writeGauge(Writer writer, GaugeSnapshot snapshot, EscapingScheme scheme)
private void	writeGaugeCountSum(Writer writer, HistogramSnapshot snapshot, MetricMetadata metadata, EscapingScheme scheme)
private void	writeHistogram(Writer writer, HistogramSnapshot snapshot, EscapingScheme scheme)
private void	writeInfo(Writer writer, InfoSnapshot snapshot, EscapingScheme scheme)
private void	writeMetadata(Writer writer, String suffix, String typeString, MetricMetadata metadata, EscapingScheme scheme)
private void	writeNameAndLabels(Writer writer, String name, String suffix, Labels labels, EscapingScheme escapingScheme)
private void	writeNameAndLabels(Writer writer, String name, String suffix, Labels labels, EscapingScheme scheme, String additionalLabelName, double additionalLabelValue)
private void	writeScrapeTimestampAndNewline(Writer writer, DataPointSnapshot data)
private void	writeStateSet(Writer writer, StateSetSnapshot snapshot, EscapingScheme scheme)
private void	writeSummary(Writer writer, SummarySnapshot snapshot, EscapingScheme scheme)
private void	writeUnknown(Writer writer, UnknownSnapshot snapshot, EscapingScheme scheme)

Methods inherited from class Object

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

Methods inherited from interface ExpositionFormatWriter

isAvailable, toDebugString, toDebugString, write

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

writeCreatedTimestamps

private final boolean writeCreatedTimestamps

timestampsInMs

private final boolean timestampsInMs

Constructor Details

PrometheusTextFormatWriter

@Deprecated
public PrometheusTextFormatWriter(boolean writeCreatedTimestamps)

Deprecated.

this constructor is deprecated and will be removed in the next major version - builder() or create() instead

Parameters:

writeCreatedTimestamps - whether to include the _created timestamp in the output - This will produce an invalid OpenMetrics output, but is kept for backwards compatibility.

PrometheusTextFormatWriter

private PrometheusTextFormatWriter(boolean writeCreatedTimestamps,
 boolean timestampsInMs)

Method Details

builder

public static PrometheusTextFormatWriter.Builder builder()

create

public static PrometheusTextFormatWriter create()

accepts

public boolean accepts(String acceptHeader)

Specified by:

accepts in interface ExpositionFormatWriter

getContentType

public String getContentType()

Specified by:

getContentType in interface ExpositionFormatWriter

write

public void write(OutputStream out,
 MetricSnapshots metricSnapshots,
 EscapingScheme scheme)
           throws IOException

Description copied from interface: ExpositionFormatWriter

Writes the given metric snapshots to the output stream using the specified escaping scheme.

Specified by:

write in interface ExpositionFormatWriter

Throws:

IOException

writeCreated

public void writeCreated(Writer writer,
 MetricSnapshot snapshot,
 EscapingScheme scheme)
                  throws IOException

Throws:

IOException

writeCounter

private void writeCounter(Writer writer,
 CounterSnapshot snapshot,
 EscapingScheme scheme)
                   throws IOException

Throws:

IOException

writeGauge

private void writeGauge(Writer writer,
 GaugeSnapshot snapshot,
 EscapingScheme scheme)
                 throws IOException

Throws:

IOException

writeHistogram

private void writeHistogram(Writer writer,
 HistogramSnapshot snapshot,
 EscapingScheme scheme)
                     throws IOException

Throws:

IOException

getClassicBuckets

private ClassicHistogramBuckets getClassicBuckets(HistogramSnapshot.HistogramDataPointSnapshot data)

writeGaugeCountSum

private void writeGaugeCountSum(Writer writer,
 HistogramSnapshot snapshot,
 MetricMetadata metadata,
 EscapingScheme scheme)
                         throws IOException

Throws:

IOException

writeSummary

private void writeSummary(Writer writer,
 SummarySnapshot snapshot,
 EscapingScheme scheme)
                   throws IOException

Throws:

IOException

writeInfo

private void writeInfo(Writer writer,
 InfoSnapshot snapshot,
 EscapingScheme scheme)
                throws IOException

Throws:

IOException

writeStateSet

private void writeStateSet(Writer writer,
 StateSetSnapshot snapshot,
 EscapingScheme scheme)
                    throws IOException

Throws:

IOException

writeUnknown

private void writeUnknown(Writer writer,
 UnknownSnapshot snapshot,
 EscapingScheme scheme)
                   throws IOException

Throws:

IOException

writeNameAndLabels

private void writeNameAndLabels(Writer writer,
 String name,
 String suffix,
 Labels labels,
 EscapingScheme escapingScheme)
                         throws IOException

Throws:

IOException

writeNameAndLabels

private void writeNameAndLabels(Writer writer,
 String name,
 String suffix,
 Labels labels,
 EscapingScheme scheme,
 String additionalLabelName,
 double additionalLabelValue)
                         throws IOException

Throws:

IOException

writeMetadata

private void writeMetadata(Writer writer,
 String suffix,
 String typeString,
 MetricMetadata metadata,
 EscapingScheme scheme)
                    throws IOException

Throws:

IOException

writeEscapedHelp

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

Throws:

IOException

writeScrapeTimestampAndNewline

private void writeScrapeTimestampAndNewline(Writer writer,
 DataPointSnapshot data)
                                     throws IOException

Throws:

IOException