com.wavefront.internal

Class SpanDerivedMetricsUtils

java.lang.Object

com.wavefront.internal.SpanDerivedMetricsUtils

public class SpanDerivedMetricsUtils
extends Object

Util methods to generate data (metrics/histograms/heartbeats) from tracing spans

Author:

Hao Song (songhao@vmware.com).

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEBUG_SPAN_TAG_KEY
static String	DEBUG_SPAN_TAG_VAL
static String	ERROR_SPAN_TAG_KEY
static String	ERROR_SPAN_TAG_VAL
static String	TRACING_DERIVED_PREFIX

Constructor Summary

Constructors

Constructor and Description
SpanDerivedMetricsUtils()

Method Summary

Modifier and Type	Method and Description
static void	reportHeartbeats(com.wavefront.sdk.common.WavefrontSender wavefrontSender, Set<com.wavefront.sdk.common.Pair<Map<String,String>,String>> discoveredHeartbeatMetrics) Report discovered heartbeats to Wavefront.
static void	reportHeartbeats(com.wavefront.sdk.common.WavefrontSender wavefrontSender, Set<com.wavefront.sdk.common.Pair<Map<String,String>,String>> discoveredHeartbeatMetrics, String secondaryComponent) Report discovered heartbeats to Wavefront.
static com.wavefront.sdk.common.Pair<Map<String,String>,String>	reportWavefrontGeneratedData(WavefrontInternalReporter wfInternalReporter, String operationName, String application, String service, String cluster, String shard, String source, String componentTagValue, boolean isError, long spanDurationMicros, Set<String> traceDerivedCustomTagKeys, List<com.wavefront.sdk.common.Pair<String,String>> spanTags) Report generated metrics and histograms from the wavefront tracing span using delta counter.
static com.wavefront.sdk.common.Pair<Map<String,String>,String>	reportWavefrontGeneratedData(WavefrontInternalReporter wfInternalReporter, String operationName, String application, String service, String cluster, String shard, String source, String componentTagValue, boolean isError, long spanDurationMicros, Set<String> traceDerivedCustomTagKeys, List<com.wavefront.sdk.common.Pair<String,String>> spanTags, boolean isReportingDelta) Report generated metrics and histograms from the wavefront tracing span.
protected static com.wavefront.sdk.common.Pair<Map<String,String>,String>	reportWavefrontGeneratedData(WavefrontInternalReporter wfInternalReporter, String operationName, String application, String service, String cluster, String shard, String source, String componentTagValue, boolean isError, long spanDurationMicros, Set<String> traceDerivedCustomTagKeys, List<com.wavefront.sdk.common.Pair<String,String>> spanTags, boolean isReportingDelta, Supplier<Long> clock)

Methods inherited from class java.lang.Object

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

Field Detail

TRACING_DERIVED_PREFIX

public static final String TRACING_DERIVED_PREFIX

See Also:

Constant Field Values

ERROR_SPAN_TAG_KEY

public static final String ERROR_SPAN_TAG_KEY

See Also:

Constant Field Values

ERROR_SPAN_TAG_VAL

public static final String ERROR_SPAN_TAG_VAL

See Also:

Constant Field Values

DEBUG_SPAN_TAG_KEY

public static final String DEBUG_SPAN_TAG_KEY

See Also:

Constant Field Values

DEBUG_SPAN_TAG_VAL

public static final String DEBUG_SPAN_TAG_VAL

See Also:

Constant Field Values

Constructor Detail

SpanDerivedMetricsUtils

public SpanDerivedMetricsUtils()

Method Detail

reportWavefrontGeneratedData

@Nonnull
public static com.wavefront.sdk.common.Pair<Map<String,String>,String> reportWavefrontGeneratedData(@Nonnull
                                                                                                             WavefrontInternalReporter wfInternalReporter,
                                                                                                             @Nonnull
                                                                                                             String operationName,
                                                                                                             @Nonnull
                                                                                                             String application,
                                                                                                             @Nonnull
                                                                                                             String service,
                                                                                                             String cluster,
                                                                                                             String shard,
                                                                                                             String source,
                                                                                                             String componentTagValue,
                                                                                                             boolean isError,
                                                                                                             long spanDurationMicros,
                                                                                                             Set<String> traceDerivedCustomTagKeys,
                                                                                                             List<com.wavefront.sdk.common.Pair<String,String>> spanTags)

Report generated metrics and histograms from the wavefront tracing span using delta counter.

Parameters:

operationName - span operation name.

application - name of the application.

service - name of the service.

cluster - name of the cluster.

shard - name of the shard.

source - reporting source.

componentTagValue - component tag value.

isError - indicates if the span is erroneous.

spanDurationMicros - Original span duration (both Zipkin and Jaeger support micros duration).

traceDerivedCustomTagKeys - custom tags added to derived RED metrics.

spanTags - span tags.

Returns:

Pair of Heartbeat custom tags and source.

reportWavefrontGeneratedData

@Nonnull
public static com.wavefront.sdk.common.Pair<Map<String,String>,String> reportWavefrontGeneratedData(@Nonnull
                                                                                                             WavefrontInternalReporter wfInternalReporter,
                                                                                                             @Nonnull
                                                                                                             String operationName,
                                                                                                             @Nonnull
                                                                                                             String application,
                                                                                                             @Nonnull
                                                                                                             String service,
                                                                                                             String cluster,
                                                                                                             String shard,
                                                                                                             String source,
                                                                                                             String componentTagValue,
                                                                                                             boolean isError,
                                                                                                             long spanDurationMicros,
                                                                                                             Set<String> traceDerivedCustomTagKeys,
                                                                                                             List<com.wavefront.sdk.common.Pair<String,String>> spanTags,
                                                                                                             boolean isReportingDelta)

Report generated metrics and histograms from the wavefront tracing span.

Parameters:

operationName - span operation name.

application - name of the application.

service - name of the service.

cluster - name of the cluster.

shard - name of the shard.

source - reporting source.

componentTagValue - component tag value.

isError - indicates if the span is erroneous.

spanDurationMicros - Original span duration (both Zipkin and Jaeger support micros duration).

traceDerivedCustomTagKeys - custom tags added to derived RED metrics.

spanTags - span tags.

isReportingDelta - reporting delta counters or normal counters.

Returns:

Pair of Heartbeat custom tags and source.

reportWavefrontGeneratedData

@Nonnull
protected static com.wavefront.sdk.common.Pair<Map<String,String>,String> reportWavefrontGeneratedData(@Nonnull
                                                                                                                WavefrontInternalReporter wfInternalReporter,
                                                                                                                String operationName,
                                                                                                                String application,
                                                                                                                String service,
                                                                                                                String cluster,
                                                                                                                String shard,
                                                                                                                String source,
                                                                                                                String componentTagValue,
                                                                                                                boolean isError,
                                                                                                                long spanDurationMicros,
                                                                                                                Set<String> traceDerivedCustomTagKeys,
                                                                                                                List<com.wavefront.sdk.common.Pair<String,String>> spanTags,
                                                                                                                boolean isReportingDelta,
                                                                                                                Supplier<Long> clock)

reportHeartbeats

public static void reportHeartbeats(com.wavefront.sdk.common.WavefrontSender wavefrontSender,
                                    Set<com.wavefront.sdk.common.Pair<Map<String,String>,String>> discoveredHeartbeatMetrics)
                             throws IOException

Report discovered heartbeats to Wavefront.

Parameters:

wavefrontSender - Wavefront sender via proxy.

discoveredHeartbeatMetrics - Discovered heartbeats.

Throws:

IOException

reportHeartbeats

public static void reportHeartbeats(com.wavefront.sdk.common.WavefrontSender wavefrontSender,
                                    Set<com.wavefront.sdk.common.Pair<Map<String,String>,String>> discoveredHeartbeatMetrics,
                                    @Nonnull
                                    String secondaryComponent)
                             throws IOException

Report discovered heartbeats to Wavefront.

Parameters:

wavefrontSender - Wavefront sender via proxy.

discoveredHeartbeatMetrics - Discovered heartbeats.

secondaryComponent - Secondary component value need to be sent in heartbeats metric.

Throws:

IOException