Module io.prometheus.writer.text

Package io.prometheus.metrics.expositionformats

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE

Constructor Summary

Constructors

Constructor	Description
PrometheusTextFormatWriter(boolean writeCreatedTimestamps)

Method Summary

Modifier and Type	Method	Description
boolean	accepts(String acceptHeader)
String	getContentType()
void	write(OutputStream out, io.prometheus.metrics.model.snapshots.MetricSnapshots metricSnapshots)	Text formats use UTF-8 encoding.
void	writeCreated(OutputStreamWriter writer, io.prometheus.metrics.model.snapshots.MetricSnapshot snapshot)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.prometheus.metrics.expositionformats.ExpositionFormatWriter

isAvailable, toDebugString

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

Constructor Details

PrometheusTextFormatWriter

public PrometheusTextFormatWriter(boolean writeCreatedTimestamps)

Method Details

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,
 io.prometheus.metrics.model.snapshots.MetricSnapshots metricSnapshots)
           throws IOException

Description copied from interface: ExpositionFormatWriter

Text formats use UTF-8 encoding.

Specified by:

write in interface ExpositionFormatWriter

Throws:

IOException

writeCreated

public void writeCreated(OutputStreamWriter writer,
 io.prometheus.metrics.model.snapshots.MetricSnapshot snapshot)
                  throws IOException

Throws:

IOException