Package io.prometheus.metrics.exporter.httpserver

Class HTTPServer.Builder

java.lang.Object

io.prometheus.metrics.exporter.httpserver.HTTPServer.Builder

Enclosing class:

HTTPServer

public static class HTTPServer.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private String	authenticatedSubjectAttributeName
private Authenticator	authenticator
private final PrometheusProperties	config
private HttpHandler	defaultHandler
private ExecutorService	executorService
private String	hostname
private HttpsConfigurator	httpsConfigurator
private InetAddress	inetAddress
private String	metricsHandlerPath
private Integer	port
private Boolean	registerHealthHandler
private PrometheusRegistry	registry

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder(PrometheusProperties config)

Method Summary

Modifier and Type	Method	Description
private void	assertNull(Object o, String msg)
HTTPServer.Builder	authenticatedSubjectAttributeName(String authenticatedSubjectAttributeName)	Optional: the attribute name of a Subject from a custom authenticator.
HTTPServer.Builder	authenticator(Authenticator authenticator)	Optional: Authenticator for authentication.
HTTPServer	buildAndStart()	Build and start the HTTPServer.
HTTPServer.Builder	defaultHandler(HttpHandler defaultHandler)	Optional: Override default handler, i.e.
HTTPServer.Builder	executorService(ExecutorService executorService)	Optional: ExecutorService used by the httpServer.
private int	findPort()
HTTPServer.Builder	hostname(String hostname)	Use this hostname to resolve the IP address to bind to.
HTTPServer.Builder	httpsConfigurator(HttpsConfigurator configurator)	Optional: HttpsConfigurator for TLS/SSL
HTTPServer.Builder	inetAddress(InetAddress address)	Bind to this IP address.
private ExecutorService	makeExecutorService()
private InetSocketAddress	makeInetSocketAddress()
HTTPServer.Builder	metricsHandlerPath(String metricsHandlerPath)	Optional: Override default path for the metrics endpoint.
HTTPServer.Builder	port(int port)	Port to bind to.
HTTPServer.Builder	registerHealthHandler(boolean registerHealthHandler)	Optional: Override if the health handler should be registered.
HTTPServer.Builder	registry(PrometheusRegistry registry)	Optional: Default is PrometheusRegistry.defaultRegistry.

Methods inherited from class java.lang.Object

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

Field Details

config

private final PrometheusProperties config

port

private Integer port

hostname

private String hostname

inetAddress

private InetAddress inetAddress

executorService

private ExecutorService executorService

registry

private PrometheusRegistry registry

authenticator

private Authenticator authenticator

authenticatedSubjectAttributeName

private String authenticatedSubjectAttributeName

httpsConfigurator

private HttpsConfigurator httpsConfigurator

defaultHandler

private HttpHandler defaultHandler

metricsHandlerPath

private String metricsHandlerPath

registerHealthHandler

private Boolean registerHealthHandler

Constructor Details

Builder

private Builder(PrometheusProperties config)

Method Details

port

public HTTPServer.Builder port(int port)

Port to bind to. Default is 0, indicating that a random port will be selected. You can learn the randomly selected port by calling HTTPServer.getPort().

hostname

public HTTPServer.Builder hostname(String hostname)

Use this hostname to resolve the IP address to bind to. Must not be called together with inetAddress(InetAddress). Default is empty, indicating that the HTTPServer binds to the wildcard address.

inetAddress

public HTTPServer.Builder inetAddress(InetAddress address)

Bind to this IP address. Must not be called together with hostname(String). Default is empty, indicating that the HTTPServer binds to the wildcard address.

executorService

public HTTPServer.Builder executorService(ExecutorService executorService)

Optional: ExecutorService used by the httpServer.

registry

public HTTPServer.Builder registry(PrometheusRegistry registry)

Optional: Default is PrometheusRegistry.defaultRegistry.

authenticator

public HTTPServer.Builder authenticator(Authenticator authenticator)

Optional: Authenticator for authentication.

authenticatedSubjectAttributeName

public HTTPServer.Builder authenticatedSubjectAttributeName(String authenticatedSubjectAttributeName)

Optional: the attribute name of a Subject from a custom authenticator.

httpsConfigurator

public HTTPServer.Builder httpsConfigurator(HttpsConfigurator configurator)

Optional: HttpsConfigurator for TLS/SSL

defaultHandler

public HTTPServer.Builder defaultHandler(HttpHandler defaultHandler)

Optional: Override default handler, i.e. the handler that will be registered for the / endpoint.

metricsHandlerPath

public HTTPServer.Builder metricsHandlerPath(String metricsHandlerPath)

Optional: Override default path for the metrics endpoint. Default is /metrics.

registerHealthHandler

public HTTPServer.Builder registerHealthHandler(boolean registerHealthHandler)

Optional: Override if the health handler should be registered. Default is true.

buildAndStart

public HTTPServer buildAndStart()
                         throws IOException

Build and start the HTTPServer.

Throws:

IOException

makeInetSocketAddress

private InetSocketAddress makeInetSocketAddress()

makeExecutorService

private ExecutorService makeExecutorService()

findPort

private int findPort()

assertNull

private void assertNull(Object o,
 String msg)