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

Method Summary

Modifier and Type	Method	Description
HTTPServer	buildAndStart()	Build and start the HTTPServer.
HTTPServer.Builder	withAuthenticator(com.sun.net.httpserver.Authenticator authenticator)	Optional: Authenticator for authentication.
HTTPServer.Builder	withDefaultHandler(com.sun.net.httpserver.HttpHandler defaultHandler)	Optional: Override default handler, i.e.
HTTPServer.Builder	withExecutorService(ExecutorService executorService)	Optional: ExecutorService used by the httpServer.
HTTPServer.Builder	withHostname(String hostname)	Use this hostname to resolve the IP address to bind to.
HTTPServer.Builder	withHttpsConfigurator(com.sun.net.httpserver.HttpsConfigurator configurator)	Optional: HttpsConfigurator for TLS/SSL
HTTPServer.Builder	withInetAddress(InetAddress address)	Bind to this IP address.
HTTPServer.Builder	withPort(int port)	Port to bind to.
HTTPServer.Builder	withRegistry(io.prometheus.metrics.model.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

Method Details

withPort

public HTTPServer.Builder withPort(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().

withHostname

public HTTPServer.Builder withHostname(String hostname)

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

withInetAddress

public HTTPServer.Builder withInetAddress(InetAddress address)

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

withExecutorService

public HTTPServer.Builder withExecutorService(ExecutorService executorService)

Optional: ExecutorService used by the httpServer.

withRegistry

public HTTPServer.Builder withRegistry(io.prometheus.metrics.model.registry.PrometheusRegistry registry)

Optional: Default is PrometheusRegistry.defaultRegistry.

withAuthenticator

public HTTPServer.Builder withAuthenticator(com.sun.net.httpserver.Authenticator authenticator)

Optional: Authenticator for authentication.

withHttpsConfigurator

public HTTPServer.Builder withHttpsConfigurator(com.sun.net.httpserver.HttpsConfigurator configurator)

Optional: HttpsConfigurator for TLS/SSL

withDefaultHandler

public HTTPServer.Builder withDefaultHandler(com.sun.net.httpserver.HttpHandler defaultHandler)

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

buildAndStart

public HTTPServer buildAndStart()
                         throws IOException

Build and start the HTTPServer.

Throws:

IOException