alluxio.metrics.sink

Class PrometheusMetricsServlet

java.lang.Object

alluxio.metrics.sink.PrometheusMetricsServlet

All Implemented Interfaces:

Sink

@NotThreadSafe
public class PrometheusMetricsServlet
extends Object
implements Sink

A sink that exposes metrics data in prometheus format by HTTP. See https://github.com/prometheus/client_java/issues/101

Constructor Summary

Constructors

Constructor and Description
PrometheusMetricsServlet(com.codahale.metrics.MetricRegistry registry) Creates a new PrometheusMetricsServlet with a MetricRegistry.
PrometheusMetricsServlet(Properties properties, com.codahale.metrics.MetricRegistry registry) Creates a new PrometheusMetricsServlet with a MetricRegistry.

Method Summary

Modifier and Type	Method and Description
org.eclipse.jetty.servlet.ServletContextHandler	getHandler() Gets the ServletContextHandler of the metrics servlet.
void	report() Reports the current values of all metrics.
void	start() Starts the reporter polling.
void	stop() Stops the reporter.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrometheusMetricsServlet

public PrometheusMetricsServlet(com.codahale.metrics.MetricRegistry registry)

Creates a new PrometheusMetricsServlet with a MetricRegistry.

Parameters:

registry - the metric registry to register

PrometheusMetricsServlet

public PrometheusMetricsServlet(Properties properties,
                                com.codahale.metrics.MetricRegistry registry)

Creates a new PrometheusMetricsServlet with a MetricRegistry.

Parameters:

properties - the properties, not used for now

registry - the metric registry to register

Method Detail

getHandler

public org.eclipse.jetty.servlet.ServletContextHandler getHandler()

Gets the ServletContextHandler of the metrics servlet.

Returns:

the ServletContextHandler object

start

public void start()

Description copied from interface: Sink

Starts the reporter polling.

Specified by:

start in interface Sink

stop

public void stop()

Description copied from interface: Sink

Stops the reporter.

Specified by:

stop in interface Sink

report

public void report()

Description copied from interface: Sink

Reports the current values of all metrics.

Specified by:

report in interface Sink