Module io.prometheus.writer.text

Package io.prometheus.metrics.expositionformats

Class PrometheusProtobufWriter

java.lang.Object

io.prometheus.metrics.expositionformats.PrometheusProtobufWriter

All Implemented Interfaces:

ExpositionFormatWriter

public class PrometheusProtobufWriter
extends Object
implements ExpositionFormatWriter

Write the Prometheus protobuf format as defined in github.com/prometheus/client_model.

As of today, this is the only exposition format that supports native histograms.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE

Constructor Summary

Constructors

Constructor	Description
PrometheusProtobufWriter()

Method Summary

Modifier and Type	Method	Description
boolean	accepts(String acceptHeader)
String	getContentType()
boolean	isAvailable()	Returns true if the writer is available.
String	toDebugString(io.prometheus.metrics.model.snapshots.MetricSnapshots metricSnapshots)
void	write(OutputStream out, io.prometheus.metrics.model.snapshots.MetricSnapshots metricSnapshots)	Text formats use UTF-8 encoding.

Methods inherited from class java.lang.Object

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

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

Constructor Details

PrometheusProtobufWriter

public PrometheusProtobufWriter()

Method Details

accepts

public boolean accepts(String acceptHeader)

Specified by:

accepts in interface ExpositionFormatWriter

getContentType

public String getContentType()

Specified by:

getContentType in interface ExpositionFormatWriter

isAvailable

public boolean isAvailable()

Description copied from interface: ExpositionFormatWriter

Returns true if the writer is available. If false, the writer will throw an exception if used.

Specified by:

isAvailable in interface ExpositionFormatWriter

toDebugString

public String toDebugString(io.prometheus.metrics.model.snapshots.MetricSnapshots metricSnapshots)

Specified by:

toDebugString 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