Class OpenMetrics2TextFormatWriter

java.lang.Object

io.prometheus.metrics.expositionformats.OpenMetrics2TextFormatWriter

All Implemented Interfaces:

ExpositionFormatWriter

public class OpenMetrics2TextFormatWriter
extends Object
implements ExpositionFormatWriter

Write the OpenMetrics 2.0 text format. This is currently a skeleton implementation that produces identical output to OpenMetrics 1.0, with infrastructure for future OM2 features. This is experimental and subject to change as the OpenMetrics 2.0 specification evolves.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenMetrics2TextFormatWriter.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
private final boolean	createdTimestampsEnabled
private final boolean	exemplarsOnAllMetricTypesEnabled
private final OpenMetrics2Properties	openMetrics2Properties

Constructor Summary

Constructors

Constructor	Description
OpenMetrics2TextFormatWriter(OpenMetrics2Properties openMetrics2Properties, boolean createdTimestampsEnabled, boolean exemplarsOnAllMetricTypesEnabled)

Method Summary

Modifier and Type	Method	Description
boolean	accepts(String acceptHeader)
static OpenMetrics2TextFormatWriter.Builder	builder()
static OpenMetrics2TextFormatWriter	create()
private ClassicHistogramBuckets	getClassicBuckets(HistogramSnapshot.HistogramDataPointSnapshot data)
String	getContentType()
OpenMetrics2Properties	getOpenMetrics2Properties()
void	write(OutputStream out, MetricSnapshots metricSnapshots, EscapingScheme scheme)	Writes the given metric snapshots to the output stream using the specified escaping scheme.
private void	writeClassicHistogramBuckets(Writer writer, MetricMetadata metadata, String countSuffix, String sumSuffix, List<HistogramSnapshot.HistogramDataPointSnapshot> dataList, EscapingScheme scheme)
private void	writeCountAndSum(Writer writer, MetricMetadata metadata, DistributionDataPointSnapshot data, String countSuffix, String sumSuffix, Exemplars exemplars, EscapingScheme scheme)
private void	writeCounter(Writer writer, CounterSnapshot snapshot, EscapingScheme scheme)
private void	writeCreated(Writer writer, MetricMetadata metadata, DataPointSnapshot data, EscapingScheme scheme)
private void	writeGauge(Writer writer, GaugeSnapshot snapshot, 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 typeName, 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 escapingScheme, String additionalLabelName, double additionalLabelValue)
private void	writeScrapeTimestampAndExemplar(Writer writer, DataPointSnapshot data, Exemplar exemplar, EscapingScheme scheme)
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

openMetrics2Properties

private final OpenMetrics2Properties openMetrics2Properties

createdTimestampsEnabled

private final boolean createdTimestampsEnabled

exemplarsOnAllMetricTypesEnabled

private final boolean exemplarsOnAllMetricTypesEnabled

Constructor Details

OpenMetrics2TextFormatWriter

public OpenMetrics2TextFormatWriter(OpenMetrics2Properties openMetrics2Properties,
 boolean createdTimestampsEnabled,
 boolean exemplarsOnAllMetricTypesEnabled)

Parameters:

openMetrics2Properties - OpenMetrics 2.0 feature flags

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

exemplarsOnAllMetricTypesEnabled - whether to include exemplars on all metric types

Method Details

builder

public static OpenMetrics2TextFormatWriter.Builder builder()

create

public static OpenMetrics2TextFormatWriter create()

accepts

public boolean accepts(String acceptHeader)

Specified by:

accepts in interface ExpositionFormatWriter

getContentType

public String getContentType()

Specified by:

getContentType in interface ExpositionFormatWriter

getOpenMetrics2Properties

public OpenMetrics2Properties getOpenMetrics2Properties()

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

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

writeClassicHistogramBuckets

private void writeClassicHistogramBuckets(Writer writer,
 MetricMetadata metadata,
 String countSuffix,
 String sumSuffix,
 List<HistogramSnapshot.HistogramDataPointSnapshot> dataList,
 EscapingScheme scheme)
                                   throws IOException

Throws:

IOException

getClassicBuckets

private ClassicHistogramBuckets getClassicBuckets(HistogramSnapshot.HistogramDataPointSnapshot data)

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

writeCountAndSum

private void writeCountAndSum(Writer writer,
 MetricMetadata metadata,
 DistributionDataPointSnapshot data,
 String countSuffix,
 String sumSuffix,
 Exemplars exemplars,
 EscapingScheme scheme)
                       throws IOException

Throws:

IOException

writeCreated

private void writeCreated(Writer writer,
 MetricMetadata metadata,
 DataPointSnapshot data,
 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 escapingScheme,
 String additionalLabelName,
 double additionalLabelValue)
                         throws IOException

Throws:

IOException

writeScrapeTimestampAndExemplar

private void writeScrapeTimestampAndExemplar(Writer writer,
 DataPointSnapshot data,
 Exemplar exemplar,
 EscapingScheme scheme)
                                      throws IOException

Throws:

IOException

writeMetadata

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

Throws:

IOException