Class OpenMetrics2TextFormatWriter

Object

OpenMetrics2TextFormatWriter

All Implemented Interfaces:

ExpositionFormatWriter

public class OpenMetrics2TextFormatWriter
extends Object
implements ExpositionFormatWriter

Write the OpenMetrics 2.0 text format. Unlike the OM1 writer, this writer outputs metric names as provided by the user — no _total or unit suffix appending. The _info suffix is enforced per the OM2 spec (MUST). 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

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()
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.

Methods inherited from class Object

equals, 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

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(@Nullable
 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