com.yahoo.bullet.common.metrics

Class MetricPublisher<T>

java.lang.Object

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

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

MetricEventPublisher

public abstract class MetricPublisher<T>
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field and Description
protected BulletConfig	config

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract T	convert(Map<String,String> dimensions, Map<String,Number> metrics) Convert the given dimensions and metrics into the concrete type of this class.
void	fire(Map<String,Number> metrics) Fire and forget an event with no extra dimensions and the given metrics.
void	fire(Map<String,String> dimensions, Map<String,Number> metrics) Fire and forget an event with the given extra dimensions and the given metrics.
void	fire(String metricName, Number metricValue) Fire and forget an event with no extra dimensions and the given single metric.
static MetricPublisher	from(BulletConfig config) Create a MetricPublisher instance using the class specified in the config file.
Map<String,String>	getDimensions(Map<String,String> extraDimensions) Returns any static dimensions to use.
CompletableFuture<Boolean>	publish(Map<String,Number> metrics) Publishes an event no extra dimensions and the given metrics.
CompletableFuture<Boolean>	publish(Map<String,String> dimensions, Map<String,Number> metrics) Publish an event with the given dimensions and metrics.
CompletableFuture<Boolean>	publish(String metricName, Number metricValue) Publishes an event with no extra dimensions and the given single metric.
abstract CompletableFuture<Boolean>	publish(T payload) Publish a payload of the concrete type of this class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

config

protected BulletConfig config

Constructor Detail

MetricPublisher

public MetricPublisher(BulletConfig config)

Constructor taking a BulletConfig.

Parameters:

config - The config to use containing the necessary information.

Method Detail

getDimensions

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

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

Parameters:

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

Returns:

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

fire

public void fire(String metricName,
                 Number metricValue)

Fire and forget an event with no extra dimensions and the given single metric.

Parameters:

metricName - The name of the metric being published.

metricValue - The value of the metric being published.

fire

public void fire(Map<String,Number> metrics)

Fire and forget an event with no extra dimensions and the given metrics.

Parameters:

metrics - The metrics to publish.

fire

public void fire(Map<String,String> dimensions,
                 Map<String,Number> metrics)

Fire and forget an event with the given extra dimensions and the given metrics.

Parameters:

dimensions - The additional dimensions to publish.

metrics - The metrics to publish.

publish

public CompletableFuture<Boolean> publish(String metricName,
                                          Number metricValue)

Publishes an event with no extra dimensions and the given single metric.

Parameters:

metricName - The name of the metric being published.

metricValue - The value of the metric being published.

Returns:

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

publish

public CompletableFuture<Boolean> publish(Map<String,Number> metrics)

Publishes an event no extra dimensions and the given metrics.

Parameters:

metrics - The metrics to publish.

Returns:

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

publish

public CompletableFuture<Boolean> publish(Map<String,String> dimensions,
                                          Map<String,Number> metrics)

Publish an event with the given dimensions and metrics.

Parameters:

dimensions - The non-null additional dimensions to publish.

metrics - The metrics to publish.

Returns:

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

convert

public abstract T convert(Map<String,String> dimensions,
                          Map<String,Number> metrics)

Convert the given dimensions and metrics into the concrete type of this class.

Parameters:

dimensions - The non-null Map of dimensions to convert.

metrics - The Map of metrics to convert.

Returns:

The concrete type object of this class to publish.

publish

public abstract CompletableFuture<Boolean> publish(T payload)

Publish a payload of the concrete type of this class.

Parameters:

payload - The payload to publish.

Returns:

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

from

public static MetricPublisher from(BulletConfig config)

Create a MetricPublisher instance using the class specified in the config file.

Parameters:

config - The non-null BulletConfig containing the class name and metric publisher settings.

Returns:

an instance of specified class initialized with settings from the input file and defaults.