Package com.codahale.metrics.graphite

Class PickledGraphite

java.lang.Object

com.codahale.metrics.graphite.PickledGraphite

All Implemented Interfaces:

GraphiteSender, Closeable, AutoCloseable

public class PickledGraphite
extends Object
implements GraphiteSender

A client to a Carbon server that sends all metrics after they have been pickled in configurable sized batches

Constructor Summary

Constructors

Constructor	Description
PickledGraphite(String hostname, int port)	Creates a new client which connects to the given address using the default SocketFactory.
PickledGraphite(String hostname, int port, int batchSize)	Creates a new client which connects to the given address using the default SocketFactory.
PickledGraphite(String hostname, int port, SocketFactory socketFactory, int batchSize)	Creates a new client which connects to the given address and socket factory.
PickledGraphite(String hostname, int port, SocketFactory socketFactory, Charset charset, int batchSize)	Creates a new client which connects to the given address and socket factory using the given character set.
PickledGraphite(InetSocketAddress address)	Creates a new client which connects to the given address using the default SocketFactory.
PickledGraphite(InetSocketAddress address, int batchSize)	Creates a new client which connects to the given address using the default SocketFactory.
PickledGraphite(InetSocketAddress address, SocketFactory socketFactory, int batchSize)	Creates a new client which connects to the given address and socket factory.
PickledGraphite(InetSocketAddress address, SocketFactory socketFactory, Charset charset, int batchSize)	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)	Convert the metric to a python tuple of the form:

Methods inherited from class java.lang.Object

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

Constructor Detail

PickledGraphite

public PickledGraphite(InetSocketAddress address)

Creates a new client which connects to the given address using the default SocketFactory. This defaults to a batchSize of 100

Parameters:

address - the address of the Carbon server

PickledGraphite

public PickledGraphite(InetSocketAddress address,
                       int batchSize)

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

Parameters:

address - the address of the Carbon server

batchSize - how many metrics are bundled into a single pickle request to graphite

PickledGraphite

public PickledGraphite(InetSocketAddress address,
                       SocketFactory socketFactory,
                       int batchSize)

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

batchSize - how many metrics are bundled into a single pickle request to graphite

PickledGraphite

public PickledGraphite(InetSocketAddress address,
                       SocketFactory socketFactory,
                       Charset charset,
                       int batchSize)

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

batchSize - how many metrics are bundled into a single pickle request to graphite

PickledGraphite

public PickledGraphite(String hostname,
                       int port)

Creates a new client which connects to the given address using the default SocketFactory. This defaults to a batchSize of 100

Parameters:

hostname - the hostname of the Carbon server

port - the port of the Carbon server

PickledGraphite

public PickledGraphite(String hostname,
                       int port,
                       int batchSize)

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

batchSize - how many metrics are bundled into a single pickle request to graphite

PickledGraphite

public PickledGraphite(String hostname,
                       int port,
                       SocketFactory socketFactory,
                       int batchSize)

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

batchSize - how many metrics are bundled into a single pickle request to graphite

PickledGraphite

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

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

batchSize - how many metrics are bundled into a single pickle request to graphite

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

Convert the metric to a python tuple of the form:

(timestamp, (name, value))

And add it to the list of metrics. If we reach the batch size, write them out.

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

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

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

sanitize

protected String sanitize(String s)