io.prometheus.client.exporter.PushGateway Java Examples

@Override
public CompletableFuture<?> start() {
  LOG.info(
      "Starting metrics push gateway service pushing to {}:{}",
      config.getPushHost(),
      config.getPushPort());

  pushGateway = new PushGateway(config.getPushHost() + ":" + config.getPushPort());

  // Create the executor
  scheduledExecutorService = Executors.newSingleThreadScheduledExecutor();
  scheduledExecutorService.scheduleAtFixedRate(
      this::pushMetrics,
      config.getPushInterval() / 2,
      config.getPushInterval(),
      TimeUnit.SECONDS);
  return CompletableFuture.completedFuture(null);
}
 

@Override
public void open(MetricConfig config) {
	super.open(config);

	String host = config.getString(HOST.key(), HOST.defaultValue());
	int port = config.getInteger(PORT.key(), PORT.defaultValue());
	String configuredJobName = config.getString(JOB_NAME.key(), JOB_NAME.defaultValue());
	boolean randomSuffix = config.getBoolean(RANDOM_JOB_NAME_SUFFIX.key(), RANDOM_JOB_NAME_SUFFIX.defaultValue());
	deleteOnShutdown = config.getBoolean(DELETE_ON_SHUTDOWN.key(), DELETE_ON_SHUTDOWN.defaultValue());

	if (host == null || host.isEmpty() || port < 1) {
		throw new IllegalArgumentException("Invalid host/port configuration. Host: " + host + " Port: " + port);
	}

	if (randomSuffix) {
		this.jobName = configuredJobName + new AbstractID();
	} else {
		this.jobName = configuredJobName;
	}

	pushGateway = new PushGateway(host + ':' + port);
	log.info("Configured PrometheusPushGatewayReporter with {host:{}, port:{}, jobName: {}, randomJobNameSuffix:{}, deleteOnShutdown:{}}", host, port, jobName, randomSuffix, deleteOnShutdown);
}
 

/**
 * Push the Metric data to Prometheus end point.
 * @param registry
 */
private static void pushMetricToPrometheus(final CollectorRegistry registry,final String surveillerTaskName){
	ExecutorService executor = Executors.newSingleThreadExecutor();
	executor.execute(() -> {
		try {
			PushGateway pg = new PushGateway(prometheusGateWayURL);
			Map<String, String> groupingKey = new HashMap<String, String>();
			groupingKey.put("instance", InetAddress.getLocalHost().getHostName().replace(".corporate.t-mobile.com", ""));
			groupingKey.put("task_name", surveillerTaskName);
			pg.pushAdd(registry, "SHD_SURVEILLER", groupingKey);
		} catch (IOException e) {
			logger.error("Unable to push Prometheus Metric", e);
		}
	});
	executor.shutdown();
}
 

@Override
public void open(MetricConfig config) {
	super.open(config);

	String host = config.getString(HOST.key(), HOST.defaultValue());
	int port = config.getInteger(PORT.key(), PORT.defaultValue());
	String configuredJobName = config.getString(JOB_NAME.key(), JOB_NAME.defaultValue());
	boolean randomSuffix = config.getBoolean(RANDOM_JOB_NAME_SUFFIX.key(), RANDOM_JOB_NAME_SUFFIX.defaultValue());
	deleteOnShutdown = config.getBoolean(DELETE_ON_SHUTDOWN.key(), DELETE_ON_SHUTDOWN.defaultValue());

	if (host == null || host.isEmpty() || port < 1) {
		throw new IllegalArgumentException("Invalid host/port configuration. Host: " + host + " Port: " + port);
	}

	if (randomSuffix) {
		this.jobName = configuredJobName + new AbstractID();
	} else {
		this.jobName = configuredJobName;
	}

	pushGateway = new PushGateway(host + ':' + port);
	log.info("Configured PrometheusPushGatewayReporter with {host:{}, port:{}, jobName: {}, randomJobNameSuffix:{}, deleteOnShutdown:{}}", host, port, jobName, randomSuffix, deleteOnShutdown);
}
 

static void executeBatchJob() throws Exception {
    CollectorRegistry registry = CollectorRegistry.defaultRegistry;
    Counter requests = Counter.build()
            .name("my_library_requests_total").help("Total requests.")
            .labelNames("method").register();
    requests.labels("get").inc();


    PushGateway pushgateway = new PushGateway("127.0.0.1:7200/prom");
    // pushgateway.setConnectionFactory(new BasicAuthHttpConnectionFactory("my_user", "my_password"));
    Map<String, String> groupingkeys = new HashMap<>();
    groupingkeys.put("app", "xx");
    pushgateway.pushAdd(registry, "my_batch_job", groupingkeys);
    //  pushgateway.pushAdd(registry, "my_batch_job");
}
 

@Test
public void getReturnsPushGatewayProvider() throws Exception {
    final MockWebServer server = new MockWebServer();
    server.enqueue(new MockResponse().setResponseCode(HttpURLConnection.HTTP_ACCEPTED));
    server.start();

    final MetricsPrometheusReporterConfiguration configuration = new MetricsPrometheusReporterConfiguration() {
        @Override
        public HostAndPort getAddress() {
            return HostAndPort.fromParts(server.getHostName(), server.getPort());
        }
    };
    final PushGatewayProvider provider = new PushGatewayProvider(configuration);
    final PushGateway pushGateway = provider.get();
    pushGateway.push(CollectorRegistry.defaultRegistry, "test");

    final RecordedRequest request = server.takeRequest();
    assertEquals("PUT", request.getMethod());
    assertEquals("/metrics/job/test", request.getPath());
    assertEquals("text/plain; version=0.0.4; charset=utf-8", request.getHeader("Content-Type"));
    assertEquals(0L, request.getBodySize());
}
 

@Override
public void open(MetricConfig config) {
	super.open(config);

	String host = config.getString(HOST.key(), HOST.defaultValue());
	int port = config.getInteger(PORT.key(), PORT.defaultValue());
	String configuredJobName = config.getString(JOB_NAME.key(), JOB_NAME.defaultValue());
	boolean randomSuffix = config.getBoolean(RANDOM_JOB_NAME_SUFFIX.key(), RANDOM_JOB_NAME_SUFFIX.defaultValue());
	deleteOnShutdown = config.getBoolean(DELETE_ON_SHUTDOWN.key(), DELETE_ON_SHUTDOWN.defaultValue());
	groupingKey = parseGroupingKey(config.getString(GROUPING_KEY.key(), GROUPING_KEY.defaultValue()));

	if (host == null || host.isEmpty() || port < 1) {
		throw new IllegalArgumentException("Invalid host/port configuration. Host: " + host + " Port: " + port);
	}

	if (randomSuffix) {
		this.jobName = configuredJobName + new AbstractID();
	} else {
		this.jobName = configuredJobName;
	}

	pushGateway = new PushGateway(host + ':' + port);
	log.info("Configured PrometheusPushGatewayReporter with {host:{}, port:{}, jobName:{}, randomJobNameSuffix:{}, deleteOnShutdown:{}, groupingKey:{}}",
		host, port, jobName, randomSuffix, deleteOnShutdown, groupingKey);
}
 

/**
 * Push the Metric data to Prometheus end point.
 * 
 * @param registry
 */
private void pushMetricToPrometheus(final CollectorRegistry registry, final String endPointName) {
    ExecutorService executor = Executors.newSingleThreadExecutor();
    executor.execute(new Runnable() {
        @Override
        public void run() {
            try {
                PushGateway pg = new PushGateway(prometheusGateWayURL);
                Map<String, String> groupingKey = new HashMap<String, String>();
                groupingKey.put("instance", InetAddress.getLocalHost().getHostName().replace(".corporate.t-mobile.com", ""));
                groupingKey.put("endpoint_name", endPointName);
                pg.pushAdd(registry, "SHD_API", groupingKey);
            } catch (IOException e) {
                log.error("Unable to push Prometheus Metric", e);
            }
        }
    });
    executor.shutdown();
}
 

/**
 * Build a prometheus pushgateway if an address is defined in environment.
 *
 * @return PushGateway
 */
private PushGateway buildPushGateWay() {
    // host:port or ip:port of the Pushgateway.
    String host = System.getenv("PROMETHEUS_PUSHGATEWAY_ADDRESS");
    if(host != null){
        return new PushGateway(host);
    } else {
        return null;
    }
}
 

public Metric(String gateWayUrl, String id, String name, String help, String job)
{
    this.id = id;
    this.job = job;
    this.gateway = new PushGateway(gateWayUrl);
    this.metric = Gauge.build().name(name).help(help).labelNames("id").register(registry);
}
 

@Inject
public PushGatewayPeriodical(MetricsPrometheusReporterConfiguration configuration,
                             CollectorRegistry collectorRegistry,
                             PushGateway pushGateway) {
    this.configuration = requireNonNull(configuration);
    this.collectorRegistry = requireNonNull(collectorRegistry);
    this.pushGateway = requireNonNull(pushGateway);
}
 

@Override
protected void configure() {
    addConfigBeans();

    bind(DropwizardExports.class).toProvider(DropwizardExportsProvider.class);
    bind(CollectorRegistry.class).toProvider(CollectorRegistryProvider.class);
    bind(PushGateway.class).toProvider(PushGatewayProvider.class);

    addPeriodical(PushGatewayPeriodical.class);
    addRestResource(MetricsResource.class);
}
 

public CollectorThroughputMetric(String id, String gatewayUrl)
{
    this.id = id;
    this.gateway = new PushGateway(gatewayUrl);
}
 

@Override
public PushGateway get() {
    final HostAndPort address = configuration.getAddress().withDefaultPort(9091);

    return new PushGateway(address.toString());
}