Package org.opennms.nephron.cortex

Class CortexIo

java.lang.Object

org.opennms.nephron.cortex.CortexIo

@Experimental(SOURCE_SINK)
public class CortexIo
extends Object

Provides write transforms (sinks) for writing to Cortex.

Cortex requires that samples of a specific time series are written with increasing timestamps. The write transforms assign index numbers to output values that can be used as an additional metric label that make time series strictly increasing even in case of multiple panes for the same window and panes of later windows completing before panes of earlier windows.

This class can provide two different kinds of sinks:

Non-accumulating sink

A sink that assigns unique index numbers to output values.

Accumulating sink

A sink that assigns unique index numbers to output values and additionally accumulates values of different panes before they are output.

Both transforms use Beam's state mechanism to track written event timestamps. By doing so, index numbers can be derived that allow to disambiguate samples for the same event timestamps. The accumulating sink additionally uses Beam's timer mechanism to hold back values for accumulation and flushes values after a configured output delay.

Note: The PaneAccumulator class can be used to achieve the same accumulation effect that the accumulating Cortex sink has. It makes sense to use the PaneAccumulator if several sinks can benefit from accumulated outputs. In case of a single sink the accumulating Cortex sink is preferable.

Sinks are configured by the CortexIo.Write class and are implemented by subclasses of the CortexIo.WriteFn class. Sinks provide the following counter metrics in the "cortex" namespace:

sample

Counts the number of samples

write

Counts the number of sent write requests

write_failure

Counts the number of failed write requests (requests that resulted in an exception)

response_failure

Counts the number of Cortex responses with a non-success result code

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CortexIo.BuildTimeSeries<K,V>
static class	CortexIo.Write<K,V>	Stores the configuration of the transforms.
static class	CortexIo.WriteFn<K,V,W extends CortexIo.Write<K,V>>	Function class for writing to Cortex.
static class	CortexIo.WriteFnWithAccumulation<K,V>	A Cortex sink that assigns unique index numbers and accumulates values.
static class	CortexIo.WriteFnWithoutAccumulation<K,V>	A Cortex sink that assigns unique index numbers.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CORTEX_METRIC_NAMESPACE
static String	CORTEX_RESPONSE_FAILURE_METRIC_NAME
static String	CORTEX_SAMPLE_METRIC_NAME
static String	CORTEX_WRITE_FAILURE_METRIC_NAME
static String	CORTEX_WRITE_METRIC_NAME
static com.swrve.ratelimitedlogger.RateLimitedLog	RATE_LIMITED_LOG

Constructor Summary

Constructors

Constructor	Description
CortexIo()

Method Summary

Modifier and Type	Method	Description
static <K,V> CortexIo.Write<K,V>	of(String writeUrl, CortexIo.BuildTimeSeries<K,V> build)	Creates a Cortex sink.
static <K,V> CortexIo.Write<K,V>	of(String writeUrl, CortexIo.BuildTimeSeries<K,V> build, org.apache.beam.sdk.coders.Coder<K> keyCoder, org.apache.beam.sdk.coders.Coder<V> valueCoder, org.apache.beam.sdk.transforms.SerializableBiFunction<V,V,V> combiner, org.joda.time.Duration accumulationDelay)
static void	sanitize(String name, String value, BiConsumer<String,String> consumer)
static String	sanitizeLabelName(String labelName)
static String	sanitizeMetricName(String metricName)

Methods inherited from class java.lang.Object

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

Field Detail

RATE_LIMITED_LOG

public static final com.swrve.ratelimitedlogger.RateLimitedLog RATE_LIMITED_LOG

CORTEX_METRIC_NAMESPACE

public static final String CORTEX_METRIC_NAMESPACE

See Also:

Constant Field Values

CORTEX_WRITE_METRIC_NAME

public static final String CORTEX_WRITE_METRIC_NAME

See Also:

Constant Field Values

CORTEX_SAMPLE_METRIC_NAME

public static final String CORTEX_SAMPLE_METRIC_NAME

See Also:

Constant Field Values

CORTEX_WRITE_FAILURE_METRIC_NAME

public static final String CORTEX_WRITE_FAILURE_METRIC_NAME

See Also:

Constant Field Values

CORTEX_RESPONSE_FAILURE_METRIC_NAME

public static final String CORTEX_RESPONSE_FAILURE_METRIC_NAME

See Also:

Constant Field Values

Constructor Detail

CortexIo

public CortexIo()

Method Detail

of

public static <K,V> CortexIo.Write<K,V> of(String writeUrl,
                                                       CortexIo.BuildTimeSeries<K,V> build)

Creates a Cortex sink.

of

public static <K,V> CortexIo.Write<K,V> of(String writeUrl,
                                                       CortexIo.BuildTimeSeries<K,V> build,
                                                       org.apache.beam.sdk.coders.Coder<K> keyCoder,
                                                       org.apache.beam.sdk.coders.Coder<V> valueCoder,
                                                       org.apache.beam.sdk.transforms.SerializableBiFunction<V,V,V> combiner,
                                                       org.joda.time.Duration accumulationDelay)

sanitize

public static void sanitize(String name,
                            String value,
                            BiConsumer<String,String> consumer)

sanitizeMetricName

public static String sanitizeMetricName(String metricName)

sanitizeLabelName

public static String sanitizeLabelName(String labelName)