Package io.prometheus.metrics.expositionformats

Class PrometheusProtobufWriter

Object

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(MetricSnapshots metricSnapshots, EscapingScheme escapingScheme)	Converts the metric snapshots to a debug string using the specified escaping scheme.
void	write(OutputStream out, MetricSnapshots metricSnapshots, EscapingScheme escapingScheme)	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

toDebugString, write

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(@Nullable
 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(MetricSnapshots metricSnapshots,
 EscapingScheme escapingScheme)

Description copied from interface: ExpositionFormatWriter

Converts the metric snapshots to a debug string using the specified escaping scheme.

Specified by:

toDebugString in interface ExpositionFormatWriter

write

public void write(OutputStream out,
 MetricSnapshots metricSnapshots,
 EscapingScheme escapingScheme)
           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