Wavefront (Wavefront Java Integrations Core Library 3.0 API)

java.lang.Object
- com.wavefront.integrations.Wavefront

All Implemented Interfaces:

WavefrontSender, Closeable, AutoCloseable
```
public class Wavefront
extends Object
implements WavefrontSender
```
Wavefront Client that sends data directly via TCP to the Wavefront Proxy Agent.

Author:

Clement Pang ([email protected])., Conor Beverland ([email protected]).

Constructor Summary

Constructors
Constructor and Description
`Wavefront(InetSocketAddress agentAddress)` Creates a new client which connects to the given address using the default `SocketFactory`.
`Wavefront(InetSocketAddress agentAddress, SocketFactory socketFactory)` Creates a new client which connects to the given address and socket factory using the given character set.
`Wavefront(String agentHostName, int port)` Creates a new client which connects to the given address using the default `SocketFactory`.
`Wavefront(String agentHostName, int port, SocketFactory socketFactory)` Creates a new client which connects to the given address and socket factory.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`connect()` Connects to the server.
`void`	`flush()` Flushes buffer, if applicable
`int`	`getFailureCount()` Returns the number of failed writes to the server.
`boolean`	`isConnected()` Returns true if ready to send data
`void`	`send(String name, double value)` Send a measurement to Wavefront.
`void`	`send(String name, double value, Long timestamp)` Send a measurement to Wavefront.
`void`	`send(String name, double value, Long timestamp, String source)` Send a measurement to Wavefront.
`void`	`send(String name, double value, Long timestamp, String source, Map<String,String> pointTags)` Send 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
  - Wavefront
```
public Wavefront(String agentHostName,
         int port)
```
    Creates a new client which connects to the given address using the default SocketFactory.
    
    Parameters:
    agentHostName - The hostname of the Wavefront Proxy Agent
    port - The port of the Wavefront Proxy Agent
  - Wavefront
```
public Wavefront(String agentHostName,
         int port,
         SocketFactory socketFactory)
```
    Creates a new client which connects to the given address and socket factory.
    
    Parameters:
    agentHostName - The hostname of the Wavefront Proxy Agent
    port - The port of the Wavefront Proxy Agent
    socketFactory - the socket factory
  - Wavefront
```
public Wavefront(InetSocketAddress agentAddress)
```
    Creates a new client which connects to the given address using the default SocketFactory.
    
    Parameters:
    agentAddress - the address of the Wavefront Proxy Agent
  - Wavefront
```
public Wavefront(InetSocketAddress agentAddress,
         SocketFactory socketFactory)
```
    Creates a new client which connects to the given address and socket factory using the given character set.
    
    Parameters:
    agentAddress - the address of the Wavefront Proxy Agent
    socketFactory - the socket factory
- Method Detail
  - connect
```
public void connect()
             throws IllegalStateException,
                    IOException
```
    Description copied from interface: WavefrontSender
    
    Connects to the server.
    
    Specified by:
    
    connect in interface WavefrontSender
    
    Throws:
    
    IllegalStateException - if the client is already connected
    
    IOException - if there is an error connecting
  - send
```
public void send(String name,
        double value)
          throws IOException
```
    Description copied from interface: WavefrontSender
    
    Send a measurement to Wavefront. The current machine's hostname would be used as the source. The point will be timestamped at the agent.
    
    Specified by:
    
    send in interface WavefrontSender
    
    Parameters:
    name - The name of the metric. Spaces are replaced with '-' (dashes) and quotes will be automatically escaped.
    value - The value to be sent.
    
    Throws:
    
    IOException - Throws if there was an error sending the metric.
    
    UnknownHostException - Throws if there's an error determining the current host.
  - send
```
public void send(String name,
        double value,
        @Nullable
        Long timestamp)
          throws IOException
```
    Description copied from interface: WavefrontSender
    
    Send a measurement to Wavefront. The current machine's hostname would be used as the source.
    
    Specified by:
    
    send in interface WavefrontSender
    
    Parameters:
    name - The name of the metric. Spaces are replaced with '-' (dashes) and quotes will be automatically escaped.
    value - The value to be sent.
    timestamp - The timestamp in seconds since the epoch to be sent.
    
    Throws:
    
    IOException - Throws if there was an error sending the metric.
    
    UnknownHostException - Throws if there's an error determining the current host.
  - send
```
public void send(String name,
        double value,
        @Nullable
        Long timestamp,
        String source)
          throws IOException
```
    Description copied from interface: WavefrontSender
    
    Send a measurement to Wavefront.
    
    Specified by:
    
    send in interface WavefrontSender
    
    Parameters:
    name - The name of the metric. Spaces are replaced with '-' (dashes) and quotes will be automatically escaped.
    value - The value to be sent.
    timestamp - The timestamp in seconds since the epoch to be sent.
    source - The source (or host) that's sending the metric.
    
    Throws:
    
    IOException - if there was an error sending the metric.
  - send
```
public void send(String name,
        double value,
        @Nullable
        Long timestamp,
        String source,
        @Nullable
        Map<String,String> pointTags)
          throws IOException
```
    Description copied from interface: WavefrontSender
    
    Send the given measurement to the server.
    
    Specified by:
    
    send in interface WavefrontSender
    
    Parameters:
    name - The name of the metric. Spaces are replaced with '-' (dashes) and quotes will be automatically escaped.
    value - The value to be sent.
    timestamp - The timestamp in seconds since the epoch to be sent. Null to use agent assigned timestamp.
    source - The source (or host) that's sending the metric. Null to use machine hostname.
    pointTags - The point tags associated with this measurement.
    
    Throws:
    
    IOException - if there was an error sending the metric.
  - isConnected
```
public boolean isConnected()
```
    Description copied from interface: WavefrontSender
    
    Returns true if ready to send data
    
    Specified by:
    
    isConnected in interface WavefrontSender
  - getFailureCount
```
public int getFailureCount()
```
    Description copied from interface: WavefrontSender
    
    Returns the number of failed writes to the server.
    
    Specified by:
    
    getFailureCount in interface WavefrontSender
    
    Returns:
    the number of failed writes to the server
  - flush
```
public void flush()
           throws IOException
```
    Description copied from interface: WavefrontSender
    
    Flushes buffer, if applicable
    
    Specified by:
    
    flush in interface WavefrontSender
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException

Class Wavefront

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Wavefront

Wavefront

Wavefront

Wavefront

Method Detail

connect

send

send

send

send

isConnected

getFailureCount

flush

close