Class PushGateway.Builder

java.lang.Object

io.prometheus.metrics.exporter.pushgateway.PushGateway.Builder

Enclosing class:

PushGateway

public static class PushGateway.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private String	address
private final PrometheusProperties	config
private HttpConnectionFactory	connectionFactory
private Duration	connectionTimeout
private EscapingScheme	escapingScheme
private Format	format
private final Map<String,String>	groupingKey
private String	job
private boolean	prometheusTimestampsInMs
private Duration	readTimeout
private PrometheusRegistry	registry
private final Map<String,String>	requestHeaders
private Scheme	scheme

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder(PrometheusProperties config)

Method Summary

Modifier and Type	Method	Description
PushGateway.Builder	address(String address)	Address of the Pushgateway in format host:port.
private String	base64url(String v)
PushGateway.Builder	basicAuth(String user, String password)	Username and password for HTTP basic auth when pushing to the Pushgateway.
PushGateway.Builder	bearerToken(String token)	Bearer token authorization when pushing to the Pushgateway.
PushGateway	build()
PushGateway.Builder	connectionFactory(HttpConnectionFactory connectionFactory)	Custom connection factory.
PushGateway.Builder	connectionTimeout(Duration connectionTimeout)	Specify the connection timeout for HTTP connections to the PushGateway.
PushGateway.Builder	escapingScheme(EscapingScheme escapingScheme)	Specify the escaping scheme to be used when pushing metrics.
PushGateway.Builder	format(Format format)	Default is Format.PROMETHEUS_PROTOBUF.
private String	getAddress(ExporterPushgatewayProperties properties)
private Duration	getConnectionTimeout(ExporterPushgatewayProperties properties)
private EscapingScheme	getEscapingScheme(ExporterPushgatewayProperties properties)
private Format	getFormat()
private String	getJob(ExporterPushgatewayProperties properties)
private boolean	getPrometheusTimestampsInMs()
private Duration	getReadTimeout(ExporterPushgatewayProperties properties)
private Scheme	getScheme(ExporterPushgatewayProperties properties)
PushGateway.Builder	groupingKey(String name, String value)	Grouping keys to be used when pushing/deleting metrics.
PushGateway.Builder	instanceIpGroupingKey()	Convenience method for adding the current IP address as an "instance" label.
PushGateway.Builder	job(String job)	The job label to be used when pushing metrics.
private URL	makeUrl(ExporterPushgatewayProperties properties)
PushGateway.Builder	prometheusTimestampsInMs(boolean prometheusTimestampsInMs)	Use milliseconds for timestamps in text format? Default is false.
PushGateway.Builder	readTimeout(Duration readTimeout)	Specify the read timeout for HTTP connections to the PushGateway.
PushGateway.Builder	registry(PrometheusRegistry registry)	Push metrics from this registry instead of PrometheusRegistry.defaultRegistry.
PushGateway.Builder	scheme(Scheme scheme)	Specify if metrics should be pushed using HTTP or HTTPS.

Methods inherited from class Object

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

Field Details

config

private final PrometheusProperties config

format

private Format format

address

private String address

scheme

private Scheme scheme

job

private String job

connectionTimeout

private Duration connectionTimeout

readTimeout

private Duration readTimeout

prometheusTimestampsInMs

private boolean prometheusTimestampsInMs

requestHeaders

private final Map<String,String> requestHeaders

registry

private PrometheusRegistry registry

connectionFactory

private HttpConnectionFactory connectionFactory

groupingKey

private final Map<String,String> groupingKey

escapingScheme

private EscapingScheme escapingScheme

Constructor Details

Builder

private Builder(PrometheusProperties config)

Method Details

format

public PushGateway.Builder format(Format format)

Default is Format.PROMETHEUS_PROTOBUF.

address

public PushGateway.Builder address(String address)

Address of the Pushgateway in format host:port. Default is localhost:9091. Can be overwritten at runtime with the io.prometheus.exporter.pushgateway.address property.

basicAuth

public PushGateway.Builder basicAuth(String user,
 String password)

Username and password for HTTP basic auth when pushing to the Pushgateway.

bearerToken

public PushGateway.Builder bearerToken(String token)

Bearer token authorization when pushing to the Pushgateway.

scheme

public PushGateway.Builder scheme(Scheme scheme)

Specify if metrics should be pushed using HTTP or HTTPS. Default is HTTP. Can be overwritten at runtime with the io.prometheus.exporter.pushgateway.scheme property.

connectionFactory

public PushGateway.Builder connectionFactory(HttpConnectionFactory connectionFactory)

Custom connection factory. Default is DefaultHttpConnectionFactory.

The PushGatewayTestApp in integration-tests/it-pushgateway/ has an example of a custom connection factory that skips SSL certificate validation for HTTPS connections.

job

public PushGateway.Builder job(String job)

The job label to be used when pushing metrics. If not provided, the name of the JAR file will be used by default. Can be overwritten at runtime with the io.prometheus.exporter.pushgateway.job property.

groupingKey

public PushGateway.Builder groupingKey(String name,
 String value)

Grouping keys to be used when pushing/deleting metrics. Call this method multiple times for adding multiple grouping keys.

instanceIpGroupingKey

public PushGateway.Builder instanceIpGroupingKey()
                                          throws UnknownHostException

Convenience method for adding the current IP address as an "instance" label.

Throws:

UnknownHostException

registry

public PushGateway.Builder registry(PrometheusRegistry registry)

Push metrics from this registry instead of PrometheusRegistry.defaultRegistry.

escapingScheme

public PushGateway.Builder escapingScheme(EscapingScheme escapingScheme)

Specify the escaping scheme to be used when pushing metrics. Default is EscapingScheme.UNDERSCORE_ESCAPING.

prometheusTimestampsInMs

public PushGateway.Builder prometheusTimestampsInMs(boolean prometheusTimestampsInMs)

Use milliseconds for timestamps in text format? Default is false. Can be overwritten at runtime with the io.prometheus.exporter.timestamps_in_ms property.

connectionTimeout

public PushGateway.Builder connectionTimeout(Duration connectionTimeout)

Specify the connection timeout for HTTP connections to the PushGateway. Default is 10 seconds.

Parameters:

connectionTimeout - timeout value

Returns:

this PushGateway.Builder instance

getConnectionTimeout

private Duration getConnectionTimeout(ExporterPushgatewayProperties properties)

readTimeout

public PushGateway.Builder readTimeout(Duration readTimeout)

Specify the read timeout for HTTP connections to the PushGateway. Default is 10 seconds.

Parameters:

readTimeout - timeout value

Returns:

this PushGateway.Builder instance

getReadTimeout

private Duration getReadTimeout(ExporterPushgatewayProperties properties)

getPrometheusTimestampsInMs

private boolean getPrometheusTimestampsInMs()

getScheme

private Scheme getScheme(ExporterPushgatewayProperties properties)

getAddress

private String getAddress(ExporterPushgatewayProperties properties)

getJob

private String getJob(ExporterPushgatewayProperties properties)

getEscapingScheme

private EscapingScheme getEscapingScheme(ExporterPushgatewayProperties properties)

getFormat

private Format getFormat()

makeUrl

private URL makeUrl(ExporterPushgatewayProperties properties)
             throws UnsupportedEncodingException,
MalformedURLException

Throws:

UnsupportedEncodingException

MalformedURLException

base64url

private String base64url(String v)

build

public PushGateway build()