Package io.prometheus.metrics.expositionformats

Class OpenMetricsTextFormatWriter

Object

OpenMetricsTextFormatWriter

All Implemented Interfaces:

ExpositionFormatWriter

public class OpenMetricsTextFormatWriter
extends Object
implements ExpositionFormatWriter

Write the OpenMetrics text format as defined on https://openmetrics.io.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenMetricsTextFormatWriter.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE

Constructor Summary

Constructors

Constructor	Description
OpenMetricsTextFormatWriter(boolean createdTimestampsEnabled, boolean exemplarsOnAllMetricTypesEnabled)

Method Summary

Modifier and Type	Method	Description
boolean	accepts(String acceptHeader)
static OpenMetricsTextFormatWriter.Builder	builder()
static OpenMetricsTextFormatWriter	create()
String	getContentType()
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

OpenMetricsTextFormatWriter

public OpenMetricsTextFormatWriter(boolean createdTimestampsEnabled,
 boolean exemplarsOnAllMetricTypesEnabled)

Parameters:

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

Method Details

builder

public static OpenMetricsTextFormatWriter.Builder builder()

create

public static OpenMetricsTextFormatWriter create()

accepts

public boolean accepts(@Nullable
 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