Class Filter

java.lang.Object

io.prometheus.client.servlet.common.filter.Filter

public class Filter
extends Object

Filter implements the common functionality provided by the two MetricsFilter implementations:

• javax version: io.prometheus.client.filter.MetricsFilter provided by simpleclient_servlet
• jakarta version: io.prometheus.client.servlet.jakarta.filter.MetricsFilter provided by simpleclient_servlet_jakarta

Author:

Andrew Stuart <andrew.stuart2@gmail.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Filter.MetricData

Constructor Summary

Constructors

Constructor	Description
Filter()
Filter(String metricName, String help, Integer pathComponents, double[] buckets, boolean stripContextPath)	If you want to configure the filter programmatically instead of via web.xml, you can pass all configuration parameters to this constructor.

Method Summary

Modifier and Type	Method	Description
void	init(FilterConfigAdapter filterConfig)	Common implementation of javax.servlet.Filter.init() and jakarta.servlet.Filter.init().
void	observeDuration(Filter.MetricData data, HttpServletResponseAdapter resp)	To be called at the end of javax.servlet.Filter.doFilter() or jakarta.servlet.Filter.doFilter().
Filter.MetricData	startTimer(HttpServletRequestAdapter request)	To be called at the beginning of javax.servlet.Filter.doFilter() or jakarta.servlet.Filter.doFilter().

Methods inherited from class Object

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

Constructor Details

Filter

public Filter()

Filter

public Filter(String metricName,
 String help,
 Integer pathComponents,
 double[] buckets,
 boolean stripContextPath)

If you want to configure the filter programmatically instead of via web.xml, you can pass all configuration parameters to this constructor.

Method Details

init

public void init(FilterConfigAdapter filterConfig)
          throws FilterConfigurationException

Common implementation of javax.servlet.Filter.init() and jakarta.servlet.Filter.init().

Throws:

FilterConfigurationException

startTimer

public Filter.MetricData startTimer(HttpServletRequestAdapter request)

To be called at the beginning of javax.servlet.Filter.doFilter() or jakarta.servlet.Filter.doFilter().

observeDuration

public void observeDuration(Filter.MetricData data,
 HttpServletResponseAdapter resp)

To be called at the end of javax.servlet.Filter.doFilter() or jakarta.servlet.Filter.doFilter().