com.yahoo.bullet.common.metrics

Class HTTPMetricEventPublisher

java.lang.Object

com.yahoo.bullet.common.metrics.MetricPublisher<MetricEvent>

com.yahoo.bullet.common.metrics.MetricEventPublisher

com.yahoo.bullet.common.metrics.HTTPMetricEventPublisher

All Implemented Interfaces:

AutoCloseable

public class HTTPMetricEventPublisher
extends MetricEventPublisher

This class publishes a MetricEvent to a provided URL. It can retry publishes.

Field Summary

Fields inherited from class com.yahoo.bullet.common.metrics.MetricEventPublisher

DEFAULT_GROUP

Fields inherited from class com.yahoo.bullet.common.metrics.MetricPublisher

config

Constructor Summary

Constructors

Constructor and Description
HTTPMetricEventPublisher(BulletConfig config) Constructor taking a BulletConfig.

Method Summary

Modifier and Type	Method and Description
void	close()
protected org.apache.http.impl.client.CloseableHttpClient	createClient() Creates a CloseableHttpClient client to use for HTTP requests.
Map<String,String>	getDimensions(Map<String,String> extraDimensions) Returns any static dimensions to use.
String	getGroup() Get the group to use for the MetricEvent.
CompletableFuture<Boolean>	publish(MetricEvent payload) Publish a payload of the concrete type of this class.

Methods inherited from class com.yahoo.bullet.common.metrics.MetricEventPublisher

convert

Methods inherited from class com.yahoo.bullet.common.metrics.MetricPublisher

fire, fire, fire, from, publish, publish, publish

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPMetricEventPublisher

public HTTPMetricEventPublisher(BulletConfig config)

Constructor taking a BulletConfig.

Parameters:

config - The config to use containing the necessary information.

Method Detail

createClient

protected org.apache.http.impl.client.CloseableHttpClient createClient()

Creates a CloseableHttpClient client to use for HTTP requests.

Returns:

A created client that has the max concurrent connections set to the max per route.

close

public void close()

getGroup

public String getGroup()

Description copied from class: MetricEventPublisher

Get the group to use for the MetricEvent. By default, uses MetricEventPublisher.DEFAULT_GROUP.

Overrides:

getGroup in class MetricEventPublisher

Returns:

The group to use for the MetricEvent.

getDimensions

public Map<String,String> getDimensions(Map<String,String> extraDimensions)

Description copied from class: MetricPublisher

Returns any static dimensions to use. These are added to any additional dimensions provided.

Overrides:

getDimensions in class MetricPublisher<MetricEvent>

Parameters:

extraDimensions - Any non-null extra dimensions Map to add.

Returns:

The Map of static and extra dimensions to use for all publishing.

publish

public CompletableFuture<Boolean> publish(MetricEvent payload)

Description copied from class: MetricPublisher

Publish a payload of the concrete type of this class.

Specified by:

publish in class MetricPublisher<MetricEvent>

Parameters:

payload - The payload to publish.

Returns:

A CompletableFuture that resolves to true or false depending on whether the publish succeeded.