org.apache.flink.metrics.prometheus

Class PrometheusPushGatewayReporter

java.lang.Object

org.apache.flink.metrics.prometheus.AbstractPrometheusReporter

org.apache.flink.metrics.prometheus.PrometheusPushGatewayReporter

All Implemented Interfaces:

MetricReporter, Scheduled

@PublicEvolving
public class PrometheusPushGatewayReporter
extends AbstractPrometheusReporter
implements Scheduled

MetricReporter that exports Metrics via Prometheus PushGateway.

Field Summary

Fields inherited from class org.apache.flink.metrics.prometheus.AbstractPrometheusReporter

log

Constructor Summary

Constructors

Constructor and Description
PrometheusPushGatewayReporter()

Method Summary

Modifier and Type	Method and Description
void	close() Closes this reporter.
void	open(MetricConfig config) Configures this reporter.
void	report() Report the current measurements.

Methods inherited from class org.apache.flink.metrics.prometheus.AbstractPrometheusReporter

notifyOfAddedMetric, notifyOfRemovedMetric

Methods inherited from class java.lang.Object

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

Constructor Detail

PrometheusPushGatewayReporter

public PrometheusPushGatewayReporter()

Method Detail

open

public void open(MetricConfig config)

Description copied from interface: MetricReporter

Configures this reporter.

If the reporter was instantiated generically and hence parameter-less, this method is the place where the reporter sets it's basic fields based on configuration values. Otherwise, this method will typically be a no-op since resources can be acquired in the constructor.

This method is always called first on a newly instantiated reporter.

Specified by:

open in interface MetricReporter

Overrides:

open in class AbstractPrometheusReporter

Parameters:

config - A properties object that contains all parameters set for this reporter.

report

public void report()

Description copied from interface: Scheduled

Report the current measurements. This method is called periodically by the metrics registry that uses the reporter.

Specified by:

report in interface Scheduled

close

public void close()

Description copied from interface: MetricReporter

Closes this reporter. Should be used to close channels, streams and release resources.

Specified by:

close in interface MetricReporter

Overrides:

close in class AbstractPrometheusReporter