Package io.prometheus.metrics.expositionformats

Class PrometheusTextFormatWriter

Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	accepts(String acceptHeader)
static PrometheusTextFormatWriter.Builder	builder()
static PrometheusTextFormatWriter	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.
void	writeCreated(Writer writer, MetricSnapshot snapshot, EscapingScheme 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

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.

Method Details

builder

public static PrometheusTextFormatWriter.Builder builder()

create

public static PrometheusTextFormatWriter 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

writeCreated

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

Throws:

IOException