Class HTTPServer

java.lang.Object

io.prometheus.metrics.exporter.httpserver.HTTPServer

All Implemented Interfaces:

Closeable, AutoCloseable

public class HTTPServer
extends Object
implements Closeable

Expose Prometheus metrics using a plain Java HttpServer.

Example Usage:

HTTPServer server = HTTPServer.builder()
    .port(9090)
    .buildAndStart();

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HTTPServer.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected final ExecutorService	executorService
protected final HttpServer	server

Constructor Summary

Constructors

Modifier	Constructor	Description
private	HTTPServer(PrometheusProperties config, ExecutorService executorService, HttpServer httpServer, PrometheusRegistry registry, Authenticator authenticator, String authenticatedSubjectAttributeName, HttpHandler defaultHandler, String metricsHandlerPath, Boolean registerHealthHandler)

Method Summary

Modifier and Type	Method	Description
static HTTPServer.Builder	builder()
static HTTPServer.Builder	builder(PrometheusProperties config)
void	close()	Stop the HTTPServer.
private void	drainInputAndClose(HttpExchange httpExchange)
private String	getMetricsPath(String metricsHandlerPath)
int	getPort()	Gets the port number.
private void	registerHandler(String path, HttpHandler handler, Authenticator authenticator, String subjectAttributeName)
void	stop()	Stop the HTTP server.
private HttpHandler	wrapWithDoAs(HttpHandler handler, String subjectAttributeName)

Methods inherited from class Object

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

Field Details

server

protected final HttpServer server

executorService

protected final ExecutorService executorService

Constructor Details

HTTPServer

private HTTPServer(PrometheusProperties config,
 ExecutorService executorService,
 HttpServer httpServer,
 PrometheusRegistry registry,
 Authenticator authenticator,
 String authenticatedSubjectAttributeName,
 HttpHandler defaultHandler,
 String metricsHandlerPath,
 Boolean registerHealthHandler)

Method Details

getMetricsPath

private String getMetricsPath(String metricsHandlerPath)

registerHandler

private void registerHandler(String path,
 HttpHandler handler,
 Authenticator authenticator,
 String subjectAttributeName)

wrapWithDoAs

private HttpHandler wrapWithDoAs(HttpHandler handler,
 String subjectAttributeName)

drainInputAndClose

private void drainInputAndClose(HttpExchange httpExchange)
                         throws IOException

Throws:

IOException

stop

public void stop()

Stop the HTTP server. Same as close().

close

public void close()

Stop the HTTPServer. Same as stop().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getPort

public int getPort()

Gets the port number. This is useful if you did not specify a port and the server picked a free port automatically.

builder

public static HTTPServer.Builder builder()

builder

public static HTTPServer.Builder builder(PrometheusProperties config)