Package org.springframework.boot.actuate.metrics.export.prometheus

Class PrometheusPushGatewayManager

java.lang.Object

org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager

public class PrometheusPushGatewayManager
extends Object

Class that can be used to manage the pushing of metrics to a Prometheus PushGateway. Handles the scheduling of push operations, error handling and shutdown operations.

Since:

2.1.0

Author:

David J. M. Karlsen, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PrometheusPushGatewayManager.ShutdownOperation	The operation that should be performed on shutdown.

Constructor Summary

Constructors

Constructor	Description
PrometheusPushGatewayManager(io.prometheus.client.exporter.PushGateway pushGateway, io.prometheus.client.CollectorRegistry registry, Duration pushRate, String job, Map<String,String> groupingKeys, PrometheusPushGatewayManager.ShutdownOperation shutdownOperation)	Create a new PrometheusPushGatewayManager instance using a single threaded TaskScheduler.
PrometheusPushGatewayManager(io.prometheus.client.exporter.PushGateway pushGateway, io.prometheus.client.CollectorRegistry registry, TaskScheduler scheduler, Duration pushRate, String job, Map<String,String> groupingKey, PrometheusPushGatewayManager.ShutdownOperation shutdownOperation)	Create a new PrometheusPushGatewayManager instance.

Method Summary

Modifier and Type	Method	Description
void	shutdown()	Shutdown the manager, running any PrometheusPushGatewayManager.ShutdownOperation.

Methods inherited from class java.lang.Object

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

Constructor Details

PrometheusPushGatewayManager

public PrometheusPushGatewayManager(io.prometheus.client.exporter.PushGateway pushGateway,
 io.prometheus.client.CollectorRegistry registry,
 Duration pushRate,
 String job,
 Map<String,String> groupingKeys,
 PrometheusPushGatewayManager.ShutdownOperation shutdownOperation)

Create a new PrometheusPushGatewayManager instance using a single threaded TaskScheduler.

Parameters:

pushGateway - the source push gateway

registry - the collector registry to push

pushRate - the rate at which push operations occur

job - the job ID for the operation

groupingKeys - an optional set of grouping keys for the operation

shutdownOperation - the shutdown operation that should be performed when context is closed.

PrometheusPushGatewayManager

public PrometheusPushGatewayManager(io.prometheus.client.exporter.PushGateway pushGateway,
 io.prometheus.client.CollectorRegistry registry,
 TaskScheduler scheduler,
 Duration pushRate,
 String job,
 Map<String,String> groupingKey,
 PrometheusPushGatewayManager.ShutdownOperation shutdownOperation)

Create a new PrometheusPushGatewayManager instance.

Parameters:

pushGateway - the source push gateway

registry - the collector registry to push

scheduler - the scheduler used for operations

pushRate - the rate at which push operations occur

job - the job ID for the operation

groupingKey - an optional set of grouping keys for the operation

shutdownOperation - the shutdown operation that should be performed when context is closed.

Method Details

shutdown

public void shutdown()

Shutdown the manager, running any PrometheusPushGatewayManager.ShutdownOperation.