Package io.prometheus.client.servlet.common.exporter

Class Exporter

java.lang.Object

io.prometheus.client.servlet.common.exporter.Exporter

public class Exporter
extends Object

The MetricsServlet class exists to provide a simple way of exposing the metrics values.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME_MUST_BE_EQUAL_TO
static final String	NAME_MUST_NOT_BE_EQUAL_TO
static final String	NAME_MUST_NOT_START_WITH
static final String	NAME_MUST_START_WITH
private CollectorRegistry	registry
private Predicate<String>	sampleNameFilter

Constructor Summary

Constructors

Constructor	Description
Exporter(CollectorRegistry registry, Predicate<String> sampleNameFilter)	Construct a MetricsServlet for the given registry.

Method Summary

Modifier and Type	Method	Description
void	doGet(HttpServletRequestAdapter req, HttpServletResponseAdapter resp)
void	doPost(HttpServletRequestAdapter req, HttpServletResponseAdapter resp)
void	init(ServletConfigAdapter servletConfig)
private Set<String>	parse(HttpServletRequestAdapter req)

Methods inherited from class java.lang.Object

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

Field Details

NAME_MUST_BE_EQUAL_TO

public static final String NAME_MUST_BE_EQUAL_TO

See Also:

• Constant Field Values

NAME_MUST_NOT_BE_EQUAL_TO

public static final String NAME_MUST_NOT_BE_EQUAL_TO

See Also:

• Constant Field Values

NAME_MUST_START_WITH

public static final String NAME_MUST_START_WITH

See Also:

• Constant Field Values

NAME_MUST_NOT_START_WITH

public static final String NAME_MUST_NOT_START_WITH

See Also:

• Constant Field Values

registry

private CollectorRegistry registry

sampleNameFilter

private Predicate<String> sampleNameFilter

Constructor Details

Exporter

public Exporter(CollectorRegistry registry,
 Predicate<String> sampleNameFilter)

Construct a MetricsServlet for the given registry.

Parameters:

registry - collector registry

sampleNameFilter - programmatically set a SampleNameFilter. If there are any filter options configured in ServletConfig, they will be merged so that samples need to pass both filters to be exported. sampleNameFilter may be null indicating that nothing should be filtered.

Method Details

init

public void init(ServletConfigAdapter servletConfig)
          throws ServletConfigurationException

Throws:

ServletConfigurationException

doGet

public void doGet(HttpServletRequestAdapter req,
 HttpServletResponseAdapter resp)
           throws IOException

Throws:

IOException

parse

private Set<String> parse(HttpServletRequestAdapter req)

doPost

public void doPost(HttpServletRequestAdapter req,
 HttpServletResponseAdapter resp)
            throws IOException

Throws:

IOException