com.codahale.metrics.graphite

Class Graphite

java.lang.Object

com.codahale.metrics.graphite.Graphite

All Implemented Interfaces:

Closeable, AutoCloseable

public class Graphite
extends Object
implements Closeable

A client to a Carbon server.

Constructor Summary

Constructors

Constructor and Description
Graphite(InetSocketAddress address) Creates a new client which connects to the given address using the default SocketFactory.
Graphite(InetSocketAddress address, SocketFactory socketFactory) Creates a new client which connects to the given address and socket factory.
Graphite(InetSocketAddress address, SocketFactory socketFactory, Charset charset) Creates a new client which connects to the given address and socket factory using the given character set.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	connect() Connects to the server.
int	getFailures() Returns the number of failed writes to the server.
protected String	sanitize(String s)
void	send(String name, String value, long timestamp) Sends the given measurement to the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

Graphite

public Graphite(InetSocketAddress address)

Creates a new client which connects to the given address using the default SocketFactory.

Parameters:

address - the address of the Carbon server

Graphite

public Graphite(InetSocketAddress address,
        SocketFactory socketFactory)

Creates a new client which connects to the given address and socket factory.

Parameters:

address - the address of the Carbon server

socketFactory - the socket factory

Graphite

public Graphite(InetSocketAddress address,
        SocketFactory socketFactory,
        Charset charset)

Creates a new client which connects to the given address and socket factory using the given character set.

Parameters:

address - the address of the Carbon server

socketFactory - the socket factory

charset - the character set used by the server

Method Detail

connect

public void connect()
             throws IllegalStateException,
                    IOException

Connects to the server.

Throws:

IllegalStateException - if the client is already connected

IOException - if there is an error connecting

send

public void send(String name,
        String value,
        long timestamp)
          throws IOException

Sends the given measurement to the server.

Parameters:

name - the name of the metric

value - the value of the metric

timestamp - the timestamp of the metric

Throws:

IOException - if there was an error sending the metric

getFailures

public int getFailures()

Returns the number of failed writes to the server.

Returns:

the number of failed writes to the server

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

sanitize

protected String sanitize(String s)