Class ExporterPushgatewayProperties

java.lang.Object

io.prometheus.metrics.config.ExporterPushgatewayProperties

public class ExporterPushgatewayProperties
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExporterPushgatewayProperties.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final String	address
private static final String	ADDRESS
private static final String	CONNECT_TIMEOUT
private final Duration	connectTimeout
private static final String	ESCAPING_SCHEME
private final EscapingScheme	escapingScheme
private final String	job
private static final String	JOB
private static final String	PREFIX
private static final String	READ_TIMEOUT
private final Duration	readTimeout
private final String	scheme
private static final String	SCHEME

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ExporterPushgatewayProperties(String address, String job, String scheme, EscapingScheme escapingScheme, Duration connectTimeout, Duration readTimeout)

Method Summary

Modifier and Type	Method	Description
static ExporterPushgatewayProperties.Builder	builder()
String	getAddress()	Address of the Pushgateway in the form host:port.
Duration	getConnectTimeout()	Connection timeout for connections to the Pushgateway.
EscapingScheme	getEscapingScheme()	Escaping scheme to be used when pushing metric data to the pushgateway.
String	getJob()	job label for metrics being pushed.
Duration	getReadTimeout()	Read timeout for connections to the Pushgateway.
String	getScheme()	Scheme to be used when pushing metrics to the pushgateway.
(package private) static ExporterPushgatewayProperties	load(PropertySource propertySource)	Note that this will remove entries from propertySource.
private static EscapingScheme	parseEscapingScheme(String scheme)

Methods inherited from class Object

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

Field Details

ADDRESS

private static final String ADDRESS

See Also:

• Constant Field Values

JOB

private static final String JOB

See Also:

• Constant Field Values

SCHEME

private static final String SCHEME

See Also:

• Constant Field Values

ESCAPING_SCHEME

private static final String ESCAPING_SCHEME

See Also:

• Constant Field Values

READ_TIMEOUT

private static final String READ_TIMEOUT

See Also:

• Constant Field Values

CONNECT_TIMEOUT

private static final String CONNECT_TIMEOUT

See Also:

• Constant Field Values

PREFIX

private static final String PREFIX

See Also:

• Constant Field Values

scheme

private final String scheme

address

private final String address

job

private final String job

escapingScheme

private final EscapingScheme escapingScheme

connectTimeout

private final Duration connectTimeout

readTimeout

private final Duration readTimeout

Constructor Details

ExporterPushgatewayProperties

private ExporterPushgatewayProperties(String address,
 String job,
 String scheme,
 EscapingScheme escapingScheme,
 Duration connectTimeout,
 Duration readTimeout)

Method Details

getAddress

public String getAddress()

Address of the Pushgateway in the form host:port. Default is localhost:9091

getJob

public String getJob()

job label for metrics being pushed. Default is the name of the JAR file that is running.

getScheme

public String getScheme()

Scheme to be used when pushing metrics to the pushgateway. Must be "http" or "https". Default is "http".

getEscapingScheme

public EscapingScheme getEscapingScheme()

Escaping scheme to be used when pushing metric data to the pushgateway.

getConnectTimeout

public Duration getConnectTimeout()

Connection timeout for connections to the Pushgateway.

getReadTimeout

public Duration getReadTimeout()

Read timeout for connections to the Pushgateway.

load

static ExporterPushgatewayProperties load(PropertySource propertySource)
                                   throws PrometheusPropertiesException

Note that this will remove entries from propertySource. This is because we want to know if there are unused properties remaining after all properties have been loaded.

Throws:

PrometheusPropertiesException

parseEscapingScheme

private static EscapingScheme parseEscapingScheme(String scheme)

builder

public static ExporterPushgatewayProperties.Builder builder()