com.flozano.metrics.client.statsd.StatsDMetricsClientBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of metrics-statsd Show documentation
The newest version!
package com.flozano.metrics.client.statsd;

import java.util.function.UnaryOperator;

import com.flozano.metrics.client.MetricValue;
import com.flozano.metrics.client.MetricsClient;

import io.netty.channel.EventLoopGroup;

/**
 * Builder for MetricsClient
 *
 * @author flozano
 *
 */
public interface StatsDMetricsClientBuilder {

	/**
	 * Creates a new StatsD client builder
	 *
	 * @return the builder
	 */
	static StatsDMetricsClientBuilder create() {
		return new StatsDMetricsClientBuilderImpl();
	}

	/**
	 * Sets the sample rate of elements that will be actually sent.
	 *
	 * Eg: if rate is 0.75d, more or les 75% of items will be sent (and the
	 * \@0.75 suffix will be added to the metrics)
	 *
	 * @param rate
	 *            the rate
	 * @return the builder
	 */
	StatsDMetricsClientBuilder withSampleRate(Double rate);

	/**
	 * Sets the rate at which the client will flush the pending metric values to
	 * the network.
	 *
	 * Eg: if a rate is 0.1d, 1 in 10 writes will flush the pending metrics.
	 *
	 * @param rate
	 *            the rate
	 * @return the builder
	 */
	StatsDMetricsClientBuilder withFlushRate(double rate);

	/**
	 * The StatsD hostname that will receive the metric values
	 *
	 * @param host
	 *            the host
	 * @return the builder
	 */
	StatsDMetricsClientBuilder withHost(String host);

	/**
	 * The UDP port where the server is listening to.
	 *
	 * @param port
	 *            the port
	 * @return the builder
	 */
	StatsDMetricsClientBuilder withPort(int port);

	/**
	 * Allow to provide a pre-created EventLoopGroup.
	 *
	 * If provided, when {@link MetricsClient#close()} is invoked, the
	 * EventLoopGroup will NOT be shutdown.
	 *
	 * @param eventLoopGroup
	 *            the eventLoopGroup
	 * @return the builder
	 */
	StatsDMetricsClientBuilder withEventLoopGroup(EventLoopGroup eventLoopGroup);

	/**
	 * Optional preprocessor to perform additional processing over the metrics
	 * before they're sent to the wire.
	 *
	 * @param preprocessor
	 *            the preprocessor that will be applied to the metrics before
	 *            they're sent
	 * @return the builder
	 */
	StatsDMetricsClientBuilder withPreprocessor(UnaryOperator preprocessor);

	/**
	 * @return a newly configured StatsD client.
	 */
	MetricsClient build();

}