Class HTTPServer.Builder

java.lang.Object

io.prometheus.client.exporter.HTTPServer.Builder

Enclosing class:

HTTPServer

public static class HTTPServer.Builder
extends Object

We keep the original constructors of HTTPServer for compatibility, but new configuration parameters like sampleNameFilter must be configured using the Builder.

Field Summary

Fields

Modifier and Type	Field	Description
private Authenticator	authenticator
private boolean	daemon
private ExecutorService	executorService
private String	hostname
private HttpsConfigurator	httpsConfigurator
private HttpServer	httpServer
private InetAddress	inetAddress
private InetSocketAddress	inetSocketAddress
private int	port
private CollectorRegistry	registry
private Predicate<String>	sampleNameFilter
private Supplier<Predicate<String>>	sampleNameFilterSupplier

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
private void	assertNull(Object o, String msg)
private void	assertZero(int i, String msg)
HTTPServer	build()	Build the HTTPServer
HTTPServer.Builder	withAuthenticator(Authenticator authenticator)	Optional: Authenticator to use to support authentication.
HTTPServer.Builder	withDaemonThreads(boolean daemon)	By default, the HTTPServer uses non-daemon threads.
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(HttpsConfigurator configurator)	Optional: HttpsConfigurator to use to support TLS/SSL
HTTPServer.Builder	withHttpServer(HttpServer httpServer)	Use this httpServer.
HTTPServer.Builder	withInetAddress(InetAddress address)	Bind to this IP address.
HTTPServer.Builder	withInetSocketAddress(InetSocketAddress address)	Listen on this address.
HTTPServer.Builder	withPort(int port)	Port to bind to.
HTTPServer.Builder	withRegistry(CollectorRegistry registry)	Optional: Default is CollectorRegistry.defaultRegistry.
HTTPServer.Builder	withSampleNameFilter(Predicate<String> sampleNameFilter)	Optional: Only export time series where sampleNameFilter.test(name) returns true.
HTTPServer.Builder	withSampleNameFilterSupplier(Supplier<Predicate<String>> sampleNameFilterSupplier)	Optional: Only export time series where sampleNameFilter.test(name) returns true.

Methods inherited from class Object

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

Field Details

port

private int port

hostname

private String hostname

inetAddress

private InetAddress inetAddress

inetSocketAddress

private InetSocketAddress inetSocketAddress

httpServer

private HttpServer httpServer

executorService

private ExecutorService executorService

registry

private CollectorRegistry registry

daemon

private boolean daemon

sampleNameFilter

private Predicate<String> sampleNameFilter

sampleNameFilterSupplier

private Supplier<Predicate<String>> sampleNameFilterSupplier

authenticator

private Authenticator authenticator

httpsConfigurator

private HttpsConfigurator httpsConfigurator

Constructor Details

Builder

public Builder()

Method Details

withPort

public HTTPServer.Builder withPort(int port)

Port to bind to. Must not be called together with withInetSocketAddress(InetSocketAddress) or withHttpServer(HttpServer). Default is 0, indicating that a random port will be selected.

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) or withInetSocketAddress(InetSocketAddress) or withHttpServer(HttpServer). 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) or withInetSocketAddress(InetSocketAddress) or withHttpServer(HttpServer). Default is empty, indicating that the HTTPServer binds to the wildcard address.

withInetSocketAddress

public HTTPServer.Builder withInetSocketAddress(InetSocketAddress address)

Listen on this address. Must not be called together with withPort(int), withHostname(String), withInetAddress(InetAddress), or withHttpServer(HttpServer).

withHttpServer

public HTTPServer.Builder withHttpServer(HttpServer httpServer)

Use this httpServer. The httpServer is expected to already be bound to an address. Must not be called together with withPort(int), or withHostname(String), or withInetAddress(InetAddress), or withInetSocketAddress(InetSocketAddress), or withExecutorService(ExecutorService).

withExecutorService

public HTTPServer.Builder withExecutorService(ExecutorService executorService)

Optional: ExecutorService used by the httpServer. Must not be called together with the withHttpServer(HttpServer).

Parameters:

executorService -

Returns:

withDaemonThreads

public HTTPServer.Builder withDaemonThreads(boolean daemon)

By default, the HTTPServer uses non-daemon threads. Set this to true to run the HTTPServer with daemon threads.

withSampleNameFilter

public HTTPServer.Builder withSampleNameFilter(Predicate<String> sampleNameFilter)

Optional: Only export time series where sampleNameFilter.test(name) returns true.

Use this if the sampleNameFilter remains the same throughout the lifetime of the HTTPServer. If the sampleNameFilter changes during runtime, use withSampleNameFilterSupplier(Supplier).

withSampleNameFilterSupplier

public HTTPServer.Builder withSampleNameFilterSupplier(Supplier<Predicate<String>> sampleNameFilterSupplier)

Optional: Only export time series where sampleNameFilter.test(name) returns true.

Use this if the sampleNameFilter may change during runtime, like for example if you have a hot reload mechanism for your filter config. If the sampleNameFilter remains the same throughout the lifetime of the HTTPServer, use withSampleNameFilter(Predicate) instead.

withRegistry

public HTTPServer.Builder withRegistry(CollectorRegistry registry)

Optional: Default is CollectorRegistry.defaultRegistry.

withAuthenticator

public HTTPServer.Builder withAuthenticator(Authenticator authenticator)

Optional: Authenticator to use to support authentication.

withHttpsConfigurator

public HTTPServer.Builder withHttpsConfigurator(HttpsConfigurator configurator)

Optional: HttpsConfigurator to use to support TLS/SSL

build

public HTTPServer build()
                 throws IOException

Build the HTTPServer

Throws:

IOException

assertNull

private void assertNull(Object o,
 String msg)

assertZero

private void assertZero(int i,
 String msg)