com.wavefront.sdk.entities.metrics

Interface WavefrontMetricSender

All Known Subinterfaces:

WavefrontSender

All Known Implementing Classes:

WavefrontClient, WavefrontDirectIngestionClient, WavefrontMultiClient, WavefrontProxyClient

public interface WavefrontMetricSender

WavefrontMetricSender interface that sends a metric to Wavefront

Author:

Sushant Dewan (sushant@wavefront.com).

Method Summary

Modifier and Type	Method and Description
default void	sendDeltaCounter(String name, double value, String source, Map<String,String> tags) Sends the given delta counter to Wavefront.
void	sendFormattedMetric(String point) Similar to sendMetric(String, double, Long, String, Map), only the point argument is expected to already be in Wavefront Data Format
void	sendMetric(String name, double value, Long timestamp, String source, Map<String,String> tags) Sends the given metric to Wavefront

Method Detail

sendMetric

void sendMetric(String name,
                double value,
                @Nullable
                Long timestamp,
                @Nullable
                String source,
                @Nullable
                Map<String,String> tags)
         throws IOException

Sends the given metric to Wavefront

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:

IOException - if there was an error sending the metric.

sendFormattedMetric

void sendFormattedMetric(String point)
                  throws IOException

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

Parameters:

point - a single metric, encoded in Wavefront Data Format

Throws:

IOException - if there was an error sending the metric.

sendDeltaCounter

default void sendDeltaCounter(String name,
                              double value,
                              @Nullable
                              String source,
                              @Nullable
                              Map<String,String> tags)
                       throws IOException

Sends the given delta counter to Wavefront. The timestamp for the point on the client side is null because the final timestamp of the delta counter is assigned when the point is aggregated on the server side. Do not use this method to send older points (say around 5 min old) as they will be aggregated on server with the current timestamp which yields in a wrong final aggregated value.

Parameters:

name - The name of the delta counter. Name will be prefixed by ∆ if it does not start with that symbol already. Also, spaces are replaced with '-' (dashes) and quotes will be automatically escaped.

value - The delta value to be sent. This will be aggregated on the Wavefront server side.

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

tags - The tags associated with this metric.

Throws:

IOException - if there was an error sending the metric.