io.dropwizard.metrics5.graphite.GraphiteSender Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of metrics-graphite Show documentation

A reporter for Metrics which announces measurements to a Graphite server.

There is a newer version: 5.0.0

package io.dropwizard.metrics5.graphite;

import java.io.Closeable;
import java.io.IOException;

public interface GraphiteSender extends Closeable {

    /**
     * Connects to the server.
     *
     * @throws IllegalStateException if the client is already connected
     * @throws IOException           if there is an error connecting
     */
    void connect() throws IllegalStateException, IOException;

    /**
     * Sends the given measurement to the server.
     *
     * @param name      the name of the metric
     * @param value     the value of the metric
     * @param timestamp the timestamp of the metric
     * @throws IOException if there was an error sending the metric
     */
    void send(String name, String value, long timestamp) throws IOException;

    /**
     * Flushes buffer, if applicable
     *
     * @throws IOException if there was an error during flushing metrics to the socket
     */
    void flush() throws IOException;

    /**
     * Returns true if ready to send data
     */
    boolean isConnected();

    /**
     * Returns the number of failed writes to the server.
     *
     * @return the number of failed writes to the server
     */
    int getFailures();

}