com.wavefront.sdk.common.clients

Class WavefrontClient

java.lang.Object

com.wavefront.sdk.common.clients.WavefrontClient

All Implemented Interfaces:

BufferFlusher, WavefrontSender, WavefrontEventSender, WavefrontHistogramSender, WavefrontLogSender, WavefrontMetricSender, WavefrontTracingSpanSender, java.io.Closeable, java.lang.AutoCloseable, java.lang.Runnable

public class WavefrontClient
extends java.lang.Object
implements WavefrontSender, java.lang.Runnable

Wavefront client that sends data to Wavefront via Proxy or Directly to a Wavefront service via the direct ingestion API.

Version:

$Id: $Id

Author:

Vikram Raman (vikram@wavefront.com), Mike McMahon (mike.mcmahon@wavefront.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WavefrontClient.Builder

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush() Flushes buffer, if applicable
java.lang.String	getClientId() getClientId.
int	getFailureCount() Returns the number of failed writes to the server.
void	run()
void	sendDistribution(java.lang.String name, java.util.List<Pair<java.lang.Double,java.lang.Integer>> centroids, java.util.Set<HistogramGranularity> histogramGranularities, java.lang.Long timestamp, java.lang.String source, java.util.Map<java.lang.String,java.lang.String> tags) sendDistribution.
void	sendEvent(java.lang.String name, long startMillis, long endMillis, java.lang.String source, java.util.Map<java.lang.String,java.lang.String> tags, java.util.Map<java.lang.String,java.lang.String> annotations) Sends the given event to Wavefront
void	sendFormattedMetric(java.lang.String point) Similar to WavefrontMetricSender.sendMetric(String, double, Long, String, Map), only the point argument is expected to already be in Wavefront Data Format
void	sendLog(java.lang.String name, double value, java.lang.Long timestamp, java.lang.String source, java.util.Map<java.lang.String,java.lang.String> tags) This method is used for sending log meta-data to wavefront.
void	sendMetric(java.lang.String name, double value, java.lang.Long timestamp, java.lang.String source, java.util.Map<java.lang.String,java.lang.String> tags) Sends the given metric to Wavefront
void	sendSpan(java.lang.String name, long startMillis, long durationMillis, java.lang.String source, java.util.UUID traceId, java.util.UUID spanId, java.util.List<java.util.UUID> parents, java.util.List<java.util.UUID> followsFrom, java.util.List<Pair<java.lang.String,java.lang.String>> tags, java.util.List<SpanLog> spanLogs) Send a trace span to Wavefront.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.wavefront.sdk.entities.metrics.WavefrontMetricSender

sendDeltaCounter, sendDeltaCounter

Method Detail

getClientId

public java.lang.String getClientId()

getClientId.

Specified by:

getClientId in interface WavefrontSender

Returns:

a String object

sendMetric

public void sendMetric(java.lang.String name,
                       double value,
                       @Nullable
                       java.lang.Long timestamp,
                       @Nullable
                       java.lang.String source,
                       @Nullable
                       java.util.Map<java.lang.String,java.lang.String> tags)
                throws java.io.IOException

Sends the given metric to Wavefront

Specified by:

sendMetric in interface WavefrontMetricSender

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 milliseconds since the epoch to be sent. If null then the timestamp is assigned by Wavefront when data is received.

source - The source (or host) that's sending the metric. If null then assigned by Wavefront.

tags - The tags associated with this metric.

Throws:

java.io.IOException - if there was an error sending the metric.

sendFormattedMetric

public void sendFormattedMetric(java.lang.String point)
                         throws java.io.IOException

Similar to WavefrontMetricSender.sendMetric(String, double, Long, String, Map), only the point argument is expected to already be in Wavefront Data Format

Specified by:

sendFormattedMetric in interface WavefrontMetricSender

Parameters:

point - a single metric, encoded in Wavefront Data Format

Throws:

java.io.IOException - if there was an error sending the metric.

sendDistribution

public void sendDistribution(java.lang.String name,
                             java.util.List<Pair<java.lang.Double,java.lang.Integer>> centroids,
                             java.util.Set<HistogramGranularity> histogramGranularities,
                             @Nullable
                             java.lang.Long timestamp,
                             @Nullable
                             java.lang.String source,
                             @Nullable
                             java.util.Map<java.lang.String,java.lang.String> tags)
                      throws java.io.IOException

sendDistribution.

Specified by:

sendDistribution in interface WavefrontHistogramSender

Parameters:

name - The name of the histogram distribution. Spaces are replaced with '-' (dashes) and quotes will be automatically escaped.

centroids - The distribution of histogram points to be sent. Each centroid is a 2-dimensional Pair where the first dimension is the mean value (Double) of the centroid and second dimension is the count of points in that centroid.

histogramGranularities - The set of intervals (minute, hour, and/or day) by which histogram data should be aggregated.

timestamp - The timestamp in milliseconds since the epoch to be sent. If null then the timestamp is assigned by Wavefront when data is received.

source - The source (or host) that's sending the histogram. If null, then assigned by Wavefront.

tags - The tags associated with this histogram.

Throws:

java.io.IOException - If there was an error sending the histogram.

sendLog

public void sendLog(java.lang.String name,
                    double value,
                    java.lang.Long timestamp,
                    java.lang.String source,
                    java.util.Map<java.lang.String,java.lang.String> tags)
             throws java.io.IOException

This method is used for sending log meta-data to wavefront. This metadata will be stored in LOG atom in wavefront.

Specified by:

sendLog in interface WavefrontLogSender

Parameters:

name - Log file name/source

value - Value for log stream

timestamp - epoch timestamp

source - Logging source

tags - Labels associated with log source

Throws:

java.io.IOException - throws an Exception

sendEvent

public void sendEvent(java.lang.String name,
                      long startMillis,
                      long endMillis,
                      @Nullable
                      java.lang.String source,
                      @Nullable
                      java.util.Map<java.lang.String,java.lang.String> tags,
                      @Nullable
                      java.util.Map<java.lang.String,java.lang.String> annotations)
               throws java.io.IOException

Sends the given event to Wavefront

Specified by:

sendEvent in interface WavefrontEventSender

Parameters:

name - The name of the event. Spaces are replaced with '-' (dashes) and quotes will be automatically escaped.

startMillis - The timestamp in milliseconds when the event was started.

endMillis - The timestamp in milliseconds when the event was ended.

source - The source (or host) that's sending the event. If null, then assigned by Wavefront.

tags - The tags associated with this event.

annotations - The annotations (details, type, severity, e.g.) associated with this event

Throws:

java.io.IOException - if there was an error sending the event.

sendSpan

public void sendSpan(java.lang.String name,
                     long startMillis,
                     long durationMillis,
                     @Nullable
                     java.lang.String source,
                     java.util.UUID traceId,
                     java.util.UUID spanId,
                     @Nullable
                     java.util.List<java.util.UUID> parents,
                     @Nullable
                     java.util.List<java.util.UUID> followsFrom,
                     @Nullable
                     java.util.List<Pair<java.lang.String,java.lang.String>> tags,
                     @Nullable
                     java.util.List<SpanLog> spanLogs)
              throws java.io.IOException

Send a trace span to Wavefront.

Specified by:

sendSpan in interface WavefrontTracingSpanSender

Parameters:

name - The operation name of the span.

startMillis - The start time in milliseconds for this span.

durationMillis - The duration of the span in milliseconds.

source - The source (or host) that's sending the span. If null, then assigned by Wavefront.

traceId - The unique trace ID for the span.

spanId - The unique span ID for the span.

parents - The list of parent span IDs, can be null if this is a root span.

followsFrom - The list of preceding span IDs, can be null if this is a root span.

tags - The span tags associated with this span. Supports repeated tags.

spanLogs - The span logs associated with this span.

Throws:

java.io.IOException - If there was an error sending the span.

run

public void run()

Specified by:

run in interface java.lang.Runnable

flush

public void flush()
           throws java.io.IOException

Flushes buffer, if applicable

Specified by:

flush in interface BufferFlusher

Throws:

java.io.IOException - throws an Exception

getFailureCount

public int getFailureCount()

Returns the number of failed writes to the server.

Specified by:

getFailureCount in interface BufferFlusher

Returns:

the number of failed writes to the server

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable