Package com.codahale.metrics.graphite

Class Graphite

java.lang.Object

com.codahale.metrics.graphite.Graphite

All Implemented Interfaces:

GraphiteSender, Closeable, AutoCloseable

public class Graphite
extends Object
implements GraphiteSender

A client to a Carbon server via TCP.

Constructor Summary

Constructors

Constructor	Description
Graphite(String hostname, int port)	Creates a new client which connects to the given address using the default SocketFactory.
Graphite(String hostname, int port, SocketFactory socketFactory)	Creates a new client which connects to the given address and socket factory.
Graphite(String hostname, int port, SocketFactory socketFactory, Charset charset)	Creates a new client which connects to the given address and socket factory using the given character set.
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

Modifier and Type	Method	Description
void	close()
void	connect()	Connects to the server.
void	flush()	Flushes buffer, if applicable
int	getFailures()	Returns the number of failed writes to the server.
boolean	isConnected()	Returns true if ready to send data
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(String hostname,
                int port)

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

Parameters:

hostname - The hostname of the Carbon server

port - The port of the Carbon server

Graphite

public Graphite(String hostname,
                int port,
                SocketFactory socketFactory)

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

Parameters:

hostname - The hostname of the Carbon server

port - The port of the Carbon server

socketFactory - the socket factory

Graphite

public Graphite(String hostname,
                int port,
                SocketFactory socketFactory,
                Charset charset)

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

Parameters:

hostname - The hostname of the Carbon server

port - The port of the Carbon server

socketFactory - the socket factory

charset - the character set used by the server

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

Description copied from interface: GraphiteSender

Connects to the server.

Specified by:

connect in interface GraphiteSender

Throws:

IllegalStateException - if the client is already connected

IOException - if there is an error connecting

isConnected

public boolean isConnected()

Description copied from interface: GraphiteSender

Returns true if ready to send data

Specified by:

isConnected in interface GraphiteSender

send

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

Description copied from interface: GraphiteSender

Sends the given measurement to the server.

Specified by:

send in interface GraphiteSender

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()

Description copied from interface: GraphiteSender

Returns the number of failed writes to the server.

Specified by:

getFailures in interface GraphiteSender

Returns:

the number of failed writes to the server

flush

public void flush()
           throws IOException

Description copied from interface: GraphiteSender

Flushes buffer, if applicable

Specified by:

flush in interface GraphiteSender

Throws:

IOException - if there was an error during flushing metrics to the socket

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

sanitize

protected String sanitize(String s)